Quy ước đặt tên trình bổ trợ

Tổng quan

Tên nhất quán của trình bổ trợ rất hữu ích cho việc sắp xếp và tìm kiếm trình bổ trợ, cũng như để tìm các trình bổ trợ đã xuất bản trên npm.

Trang này liệt kê các quy ước đặt tên trình bổ trợ tiêu chuẩn của chúng tôi. Nếu trình bổ trợ của bạn không thuộc bất kỳ danh mục nào, hãy sử dụng định dạng đặt tên chung cho trình bổ trợ ở cuối trang.

Bạn nên thêm các thẻ được đề xuất vào package.json để người dùng dễ dàng tìm thấy trình bổ trợ của bạn trên npm.

Các loại trình bổ trợ

Trường

Trình bổ trợ trường xuất bản một trường tuỳ chỉnh duy nhất.

Việc tải một trình bổ trợ trường sẽ đăng ký một loại trường mới có thể dùng trong tất cả các không gian làm việc Blockly trên trang.

Bên thứ nhất Bên thứ Ba Ví dụ: Thẻ đề xuất
@blockly/field-* blockly-field-* @blockly/field-slider blockly-plugin, field

Giao diện

Trình bổ trợ giao diện xuất bản một giao diện Blockly duy nhất.

Việc tải một trình bổ trợ giao diện sẽ xác định một giao diện mới mà sau đó có thể được dùng trong tất cả các không gian làm việc Blockly trên trang.

Bên thứ nhất Bên thứ Ba Ví dụ: Thẻ đề xuất
@blockly/theme-* blockly-theme-* @blockly/theme-modern blockly-plugin, theme

Chặn

Một trình bổ trợ khối sẽ xuất bản một hoặc nhiều định nghĩa khối.

Việc tải một trình bổ trợ khối sẽ xác định các khối đó cho tất cả không gian làm việc Blockly trên trang.

Bên thứ nhất Bên thứ Ba Ví dụ: Thẻ đề xuất
@blockly/block(s)-* blockly-block(s)-* @blockly/blocks-plus-minus blockly-plugin, block, blocks

Chặn tiện ích

Một trình bổ trợ tiện ích chặn sẽ xuất bản một hoặc nhiều tiện ích chặn. Bạn có thể dùng tiện ích này để chia sẻ hành vi giữa các khối theo phương thức lập trình.

Việc tải một trình bổ trợ tiện ích khối sẽ đăng ký các tiện ích để sử dụng trên tất cả các không gian làm việc Blockly trên trang.

Bên thứ nhất Bên thứ Ba Ví dụ: Thẻ đề xuất
@blockly/extension-* blockly-extension-* Chưa có địa điểm nào blockly-plugin,block-extension

Không gian làm việc

Một trình bổ trợ không gian làm việc sẽ thêm hành vi vào một không gian làm việc duy nhất.

Việc tải một trình bổ trợ không gian làm việc sẽ không có tác dụng gì cho đến khi trình bổ trợ đó được khởi tạo trên một không gian làm việc Blockly.

Bên thứ nhất Bên thứ Ba Ví dụ: Thẻ đề xuất
@blockly/workspace-* blockly-workspace-* Chưa có địa điểm nào blockly-plugin,workspace

Trình bổ trợ chung

Đây là loại trình bổ trợ chung nhất. Sử dụng quy ước đặt tên này nếu trình bổ trợ của bạn không đáp ứng yêu cầu của bất kỳ loại trình bổ trợ nào khác.

Bên thứ nhất Bên thứ Ba Ví dụ: Thẻ đề xuất
@blockly/plugin-* blockly-plugin-* @blockly/plugin-modal blockly-plugin