Document node 'button' property

Abierto
#45 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript
Área
documentation

Línea de trabajo

No se indica ningún archivo de documentación ni ninguna prueba. Localiza la documentación existente de las propiedades de los nodos de Node-RED y revisa cómo se describen opciones similares de botones. Documenta toggle, enabled y onclick, incluidas sus restricciones y su comportamiento; el trabajo estará terminado cuando se cubran las tres propiedades, así como la incompatibilidad indicada y el comportamiento del callback.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

button: {
            toggle: "active",
            enabled: function() {
                return !this.changed
            },
            onclick: function() { }
}

Notes:

  1. toggle identifies 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 between true and false.
  2. enabled is a function that can be used to determine if the button is active or not - cannot be used with toggle - new for 0.17.
  3. onclick is a function that is called when the button is clicked. This function is called regardless of what the enabled function may have returned; in other words, even if enabled returned false, 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.
Lenguaje dominante
JavaScript
Estrellas
118
Forks
161
Merge medio
8 h 18 min
PR fusionados (30 d)
4

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de node-red/node-red.github.io

Todos los issues de node-red/node-red.github.io

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.