概览
一致的插件名称有助于整理和搜索插件,以及查找 npm 上已发布的插件。
本页列出了我们的标准插件命名惯例。如果您的插件不属于任何类别,请在页面底部使用通用插件命名格式。
我们建议您在 package.json
中添加建议的标记,以便更轻松地在 npm 上找到您的插件。
插件类型
字段
字段插件发布单个自定义字段。
加载字段插件会注册一个新的字段类型,该类型可在页面上的所有 Blockly 工作区中使用。
详细了解如何第一方 | 第三方 | 示例 | 建议的标签 |
---|---|---|---|
@blockly/field-* |
blockly-field-* |
@blockly/field-slider |
blockly-plugin 、field |
主题
主题插件发布单个 Blockly 主题。
加载主题插件会定义一个新的主题,该主题随后可在页面上的所有 Blockly 工作区中使用。
主题背景。
详细了解第一方 | 第三方 | 示例 | 建议的标签 |
---|---|---|---|
@blockly/theme-* |
blockly-theme-* |
@blockly/theme-modern |
blockly-plugin 、theme |
屏蔽
块插件发布一个或多个块定义。
加载代码块插件会为页面上的所有 Blockly 工作区定义这些代码块。
详细了解如何第一方 | 第三方 | 示例 | 建议的标签 |
---|---|---|---|
@blockly/block(s)-* |
blockly-block(s)-* |
@blockly/blocks-plus-minus |
blockly-plugin 、block 、blocks |
屏蔽扩展程序
块扩展插件发布一个或多个块扩展,这些扩展可用于程序化地在块之间共享行为。
加载 Blockly 扩展程序插件会注册相应扩展程序,以便在网页上的所有 Blockly 工作区中使用。
扩展程序。
详细了解第一方 | 第三方 | 示例 | 建议的标签 |
---|---|---|---|
@blockly/extension-* |
blockly-extension-* |
尚无 | blockly-plugin ,block-extension |
Workspace
工作区插件可将行为添加到单个工作区。
在 Blockly 工作区中完成初始化之前,加载工作区插件不会执行任何操作。
第一方 | 第三方 | 示例 | 建议的标签 |
---|---|---|---|
@blockly/workspace-* |
blockly-workspace-* |
尚无 | blockly-plugin ,workspace |
通用插件
这是最常用的插件类型。如果您的插件不符合任何其他插件类型的要求,请使用此命名惯例。
第一方 | 第三方 | 示例 | 建议的标签 |
---|---|---|---|
@blockly/plugin-* |
blockly-plugin-* |
@blockly/plugin-modal |
blockly-plugin |