Class: TouchBarLabel
Class: TouchBarLabel
Create a label in the touch bar for native macOS applications
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 TouchBarLabel(options)
-
options
Object-
label
String (optional) - Text to display. -
accessibilityLabel
String (optional) - A short description of the button for use by screenreaders like VoiceOver. -
textColor
String (optional) - Hex color of text, i.e#ABCDEF
.
-
When defining accessibilityLabel
, ensure you have considered macOS best practices.
Instance Properties
The following properties are available on instances of TouchBarLabel
:
touchBarLabel.label
A String
representing the label's current text. Changing this value immediately updates the label in the touch bar.
touchBarLabel.accessibilityLabel
A String
representing the description of the label to be read by a screen reader.
touchBarLabel.textColor
A String
hex code representing the label's current text color. Changing this value immediately updates the label in the touch bar.
© GitHub Inc.
Licensed under the MIT license.
https://www.electronjs.org/docs/latest/api/touch-bar-label