node-red / node-red/node-red.github.io
Document node 'button' property
Ouverte
Personne n'a encore pris cette issue.
- Langage dominant
- JavaScript
- Étoiles
- 118
- Forks
- 161
- Merge moyen
- 8 h 18 min
- PR mergées (30 j)
- 4
Description
button: {
toggle: "active",
enabled: function() {
return !this.changed
},
onclick: function() { }
}
Notes:
toggleidentifies this should be a toggle switch (as used by Debug node). Value is a string that identifies the node property whose value should be toggled betweentrueandfalse.enabledis a function that can be used to determine if the button is active or not - cannot be used withtoggle- new for 0.17.onclickis a function that is called when the button is clicked. This function is called regardless of what theenabledfunction may have returned; in other words, even ifenabledreturnedfalse, this function will still be called when the button is clicked. This allows the node to display a custom notification to tell the user why the button is not enabled.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Aucun fichier de documentation ni test n’est nommé. Repérez la documentation existante des propriétés des nœuds Node-RED et examinez la manière dont sont décrites les options de bouton similaires. Documentez toggle, enabled et onclick, y compris leurs contraintes et leur comportement ; le travail est terminé lorsque les trois propriétés, ainsi que l’incompatibilité indiquée et le comportement du callback, sont couverts.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100