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

Make escape item a property instead of setter

Browse source
This commit is contained in:
Kevin Sawicki 2017-04-03 09:34:55 -07:00
parent 21c1ddffb3
commit b24b4212c5
3 changed files with 23 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/api/touch-bar.md
View file

@ -14,16 +14,15 @@ Creates a new touch bar with the specified items. Use
**Note:** The TouchBar API is currently experimental and may change or be
removed in future Electron releases.
### Instance Methods
### Instance Properties
The following methods are available on instances of `TouchBar`:
The following properties are available on instances of `TouchBar`:
#### `touchBar.setEscapeItem([touchBarItem])`
#### `touchBar.escapeItem`
* `touchBarItem` (TouchBarButton | TouchBarColorPicker | TouchBarGroup | TouchBarLabel | TouchBarPopover | TouchBarScrubber | TouchBarSegmentedControl | TouchBarSlider | TouchBarSpacer) - (Optional) The touch bar item to replace the escape button with
Replaces the "esc" button on the touchbar with the given TouchBarItem, if `touchBarItem` is not provided or is falsey the button is reset
to the "esc" button automatically.
The `TouchBarItem` that will replace the "esc" button on the touch bar when set.
Setting to `null` restores the default "esc" button. Changing this value
immediately updates the escape item in the touch bar.
## Examples