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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

34 lines
1.3 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
Process: [Main](../glossary.md#main-process)<br />
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._
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.