Bouton interrupteur

SynApps

Acteur d’interaction qui permet d’afficher un interrupteur à deux états.

Sommaire

🔧 propriété · ℹ️ information · ⚙️ méthode · ⚡ évènement · 🔒 lecture seule

Propriétés

Actif?

this.properties.enabled · boolean · défaut true · modifie : Style CSS

Dépassement de texte

this.properties.textOverflow · 'nowrap' | 'break' | 'wrap' | 'truncate' · défaut 'nowrap' · modifie : Rendu

Comportement au dépassement de texte.

Mode pour faux

this.properties.modeFalse · 'primary' | 'secondary' | 'success' | 'warning' | 'danger' | 'info' | 'default' | 'dark' | 'link' · défaut 'default' · modifie : Rendu

Mode de bouton pour faux

Mode pour vrai

this.properties.modeTrue · 'primary' | 'secondary' | 'success' | 'warning' | 'danger' | 'info' | 'default' | 'dark' | 'link' · défaut 'primary' · modifie : Rendu

Mode de bouton pour vrai

Ces deux propriétés permettent de définir le mode de couleur de l’interrupteur correspondant à la valeur true et à la valeur false. Ce sont les mêmes mode que pour l’acteur bouton. La propriété Outline permet aussi de gérer les variantes de couleur.

Outline?

this.properties.outline · boolean · défaut false · modifie : Rendu

Indique si le mode d’affichage du bouton doit êre détouré.

Taille

this.properties.size · 'default' | 'large' | 'small' · défaut 'default' · modifie : Rendu

Taille de l’acteur.

La propriété spécifique Taille permet de changer celle de l’acteur.

Cette propriété possède trois options :

  • Par défaut.
  • Grand.
  • Petit.

Seul le choix par défaut vous laisse la possibilité de modifier la taille du texte. Les autres options prennent le pas sur tout autre réglage.

Texte pour faux

this.properties.textFalse · string · défaut 'Off' · modifie : Rendu

Texte pour faux.

Texte pour vrai

this.properties.textTrue · string · défaut 'On' · modifie : Rendu

Texte pour vrai.

Ces deux propriétés permettent de définir les textes qui s’affichent dans l’interrupteur correspondant à la valeur true et à la valeur false.

Valeur

this.properties.value · boolean · défaut false

Valeur courante.

Cette propriété permet de faire basculer l’interrupteur.

Événements

Les évènements communs à tous les acteurs sont décrits avec l’acteur de base.

onSwitched

Se produit lorsque l’interrupteur est commuté.

context : contexte d’évènement

L’évènement onSwitched est déclenché lorsque l’acteur est basculé.

Hérite de

Outre ce qui est décrit ici, l’acteur a tout ce que décrit l’acteur de base : propriétés communes (taille, disposition, aspect, texte, bordures, effets…), évènements communs (cycle de vie, souris, clavier…) et membres accessibles par script.

Il hérite aussi de :

  • InputBase : Base pour les acteurs de saisie.