mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Add initial touch bar docs

Browse source
This commit is contained in:
Kevin Sawicki 2017-03-03 09:54:46 -08:00
parent 81ecd4499c
commit 002369576f
11 changed files with 280 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

28
docs/api/touch-bar-popover.md Normal file
View file

@ -0,0 +1,28 @@
## Class: TouchBarPopover
> Create a popover in the touch bar for native macOS applications
Process: [Main](../tutorial/quick-start.md#main-process)
### `new TouchBarPopover(options)`
* `options` Object
* `label` String (optional) - Popover button text.
* `icon` NativeImage (optional) - Popover button icon.
* `items` TouchBar (optional) - Items to display in the popover.
* `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`
The popover's current button text. Changing this value immediately updates the
popover in the touch bar.
#### `touchBarPopover.icon`
The popover's current button icon. Changing this value immediately updates the
popover in the touch bar.