AboutSupportDeveloper GuideVersion 41.131.100.50

Interface MenuItemTemplate<Data>

interface MenuItemTemplate<Data> {
    checked?: boolean;
    data?: Data;
    enabled?: boolean;
    icon?: string;
    label?: string;
    role?:
        | "reload"
        | "cut"
        | "copy"
        | "paste"
        | "toggleDevTools";
    submenu?: MenuItemTemplate<Data>[];
    type?:
        | "normal"
        | "separator"
        | "submenu"
        | "checkbox";
    visible?: boolean;
}

Type Parameters

  • Data extends unknown = unknown

    User-defined shape for data returned upon menu item click. Should be a union of all possible data shapes for the entire menu, and the click handler should process these with a "reducer" pattern.

Properties

checked? data? enabled? icon? label? role? submenu? type? visible?

Properties

Optionalchecked

checked?: boolean

Should only be specified for checkbox type menu items.

Optionaldata

data?: Data

Data to be returned if the user selects the element. Must be serializable

Optionalenabled

enabled?: boolean

If false, the menu item will be greyed out and unclickable.

Optionalicon

icon?: string

Image Data URI with image dimensions inferred from the encoded string

Optionallabel

label?: string

The text to show on the menu item. Should be left undefined for type: 'separator'

Optionalrole

role?:
    | "reload"
    | "cut"
    | "copy"
    | "paste"
    | "toggleDevTools"

Optionalsubmenu

submenu?: MenuItemTemplate<Data>[]

Should be specified for submenu type menu items. If submenu is specified, the type: 'submenu' can be omitted.

Optionaltype

type?:
    | "normal"
    | "separator"
    | "submenu"
    | "checkbox"

Can be normal, separator, submenu, or checkbox. Defaults to 'normal' unless a 'submenu' key exists

Optionalvisible

visible?: boolean

If false, the menu item will be entirely hidden.

Settings

On This Page

Properties