Interface IScaffold2Group<T>

Interface representing a group in IScaffold2.

interface IScaffold2Group<T = Payload> {
    children: IScaffold2Option<T>[];
    icon?: any;
    iconColor?: string;
    id: string;
    isDisabled?: () => boolean | Promise<boolean>;
    isVisible?: () => boolean | Promise<boolean>;
    label?: string;
    noHeader?: boolean;
}

Type Parameters

  • T = Payload

    The type of payload for the options in the group.

Properties

children icon? iconColor? id isDisabled? isVisible? label? noHeader?

Properties

children

children: IScaffold2Option<T>[]

The options belonging to the group.

Optionalicon

icon?: any

The icon to be displayed for the group.

OptionaliconColor

iconColor?: string

id

id: string

The unique identifier of the group.

OptionalisDisabled

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

Function or Promise that returns a boolean indicating whether the group is disabled.

OptionalisVisible

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

Function or Promise that returns a boolean indicating whether the group is visible.

Optionallabel

label?: string

The label to be displayed for the group.

OptionalnoHeader

noHeader?: boolean

Flag indicating whether to display the header for the group.

Settings

Member Visibility

On This Page

Properties