跳到主要內容

元件管理

Blocklet 可由其他 blocklet 組成,這些被稱為元件。這個強大的功能讓您可以透過組合更小、可重複使用的部分來建構複雜的應用程式。Blocklet CLI 提供了一組指令,幫助您管理專案 blocklet.yml 檔案中的這些元件相依性。

本節將說明如何在您的 blocklet 專案中新增、移除元件以及與元件互動。

新增元件

blocklet add 指令會將一個新的 blocklet 作為元件新增至您目前的專案。它會自動更新您 blocklet.yml 檔案的 components 區段,並檢查循環相依性。

Command

bash
blocklet add <name>[@<version>] | <url> [options]

您可以透過指定元件名稱和選用版本,從已設定的 Blocklet Store 新增元件,也可以直接從指向其元資料的 URL 新增。

範例:

  • 從商店新增: Add from store bash blocklet add my-component@1.2.3
  • 從 URL 新增: Add from URL bash blocklet add https://example-store.com/blocklets/z8i.../blocklet.json

此指令會在您的 blocklet.yml 中新增一筆如下的條目:

blocklet.yml

yaml
components:
  - name: my-component
    title: My Component
    mountPoint: /my-component
    source:
      store: 'https://store.blocklet.dev'
      name: my-component
      version: 1.2.3

更多詳細資訊,請參閱 新增元件 文件。

移除元件

blocklet remove 指令會從您的專案中移除一個元件相依性。它會根據名稱在您的 blocklet.yml 中尋找該元件,並刪除其設定條目。

Command

bash
blocklet remove <component-name>

範例:

Remove a component

bash
blocklet remove my-component

這將會從您 blocklet.ymlcomponents 陣列中移除對應的元件物件。

更多詳細資訊,請參閱 移除元件 文件。

元件工作室 CLI

blocklet component 指令是一個便利的包裝器,它會執行 @blocklet/component-studio-cli。這個專門的工具提供了更進階的功能來處理元件。

您傳遞給 blocklet component 的任何參數都會直接轉發給元件工作室 CLI。

Command

bash
blocklet component [args...]

範例:

如果元件工作室 CLI 有一個名為 list 的指令,您可以這樣執行它:

Proxy a command

bash
blocklet component list

這會在幕後執行 npx -y @blocklet/component-studio-cli list

更多詳細資訊,請參閱 元件工作室 CLI 文件。