Document node 'button' property

Offen

#45 erstellt am 23.4.2017 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 2/5
Geschätzter Aufwand: 1-3 Stunden
Anfängerfreundlichkeit: 45/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: javascript
Bereich: documentation

Rechercherichtung

Es wird keine Dokumentationsdatei und kein Test genannt. Finde die vorhandene Dokumentation der Node-RED-Node-Eigenschaften und prüfe, wie ähnliche Button-Optionen beschrieben werden. Dokumentiere toggle, enabled und onclick einschließlich ihrer Einschränkungen und ihres Verhaltens; fertig ist die Aufgabe, wenn alle drei Eigenschaften sowie die genannte Inkompatibilität und das Callback-Verhalten abgedeckt sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Notes:

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.
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.
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.

Vorherrschende Sprache: JavaScript
Sterne: 118
Forks: 161
Ø Merge: 8 Std. 18 Min.
Gemergte PRs (30 T.): 4

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus node-red/node-red.github.io

Update context.md to indicate Flow visibility within subflows Offen

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 68/100

node-red/node-red.github.io#327 · Erstellt am 24.10.2023
docs/getting-started/local.md: npm command line is now deprecated, use --location=global not -g Offen

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 62/100

node-red/node-red.github.io#280 · 1 Kommentar · Erstellt am 17.7.2022
Website updates for Node-RED 5.0 Offen

node-red/node-red.github.io#416 · 1 Reaktion · 1 zugewiesene Person · Erstellt am 22.5.2026
[user-guide] Inject node description improvement and related links Offen

Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 50/100

node-red/node-red.github.io#384 · Erstellt am 25.7.2025
Update TypedInput docs for node type filter Offen

node-red/node-red.github.io#382 · 1 Kommentar · 1 zugewiesene Person · Erstellt am 06.6.2025

Alle Issues in node-red/node-red.github.io