Function overlayPage

  • overlayPage(editor, contentElement, callback?): {
        close: (() => void);
        setIgnoreFocusOut: ((ignore) => void);
    }

  • Generates an overlay for displaying menus. The overlay is an absolutely positioned div.

    Parameters

    • editor: any
    • contentElement: HTMLElement

      Any element which may be presented inside a div.

    • Optional callback: any

    Returns {
        close: (() => void);
        setIgnoreFocusOut: ((ignore) => void);
    }

    • close: (() => void)
        • (): void

        • Returns void

    • setIgnoreFocusOut: ((ignore) => void)
        • (ignore): void

        • Defines whether overlay is closed when user clicks outside of it.

          Parameters

          • ignore: boolean

            If set to true overlay stays open when focus moves to another part of the editor.

          Returns void

    Author

    Matthew Christopher Kastor-Inare III
    ☭ Hial Atropa!! ☭

Settings

Member Visibility

Theme

Generated using TypeDoc