Class: TouchBarScrubber
Process:
This class is not exported from the 'electron'
module. It is only available as a return value of other methods in the Electron API.
options
Objectitems
- An array of items to place in this scrubber.select
Function (optional) - Called when the user taps an item that was not the last tapped item.selectedIndex
Integer - The index of the item the user selected.
highlight
Function (optional) - Called when the user taps any item.highlightedIndex
Integer - The index of the item the user touched.
selectedStyle
string (optional) - Selected item style. Can bebackground
,outline
ornone
. Defaults tonone
.- string (optional) - Selected overlay item style. Can be
background
,outline
ornone
. Defaults tonone
. mode
string (optional) - Can befixed
orfree
. The default isfree
.continuous
boolean (optional) - Defaults totrue
.
Instance Properties
The following properties are available on instances of TouchBarScrubber
:
touchBarScrubber.items
touchBarScrubber.selectedStyle
A string
representing the style that selected items in the scrubber should have. Updating this value immediately updates the control in the touch bar. Possible values:
background
- Maps to .outline
- Maps to[NSScrubberSelectionStyle outlineOverlayStyle]
.none
- Removes all styles.
touchBarScrubber.overlayStyle
A string
representing the style that selected items in the scrubber should have. This style is overlayed on top of the scrubber item instead of being placed behind it. Updating this value immediately updates the control in the touch bar. Possible values:
background
- Maps to[NSScrubberSelectionStyle roundedBackgroundStyle]
.outline
- Maps to[NSScrubberSelectionStyle outlineOverlayStyle]
.none
- Removes all styles.
touchBarScrubber.showArrowButtons
touchBarScrubber.mode
A string
representing the mode of this scrubber. Updating this value immediately updates the control in the touch bar. Possible values:
free
- Maps toNSScrubberModeFree
.
touchBarScrubber.continuous
A representing whether this scrubber is continuous or not. Updating this value immediately updates the control in the touch bar.