Flarum (2.x)
    Preparing search index...

    The ModalManager component manages one or more modal dialogs. Stacking modals is supported. Multiple dialogs can be shown at once; loading a new component into the ModalManager will overwrite the previous one.

    Hierarchy (View Summary)

    Index

    The attributes passed into the component.

    closeWatcher: CloseWatcher | undefined
    closingModalKey: number | undefined
    element: Element

    The root DOM element for the component.

    focusTrap: FocusTrap | undefined
    keyUpListener: ((e: KeyboardEvent) => void) | null = null
    lastCloseWatcherKey: number | undefined
    lastSetFocusTrap: number | undefined
    modalClosing: boolean = false
    state: undefined

    Class component state that is persisted between redraws.

    Updating this will not automatically trigger a redraw, unlike other frameworks.

    This is different to Vnode state, which is always an instance of your class component.

    This is undefined by default.

    • Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

      For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.

      Parameters

      • Optionalselector: string

        a jQuery-compatible selector string

      Returns JQuery

      the jQuery object for the DOM node

    • Animates the current modal out, then closes it.

      closedCallback runs when the hide animation ends, or after its CSS duration if no transition event arrives. If the modal is closed some other way before then, such as by a page change (Page closes any open modal) or by a non-stacked modal replacing it, its dialog is removed, the animation never ends and closedCallback does not run. It is not run in that case because whatever closed the modal may already have moved on: a callback that changes the route, for example, would close the new modal too.

      Parameters

      • closedCallback: () => void = ...

      Returns void