技能包

Kumo:先查元件文件再接入 Cloudflare UI

適合在既有 React 應用裡用無障礙元件搭介面的人,須先用 pnpm 安裝 @cloudflare/kumo 及其對等依賴,並先用 CLI 唯讀查看元件列表。

官方來源 · kumo

安裝

pnpm add @cloudflare/kumo

適合誰

Kumo 面向要搭建現代 Web 應用介面的人,尤其是已經在用 React、希望少自己處理鍵盤、焦點和 ARIA 細節的前端。它是 Cloudflare 的元件庫,建立在 Base UI 之上,對應頁面是 https://base-ui.com/ 說明寫明它會處理鍵盤導覽、焦點管理和 ARIA 屬性,讓你按設計系統去拼介面。

更貼的用法是:你準備在 React 專案裡引入 @cloudflare/kumo,先確認對等依賴 react、react-dom、@phosphor-icons/react 能裝,再按需引入 Button、Input、Dialog 和樣式。它不適合當編碼助手的斜線技能,也不適合沒有 React 的專案。

倉庫沒有寫其它套件管理器的等價命令,因此主路徑只按它給出的 pnpm 走。若你的倉庫不用 pnpm,現有說明到此為止,不要把這條命令改寫成未記載的安裝器。

3 分鐘完成第一次嘗試

官方安裝命令是:pnpm add @cloudflare/kumo。倉庫位址是 https://github.com/cloudflare/kumo 請只按這一頁操作。對等依賴的官方命令是:pnpm add react react-dom @phosphor-icons/react。若專案裡已經有 React,先核對版本是否仍需要再裝一層,不要盲目重複安裝。

前置條件:本機有 pnpm,並且你有一個可以丟棄或本就使用 React 的本地應用。安裝位置是該應用的依賴,而不是全域技能目錄。

低風險第一次任務:先不要改頁面。在專案目錄執行 npx @cloudflare/kumo ls,只列出全部元件。成功訊號是終端列印出元件名單,而不是你的頁面已經被改掉。若要再看一份說明,用 npx @cloudflare/kumo doc Button 唯讀查看 Button 文件;npx @cloudflare/kumo docs 會取全部文件,第一次可以不做。

確認名單後,如需真正接入,再把這段寫進一個不會上線的試驗頁:從 @cloudflare/kumo 引入 Button、Input、Dialog,並 import "@cloudflare/kumo/styles"。寫入前先看 diff,確認只動了試驗頁和依賴清單。說明沒有寫主題定制或伺服器端渲染步驟,因此第一次停在「能列出元件、試驗頁能渲染一個 Button」即可。

使用案例

案例一:在 React 應用裡引入常用元件。先 pnpm add @cloudflare/kumo,補齊對等依賴,再 import { Button, Input, Dialog } from "@cloudflare/kumo" 並載入 @cloudflare/kumo/styles。適合你已經有頁面骨架、只想換成這套無障礙元件的時候。說明只點名了這三個元件作為示例,其它元件名以 npx @cloudflare/kumo ls 為準,不要猜。

案例二:用 CLI 唯讀查文件。npx @cloudflare/kumo ls 列出全部元件,npx @cloudflare/kumo doc Button 取單個元件文件,npx @cloudflare/kumo docs 取全部文件。適合你還沒決定改哪一頁、先核對 API 的時候。說明沒有寫文件的輸出格式,也沒有寫離線快取;查完即可,不必立刻改程式碼。若命令失敗,回到 https://github.com/cloudflare/kumo 對照,不要改用未記載的安裝方式。

使用邊界

安裝邊界:官方只寫了 pnpm add @cloudflare/kumo 以及對等依賴 react、react-dom、@phosphor-icons/react,沒有記載的安裝器不要使用。執行時邊界:示例是 React 元件與樣式入口,沒有寫無 React 用法。能力邊界:它處理鍵盤導覽、焦點管理和 ARIA,並宣稱符合設計系統;沒有寫視覺主題一定等於 Cloudflare 官網每一頁。CLI 邊界:能核對到的是 ls、doc Button、docs。基礎庫是 Base UI,見 https://base-ui.com/ 但說明沒有把 Kumo 與 Base UI 的全部元件一一對應。