kumo README

The project's README from github.com/cloudflare/kumo. As one markdown file: README.md.

Kumo

Cloudflare's component library for building modern web applications.

Kumo provides accessible, design-system-compliant UI components built on Base UI. It handles keyboard navigation, focus management, and ARIA attributes so you can build accessible applications without thinking through every detail.

image

Installation

pnpm add @cloudflare/kumo

Peer Dependencies

pnpm add react react-dom @phosphor-icons/react

Usage

import { Button, Input, Dialog } from "@cloudflare/kumo";
import "@cloudflare/kumo/styles";

Granular Imports (Tree-Shaking)

import { Button } from "@cloudflare/kumo/components/button";

Base UI Primitives

Kumo re-exports all Base UI primitives for advanced use cases:

import { Popover } from "@cloudflare/kumo/primitives/popover";

CLI

Query component documentation from the command line:

npx @cloudflare/kumo ls          # List all components
npx @cloudflare/kumo doc Button  # Get component docs
npx @cloudflare/kumo docs        # Get all docs

Development

See AGENTS.md for comprehensive development documentation including:

Quick Start

pnpm install
pnpm dev                    # Start docs site at localhost:4321
pnpm --filter @cloudflare/kumo test

Figma Plugin

# Optional: enable token sync during build
# cp packages/kumo-figma/scripts/.env.example packages/kumo-figma/scripts/.env
# $EDITOR packages/kumo-figma/scripts/.env  # set FIGMA_TOKEN (and optionally FIGMA_FILE_KEY)

pnpm --filter @cloudflare/kumo-figma build
# In Figma: Plugins > Development > Import plugin from manifest...
# Select: packages/kumo-figma/src/manifest.json

Creating Components

pnpm --filter @cloudflare/kumo new-component

Documentation

License

MIT

kumo (cloudflare/kumo)

Searching Database…

4.1K ·GitHub
这是什么?Kumo 是 Cloudflare 的组件库,用于构建现代 Web 应用——它提供无障碍、符合设计系统的 UI 组件,底层基于 Base UI。
它是一个框架,还是一个安装到自己应用里的库?它是一个库,不是框架:你从 npm 安装 @cloudflare/kumo 这个包,然后只把自己需要的 UI 组件导入到自己的应用里。
怎么把它加到项目里?先安装 @cloudflare/kumo 这个 npm 包,再导入它的组件即可。该包声明了对等依赖(peer dependencies),所以需要把这些依赖和它一起加到你的项目里。使用文档见 kumo-ui.com。
在哪里可以在线查看这些组件?在线文档托管在 kumo-ui.com。
它为什么基于 Base UI 构建?Base UI 提供了底层的无障碍基础组件——键盘处理、焦点管理、ARIA 等——因此 Kumo 只需在之上叠加 Cloudflare 的设计系统,而不用重写这些底层逻辑,同时仍会重新导出这些基础组件,方便进阶使用。
Kumo 有多成熟?它还很年轻——仓库在 2025 年 10 月底才公开——但在 Cloudflare 的支持下,它在 GitHub 上已经获得了大约 4,000 颗星。
Creator
cloudflare
Size
6.3 MB
Stars
4.1K
Age
11mo
Commits · 90 Days