Interface IScaffold3Option<T>

Interface representing an option for an IScaffold3 component.

interface IScaffold3Option<T = Payload> {
    icon?: any;
    iconColor?: string;
    id: string;
    isDisabled?: (payload: T) => boolean | Promise<boolean>;
    isVisible?: (payload: T) => boolean | Promise<boolean>;
    label?: string;
    lifted?: boolean;
    options?: IScaffold3Option<T>[];
    pin?: boolean;
    sx?: any;
    tabs?: IScaffold3Tab<T>[];
}

Type Parameters

  • T = Payload

    The type of the payload used by the option.

Properties

icon? iconColor? id isDisabled? isVisible? label? lifted? options? pin? sx? tabs?

Properties

Optionalicon

icon?: any

OptionaliconColor

iconColor?: string

id

id: string

OptionalisDisabled

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

Checks if a payload is disabled.

Type declaration

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

    • Parameters

      • payload: T

        The payload to check.

      Returns boolean | Promise<boolean>

      • True if the payload is disabled, false otherwise.

OptionalisVisible

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

Determines the visibility of a given payload.

Type declaration

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

    • Parameters

      • payload: T

        The payload to check visibility for.

      Returns boolean | Promise<boolean>

      • The visibility status. Returns a boolean if synchronous, otherwise returns a Promise.

Optionallabel

label?: string

Optionallifted

lifted?: boolean

Optionaloptions

options?: IScaffold3Option<T>[]

Represents an array of options for a variable.

Template: T

The type of the options.

Optionalpin

pin?: boolean

Optionalsx

sx?: any

Optionaltabs

tabs?: IScaffold3Tab<T>[]

Represents an array of IScaffold3Tab objects.

Template: T

The type of the IScaffold3Tab object.

Settings

Member Visibility

On This Page

Properties