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

1.7 KiB
Raw Blame History

Class: TouchBarButton

Create a button in the touch bar for native macOS applications

Process: Main

new TouchBarButton(options) Experimental

  • options Object
    • label String (optional) - Button text.
    • accessibilityLabel String (optional) - A short description of the button for use by screenreaders like VoiceOver.
    • backgroundColor String (optional) - Button background color in hex format, i.e #ABCDEF.
    • icon NativeImage | String (optional) - Button icon.
    • iconPosition String (optional) - Can be left, right or overlay. Defaults to overlay.
    • click Function (optional) - Function to call when the button is clicked.

When defining accessibilityLabel, ensure you have considered macOS best practices.

Instance Properties

The following properties are available on instances of TouchBarButton:

touchBarButton.accessibilityLabel

A String representing the description of the button to be read by a screen reader. Will only be read by screen readers if no label is set.

touchBarButton.label

A String representing the button's current text. Changing this value immediately updates the button in the touch bar.

touchBarButton.backgroundColor

A String hex code representing the button's current background color. Changing this value immediately updates the button in the touch bar.

touchBarButton.icon

A NativeImage representing the button's current icon. Changing this value immediately updates the button in the touch bar.