Interface IOption<Payload>

Represents an option for a specific action or behavior.

interface IOption<Payload = IAnything> {
    action?: string;
    divider?: boolean;
    icon?: any;
    isDisabled?: (payload: Payload) => boolean | Promise<boolean>;
    isVisible?: (payload: Payload) => boolean | Promise<boolean>;
    label?: string;
    primary?: number | boolean;
}

Type Parameters

  • Payload = IAnything

    The payload type for evaluating option visibility and disabled state.

Properties

action? divider? icon? isDisabled? isVisible? label? primary?

Properties

Optionalaction

action?: string

Optionaldivider

divider?: boolean

Optionalicon

icon?: any

OptionalisDisabled

isDisabled?: (payload: Payload) => boolean | Promise<boolean>

Checks if the provided payload indicates that the element is disabled.

Type declaration

    • (payload: Payload): boolean | Promise<boolean>

    • Parameters

      • payload: Payload

        The payload to check.

      Returns boolean | Promise<boolean>

      • A boolean value indicating if the element is disabled.

OptionalisVisible

isVisible?: (payload: Payload) => boolean | Promise<boolean>

Checks the visibility of a given payload.

Type declaration

    • (payload: Payload): boolean | Promise<boolean>

    • Parameters

      • payload: Payload

        The payload to check visibility for.

      Returns boolean | Promise<boolean>

      • A Promise that resolves to a boolean value indicating the visibility status of the payload, or a boolean value directly indicating the visibility status.

Optionallabel

label?: string

Optionalprimary

primary?: number | boolean

Settings

Member Visibility

On This Page

Properties