2017-03-03 17:54:46 +00:00
|
|
|
## Class: TouchBarPopover
|
|
|
|
|
|
|
|
|
|
> Create a popover in the touch bar for native macOS applications
|
|
|
|
|
|
2021-06-15 20:50:31 +00:00
|
|
|
Process: [Main](../glossary.md#main-process)<br />
|
|
|
|
|
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._
|
2017-03-03 17:54:46 +00:00
|
|
|
|
2020-04-02 16:32:18 +00:00
|
|
|
### `new TouchBarPopover(options)`
|
2017-03-03 17:54:46 +00:00
|
|
|
|
|
|
|
|
* `options` Object
|
2021-11-16 04:13:18 +00:00
|
|
|
* `label` string (optional) - Popover button text.
|
2017-03-08 21:04:55 +00:00
|
|
|
* `icon` [NativeImage](native-image.md) (optional) - Popover button icon.
|
2019-08-01 14:59:26 +00:00
|
|
|
* `items` [TouchBar](touch-bar.md) - Items to display in the popover.
|
2021-11-16 04:13:18 +00:00
|
|
|
* `showCloseButton` boolean (optional) - `true` to display a close button
|
2017-03-03 17:54:46 +00:00
|
|
|
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`
|
|
|
|
|
|
2021-11-16 04:13:18 +00:00
|
|
|
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`
|
|
|
|
|
|
2017-03-04 05:14:41 +00:00
|
|
|
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.
|
