Defines a standard menu item with label & potentially an icon.

interface Label {
    condition?: boolean | () => boolean;
    icon?: string;
    imageAlt?: string;
    label: string;
    onPress?: (
        data?: {
            event?: PointerEvent | KeyboardEvent;
            focusSource?: A11yFocusSource;
            item?: Label;
        },
    ) => OnPressResult
    | Promise<OnPressResult>;
}
Hierarchy

Properties

condition?: boolean | () => boolean

If a boolean and false or a function that invoked returns a falsy value this item is not added.

icon?: string

A string containing font icon classes or an image / svg URL path to load.

imageAlt?: string

An image 'alt' text description for image icons.

label: string

A text string that is passed through localization.

onPress?: (
    data?: {
        event?: PointerEvent | KeyboardEvent;
        focusSource?: A11yFocusSource;
        item?: Label;
    },
) => OnPressResult
| Promise<OnPressResult>

A callback function to invoke; The data object contains the originating event, menu item data, and an A11yFocusSource object to potentially handle later in a continuation of user interaction.

To defer immediate application of the A11yFocusSource return true indicating a focus continuation.