AboutSupportDeveloper GuideVersion 38.126.83.84

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

Optional checked

checked?: boolean

Should only be specified for checkbox type menu items.

Optional data

data?: Data

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

Optional enabled

enabled?: boolean

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

Optional icon

icon?: string

Image Data URI with image dimensions inferred from the encoded string

Optional label

label?: string

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

Optional role

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

Optional submenu

submenu?: MenuItemTemplate<Data>[]

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

Optional type

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

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

Optional visible

visible?: boolean

If false, the menu item will be entirely hidden.

Settings

Theme

On This Page

checkeddataenablediconlabelrolesubmenutypevisible