mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
electron/docs/api/touch-bar-button.md
Kevin Sawicki 002369576f Add initial touch bar docs
2017-03-03 14:00:39 -08:00

975 B
Raw Blame History

Class: TouchBarButton

Create a button in the touch bar for native macOS applications

Process: Main

new TouchBarButton(options)

  • options Object
    • label String (optional) - Button text.
    • backgroundColor String (optional) - Button background color in hex format, i.e #ABCDEF.
    • icon NativeImage (optional) - Button icon.
    • click Function (optional) - Function to call when the button is clicked.

Instance Properties

The following properties are available on instances of TouchBarButton:

touchBarButton.label

The button's current text. Changing this value immediately updates the button in the touch bar.

touchBarButton.backgroundColor

The button's current background color. Changing this value immediately updates the button in the touch bar.

touchBarButton.icon

The button's current icon. Changing this value immediately updates the button in the touch bar.