Document node 'button' property

Aberta
#45 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
45/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
javascript
Domínio
documentation

Direção de pesquisa

Nenhum arquivo de documentação ou teste é especificado. Localize a documentação existente das propriedades dos nós do Node-RED e revise como opções semelhantes de botões são descritas. Documente toggle, enabled e onclick, incluindo suas restrições e seu comportamento; o trabalho estará concluído quando as três propriedades, bem como a incompatibilidade indicada e o comportamento do callback, estiverem cobertos.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.
Linguagem predominante
JavaScript
Estrelas
118
Forks
161
Merge médio
8h 18min
PRs com merge (30d)
4

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de node-red/node-red.github.io

Todas as issues de node-red/node-red.github.io

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.