Document node 'button' property
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
Research direction
No documentation file or test is named. Locate the existing Node-RED node property documentation and review how similar button options are described. Document toggle, enabled, and onclick, including their constraints and behavior; done means all three properties and the noted incompatibility and callback behavior are covered.
Written by the indexing model from the issue text.
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.
- Dominant language
- JavaScript
- Stars
- 118
- Forks
- 161
- Avg merge
- 8h 18m
- Merged PRs (30d)
- 4
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from node-red/node-red.github.io
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
node-red/node-red.github.io#327 ·
-
docs/getting-started/local.md: npm command line is now deprecated, use --location=global not -g Open
Difficulty 1/5 Under an hour Newbie friendliness 62/100
node-red/node-red.github.io#280 · 1 comment ·
-
node-red/node-red.github.io#416 · 1 reaction · 1 assignee ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 50/100
node-red/node-red.github.io#384 ·
-
node-red/node-red.github.io#382 · 1 comment · 1 assignee ·
All issues in node-red/node-red.github.io
Similar issues
-
bug customer-eng Durable Agents Inngest status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
githubnext/gh-aw-cao#13475 ·
-
[BUG]: "Clear All" in Settings doesn't clear the saved analysis, old data comes back after reload Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
AOSSIE-Org/OrgExplorer#253 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
oxc-project/oxc#26944 ·
-
ai-observability bug team/ai-observability
Difficulty 2/5 1-3 hours Newbie friendliness 78/100