ink-cartridge
    Preparing search index...

    Interface AllowModalOptions

    Options for KeyboardEngine.allowModal when allowing keys to pass through the modal barrier within a specific focus target.

    interface AllowModalOptions {
        elementId?: string;
        focusId?: string | FocusRef;
        when?: string | (() => boolean);
    }
    Index
    elementId? focusId? when?
    elementId?: string

    ID of the element the allow rule applies to.

    focusId?: string | FocusRef

    If provided, allows only within the named focus target.

    when?: string | (() => boolean)

    Optional condition callback. When provided, the key is only allowed through when this returns true. When false, the allow rule is ignored and the key is blocked.

    Settings
    Member Visibility

    On This Page
    Properties