Installation
npm install --save @types/basiclightbox
Summary
This package contains type definitions for basiclightbox (https://basiclightbox.electerious.com).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/basiclightbox.
index.d.ts
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 | undefined;
/*
* One or more space separated classes to be added to the basicLightbox element.
*/
className?: string | undefined;
/*
* Function that gets executed before the lightbox will be shown.
* Returning false will prevent the lightbox from showing.
*/
onShow?: ((instance: BasicLightBox) => boolean) | undefined;
/*
* Function that gets executed before the lightbox closes.
* Returning false will prevent the lightbox from closing.
*/
onClose?: ((instance: BasicLightBox) => boolean) | undefined;
}
/**
* 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;
Additional Details
- Last updated: Mon, 06 Nov 2023 22:41:04 GMT
- Dependencies: none
Credits
These definitions were written by Adrian Hope-Bailie.