Add docs for TouchBarScrubbber

This commit is contained in:
Samuel Attard 2017-03-13 11:00:25 +11:00
parent a85ae27d68
commit cfb3798703
No known key found for this signature in database
GPG key ID: E89DDE5742D58C4E
2 changed files with 27 additions and 0 deletions

View file

@ -0,0 +1,4 @@
# ScrubberItem Object
* `label` String - (Optional) The text to appear in this item
* `image` NativeImage - (Optional) The image to appear in this item

View file

@ -0,0 +1,23 @@
## Class: TouchBarScrubber
> Create a scrubber (a scrollablbe selector)
Process: [Main](../tutorial/quick-start.md#main-process)
### `new TouchBarScrubber(options)`
* `options` Object
* `items` [ScrubberItem[]](structures/scrubber-item.md) - An array of items to place in this scruber
* `onSelect` Function - Called when the user taps an item that was not the last tapped item
* `selectedIndex` - The index of the item the user selected
* `onHightlight` Function - Called when the user taps any item
* `highlightedIndex` - The index of the item the user touched
### Instance Properties
The following properties are available on instances of `TouchBarScrubber`:
#### `touchBarSegmentedControl.items`
A `ScrubberItem[]` array representing the items in this scrubber. Updating this value immediately
updates the control in the touch bar. Updating deep properties inside this array **does not update the touch bar**.