Class: TouchBarScrubber
Class: TouchBarScrubber
Create a scrubber (a scrollable selector)
Process: Main
This class is not exported from the 'electron'
module. It is only available as a return value of other methods in the Electron API.
new TouchBarScrubber(options)
Instance Properties
The following properties are available on instances of TouchBarScrubber
:
touchBarScrubber.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.
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[NSScrubberSelectionStyle roundedBackgroundStyle]
.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 overlaid 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
A boolean
representing whether to show the left / right selection arrows in this scrubber. Updating this value
immediately updates the control in the touch bar.
touchBarScrubber.mode
A string
representing the mode of this scrubber. Updating this value immediately
updates the control in the touch bar. Possible values:
fixed
- Maps toNSScrubberModeFixed
.free
- Maps toNSScrubberModeFree
.
touchBarScrubber.continuous
A boolean
representing whether this scrubber is continuous or not. Updating this value immediately
updates the control in the touch bar.