Skip to main content

Classe : TouchBarButton

Classe : TouchBarButton

Créer un bouton dans la touch bar pour les applications native macOS

Process: Main
This class is not exported from the 'electron' module. It is only available as a return value of other methods in the Electron API.

new TouchBarButton(options)

  • Objet options
    • label String (facultatif) - Texte du bouton.
    • accessibilityLabel String (optional) - A short description of the button for use by screenreaders like VoiceOver.
    • backgroundColor String (facultatif) - Couleur de fond hexadécimal du bouton, c.-à-d. #ABCDEF.
    • icon NativeImage | String(facultatif) - Icône du bouton.
    • iconPosition String (facultatif) -Peut être left, right ou overlay. Par défaut, overlay.
    • click Function (facultatif) - Fonction à appeler lorsque le bouton est cliqué.
    • enabled Boolean (optional) - Whether the button is in an enabled state. La valeur par défaut est vraie.

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

Propriétés d'instance

Les propriétés suivantes sont disponibles pour les instances de 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.

touchBarButton.iconPosition

A String - Can be left, right or overlay. Par défaut, overlay.

touchBarButton.enabled

A Boolean representing whether the button is in an enabled state.