@eli/micromodal/dist/index.d.ts

Tiny javascript library for creating accessible modal dialogs

/** Types for Micromodal */
declare module '@eli/Micromodal' {
  // Type definitions for micromodal 0.3
  // Project: https://github.com/ghosh/micromodal#readme
  // Definitions by: Wayne Carson <https://github.com/wcarson>
  // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

  /**
   * MicroModal configuration options
   */
  export interface MicroModalConfig {
    /** This is fired when the modal is opening. */
    onShow?: (modal?: HTMLElement) => void;

    /** This is fired when the modal is closing. */
    onClose?: (modal?: HTMLElement) => void;

    /** Custom data attribute to open modal. Default is data-micromodal-trigger. */
    openTrigger?: string;

    /** Custom data attribute to close modal. Default is data-micromodal-close. */
    closeTrigger?: string;

    /** This disables scrolling on the page while the modal is open. The default value is false. */
    disableScroll?: boolean;

    /** Disable auto focus on first focusable element. Default is false */
    disableFocus?: boolean;

    /**
     * Set this to true if using css animations to hide the modal. This allows it to wait for the animation to
     * finish before removing it from the DOM. Default is false
     */
    awaitCloseAnimation?: boolean;

    /** This option suppresses the console warnings if passed as true. The default value is false. */
    debugMode?: boolean;
  }

  /**
  * MicroModal controller
  */
  declare namespace MicroModal {
    /**
     * Binds click handlers to all modal triggers
     * @param config configuration options
     */
    function init(config?: MicroModalConfig): void;

    /**
     * Shows a particular modal
     * @param targetModal The id of the modal to display
     * @param config configuration options
     */
    function show(targetModal: string, config?: MicroModalConfig): void;

    /**
     * Closes the active modal
     */
    function close(targetModal?: string): void;
  }

  export default MicroModal;
}