Add initial touch bar docs
This commit is contained in:
parent
81ecd4499c
commit
002369576f
11 changed files with 280 additions and 35 deletions
28
docs/api/touch-bar-popover.md
Normal file
28
docs/api/touch-bar-popover.md
Normal 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.
|
Loading…
Add table
Add a link
Reference in a new issue