Xivgear Types Documentation
    Preparing search index...

    Class ModalControl

    Controls general modal state. This is NOT tightly integrated with BaseModal because some modals do not use BaseModal, such as the materia pickers. More specifically, this class does not handle any of the actual rendering of a modal. Modals are expected to attack themselves to the DOM in a reasonable way, and to provide a method to force-close them.

    This treats modals as a stack. You can do five main operations:

    1. Set a modal, replacing the entire stack, closing any existing modals.
    2. Set nothing, clearing the stack, closing any existing modals.
    3. Push a modal onto the stack, leaving existing modals open.
    4. Pop a modal off the stack, closing it.
    5. Remove a specific modal off the stack, closing it (even if it is not the topmost modal).
    Index

    Constructors

    constructor

    Accessors

    topmostModal

    Methods

    close closeAll popModal pushModal setModal

    Constructors

    Accessors

    Methods

    • Pop the topmost modal off the stack and close it. If there are no modals, this does nothing.

      Returns Modal | undefined

      The modal that was popped off the stack, or undefined if there were no modals.

    • Set the current modal. Always closes any current modals. In other words, the modal stack is replaced with this modal, or cleared if the argument is undefined.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods