22fb4f85e5
* docs: document what experimental means explicitly * Apply suggestions from code review Co-Authored-By: Jeremy Apthorp <jeremya@chromium.org> * Update experimental.md Co-authored-by: Jeremy Apthorp <jeremya@chromium.org>
32 lines
1.2 KiB
Markdown
32 lines
1.2 KiB
Markdown
## Class: TouchBarLabel
|
|
|
|
> Create a label in the touch bar for native macOS applications
|
|
|
|
Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
|
|
|
|
### `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](https://developer.apple.com/documentation/appkit/nsaccessibilitybutton/1524910-accessibilitylabel?language=objc).
|
|
|
|
### 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.
|