概要
プラグイン名を一貫して使用すると、プラグインの整理や検索、npm で公開されているプラグインの検索に役立ちます。
このページでは、標準のプラグイン命名規則について説明します。プラグインがどのカテゴリにも当てはまらない場合は、ページの最後にある一般的なプラグイン命名形式を使用します。
npm でプラグインを見つけやすくするために、package.json
に提案されたタグを追加することをおすすめします。
プラグインの種類
フィールド
フィールド プラグインは、1 つのカスタム フィールドを公開します。
フィールド プラグインを読み込むと、ページ上のすべての Blockly ワークスペースで使用できる新しいフィールド タイプが登録されます。
サードパーティ | 例 | タグの候補 | |
---|---|---|---|
@blockly/field-* |
blockly-field-* |
@blockly/field-slider |
blockly-plugin 、field |
テーマ
テーマ プラグインは、単一の Blockly テーマを公開します。
テーマ プラグインを読み込むと、新しいテーマが定義され、ページ上のすべての Blockly ワークスペースで使用できるようになります。
サードパーティ | 例 | タグの候補 | |
---|---|---|---|
@blockly/theme-* |
blockly-theme-* |
@blockly/theme-modern |
blockly-plugin 、theme |
ブロック
ブロック プラグインは、1 つ以上のブロック定義を公開します。
ブロック プラグインを読み込むと、ページ上のすべての Blockly ワークスペースに対してブロックが定義されます。
サードパーティ | 例 | タグの候補 | |
---|---|---|---|
@blockly/block(s)-* |
blockly-block(s)-* |
@blockly/blocks-plus-minus |
blockly-plugin 、block 、blocks |
拡張機能をブロックする
ブロック拡張機能プラグインは、1 つ以上のブロック拡張機能を公開します。これを使用して、ブロック間で動作をプログラムで共有できます。
ブロック拡張機能プラグインを読み込むと、ページ上のすべての Blockly ワークスペースで使用する拡張機能が登録されます。
サードパーティ | 例 | タグの候補 | |
---|---|---|---|
@blockly/extension-* |
blockly-extension-* |
None yet | blockly-plugin 、block-extension |
ワークスペース
ワークスペース プラグインは、単一のワークスペースに動作を追加します。
ワークスペース プラグインを読み込んでも、Blockly ワークスペースで初期化されるまで何も行われません。
サードパーティ | 例 | タグの候補 | |
---|---|---|---|
@blockly/workspace-* |
blockly-workspace-* |
None yet | blockly-plugin 、workspace |
汎用プラグイン
これは最も一般的なプラグイン タイプです。プラグインが他のプラグイン タイプの要件を満たしていない場合は、この命名規則を使用します。
サードパーティ | 例 | タグの候補 | |
---|---|---|---|
@blockly/plugin-* |
blockly-plugin-* |
@blockly/plugin-modal |
blockly-plugin |