node-red / node-red/node-red.github.io

Document node 'button' property

オープン
#45 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
JavaScript
スター
118
フォーク
161
平均マージ
8時間 18分
マージ済み PR(30日)
4

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

ドキュメントファイルもテストも指定されていません。既存の Node-RED ノードプロパティのドキュメントを見つけ、類似するボタンオプションがどのように説明されているかを確認してください。toggle、enabled、onclick を、それぞれの制約と動作を含めてドキュメント化してください。3 つすべてのプロパティに加え、記載されている非互換性とコールバックの動作がカバーされれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。