mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1
electron/docs/api/touch-bar-label.md
Shelley Vohr c16a186de0 feat: improve TouchBarButton accessibility (#20454)
2019-10-08 11:13:57 -04:00

1.2 KiB
Raw Blame History

Class: TouchBarLabel

Create a label in the touch bar for native macOS applications

Process: Main

new TouchBarLabel(options) Experimental

  • 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.