electron/docs/api/touch-bar-popover.md

29 lines
1,009 B
Markdown
Raw Normal View History

2017-03-03 17:54:46 +00:00
## Class: TouchBarPopover
> Create a popover in the touch bar for native macOS applications
Process: [Main](../tutorial/quick-start.md#main-process)
### `new TouchBarPopover(options)` _Experimental_
2017-03-03 17:54:46 +00:00
* `options` Object
* `label` String (optional) - Popover button text.
2017-03-08 21:04:55 +00:00
* `icon` [NativeImage](native-image.md) (optional) - Popover button icon.
* `items` [TouchBar](touch-bar.md) (optional) - Items to display in the popover.
2017-03-03 17:54:46 +00:00
* `showCloseButton` Boolean (optional) - `true` to display a close button
on the left of the popover, `false` to not show it. Default is `true`.
### Instance Properties
The following properties are available on instances of `TouchBarPopover`:
#### `touchBarPopover.label`
A `String` representing the popover's current button text. Changing this value immediately updates the
2017-03-03 17:54:46 +00:00
popover in the touch bar.
#### `touchBarPopover.icon`
A `NativeImage` representing the popover's current button icon. Changing this value immediately updates the
2017-03-03 17:54:46 +00:00
popover in the touch bar.