pCon.basket - Plugin Development
    Preparing search index...

    Interface ItemSelector

    OverlayPluginComponent is used for ui overays such as dialogs. The isActive state of the component is used to control the visibility of the overlay.

    interface ItemSelector {
        isActive?: boolean;
        onDismiss: (() => void) | undefined;
        dispose(): Promise<void>;
        setActive?(pActive: boolean): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    isActive?: boolean

    Optional activity state of this component. Initial component state should be inactive (false or undefined).

    onDismiss: (() => void) | undefined

    Optional callback which has to be called if the overlay gets dismissed (e.g. the dialog was closed).

    • Called if this instance is no longer in use. Should be used to clean-up resources.

      Returns Promise<void>

    • Optional activity state handling for this component. E.g. can be used to disable/enable event handling. Will be set from the component host to activate or deactivate the component. Initial component state should be inactive (false or undefined).

      Parameters

      • pActive: boolean

      Returns Promise<void>