Interface IMenuOption<T>

Represents a menu option.

interface IMenuOption<T extends any = any> {
    bold?: boolean;
    disabled?: boolean;
    getRoles?: (payload: T) => string[] | (payload: T) => Promise<string[]>;
    icon?: any;
    isBold?: (payload: T) => boolean | (payload: T) => Promise<boolean>;
    isDisabled?: (payload: T) => boolean | (payload: T) => Promise<boolean>;
    isVisible?: (payload: T) => boolean | (payload: T) => Promise<boolean>;
    label: string;
    lifted?: boolean;
    name?: string;
    roles?: string[];
    visible?: boolean;
}

Type Parameters

  • T extends any = any

    The type of the payload for dynamic properties.

Hierarchy (View Summary)

Properties

bold? disabled? getRoles? icon? isBold? isDisabled? isVisible? label lifted? name? roles? visible?

Properties

Optionalbold

bold?: boolean

Optionaldisabled

disabled?: boolean

OptionalgetRoles

getRoles?: (payload: T) => string[] | (payload: T) => Promise<string[]>

Optionalicon

icon?: any

Represents a variable called 'icon' which is a React component type that can accept any props.

OptionalisBold

isBold?: (payload: T) => boolean | (payload: T) => Promise<boolean>

Determines whether the payload is in bold format.

Typeparam

T - The type of the payload.

Param: payload

The payload to check.

Returns

  • Returns true if the payload is in bold format, otherwise returns false or a promise that resolves to true or false.

OptionalisDisabled

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

Determines if the payload is disabled.

Param: payload

The payload to check for disablement.

Returns

  • Returns true if the payload is disabled, otherwise false.

Param: payload

The payload to check for disablement.

Returns

  • Returns true if the payload is disabled, otherwise false.

Param: payload

The payload to check for disablement.

Returns

  • Returns a promise that resolves to true if the payload is disabled, otherwise false.

OptionalisVisible

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

Determines the visibility of a payload based on specified conditions.

Param: isVisible

A function that takes a payload as a parameter and returns a boolean value or a Promise that resolves to a boolean value indicating visibility.

Returns

  • If the isVisible function returns a boolean value, this function will return the evaluated value. If the isVisible function returns a Promise , this function will return a Promise that resolves to a boolean value.

label

label: string

Optionallifted

lifted?: boolean

Optionalname

name?: string

Optionalroles

roles?: string[]

Optionalvisible

visible?: boolean

Settings

Member Visibility

On This Page

Properties