electron/docs/api/touch-bar-label.md

33 lines
1.2 KiB
Markdown
Raw Normal View History

2017-03-03 17:54:46 +00:00
## Class: TouchBarLabel
> Create a label in the touch bar for native macOS applications
2018-04-09 20:58:10 +00:00
Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
2017-03-03 17:54:46 +00:00
### `new TouchBarLabel(options)`
2017-03-03 17:54:46 +00:00
* `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`.
2017-03-03 17:54:46 +00:00
When defining `accessibilityLabel`, ensure you have considered macOS [best practices](https://developer.apple.com/documentation/appkit/nsaccessibilitybutton/1524910-accessibilitylabel?language=objc).
2017-03-03 17:54:46 +00:00
### 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
2017-03-03 17:54:46 +00:00
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.