CheckboxMenuItem

A checkbox menu item that can be checked or unchecked, and perform an action when clicked.

import { CheckboxMenuItem } from '@mobrowser/api';

Example

import { app, Menu, CheckboxMenuItem } from '@mobrowser/api';

const menu = new Menu({
  items: [
    new CheckboxMenuItem({
      id: 'dark-mode',
      label: 'Dark Mode',
      checked: true,
      action: (item: CheckboxMenuItem) => { }
    })
  ]
})
app.setMenu(menu)

Properties

checked

readonly checked?: boolean;

Whether the checkbox menu item is checked.

Methods

constructor()

constructor(options: CheckboxMenuItemOptions): void;

Creates a new checkbox menu item.

Parameter	Type	Description
`options`	`CheckboxMenuItemOptions`	The options for constructing the checkbox menu item.

setChecked()

setChecked(checked: boolean): void;

Sets whether the checkbox menu item is checked.

Parameter	Type	Description
`checked`	`boolean`	Whether the checkbox menu item is checked.