Add types for basicLightbox (#35935)

* Add types for basicLightbox

* Fix header

* Add strictFunctionTypes

* Fix linting errors

* Fix return type of instance.visible()

types/basiclightbox/basiclightbox-tests.ts

@@ -0,0 +1,27 @@
+import * as basicLightbox from 'basiclightbox';
+
+const instance = basicLightbox.create(`
+	<h1>Dynamic Content</h1>
+	<p>You can set the content of the lightbox with JS.</p>
+`);
+
+const instance2 = basicLightbox.create(`
+	<h1>Not closable</h1>
+	<p>It's not possible to close this lightbox with a click.</p>
+`, {
+	closable: false
+});
+
+const instance3 = basicLightbox.create(
+	document.querySelector('#template')!
+);
+
+const visible = basicLightbox.visible();
+
+instance.show(() => console.log('lightbox now visible'));
+
+instance.close(() => console.log('lightbox not visible anymore'));
+
+const visible2 = instance.visible();
+
+const elem = instance.element();

types/basiclightbox/index.d.ts

@@ -0,0 +1,64 @@
+// Type definitions for basiclightbox 5.0
+// Project: https://basiclightbox.electerious.com
+// Definitions by: Adrian Hope-Bailie <https://github.com/adrianhopebailie>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+export interface BasicLightBox {
+    /**
+     * Shows a lightbox instance.
+     *
+     * @param cb A function that gets executed as soon as the lightbox starts to fade in.
+     */
+    show: (cb?: () => void) => void;
+
+    /**
+     * Closes a lightbox instance.
+     *
+     * @param cb A function that gets executed as soon as the lightbox has been faded out.
+     */
+    close: (cb?: () => void) => void;
+
+    /**
+     * Returns true when the lightbox instance is visible. Also returns true when the lightbox is currently in the process of showing/hiding and not fully visible/hidden, yet.
+     */
+    visible: () => boolean;
+
+    /**
+     * Returns the DOM element/node associated with the instance.
+     */
+    element: () => Element;
+  }
+
+  export interface BasicLightBoxOptions {
+    /*
+     * Prevents the lightbox from closing when clicking its background.
+     */
+    closable?: boolean;
+    /*
+     * One or more space separated classes to be added to the basicLightbox element.
+     */
+    className?: string;
+    /*
+     * Function that gets executed before the lightbox will be shown.
+     * Returning false will prevent the lightbox from showing.
+     */
+    onShow?: (instance: BasicLightBox) => boolean;
+    /*
+     * Function that gets executed before the lightbox closes.
+     * Returning false will prevent the lightbox from closing.
+     */
+    onClose?: (instance: BasicLightBox) => boolean;
+  }
+
+  /**
+   * Creates a new BasicLightbox instance.
+   *
+   * @param content Content of the lightbox.
+   * @param options An object of options.
+   */
+  export function create(content: string | Element, options?: BasicLightBoxOptions): BasicLightBox;
+
+  /**
+   * Returns `true` when a lightbox is visible. Also returns true when a lightbox is currently in the process of showing/hiding and not fully visible/hidden, yet.
+   */
+  export function visible(): boolean;

types/basiclightbox/tsconfig.json

@@ -0,0 +1,24 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "dom",
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "basiclightbox-tests.ts"
+    ]
+}

types/basiclightbox/tslint.json

@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }