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)

figma
Searching Database…

4.1K ·GitHub
What is this?Kumo is Cloudflare's component library for building modern web applications — accessible, design-system-compliant UI components built on Base UI.
Is it a framework, or a library I install into my own app?It's a library, not a framework: you install the @cloudflare/kumo package from npm and import just the UI components you need into your own app.
How do I add it to a project?Install the @cloudflare/kumo npm package and import its components; the package declares peer dependencies, so add those to your project alongside it. Usage docs are at kumo-ui.com.
Where can I see the components live?Live documentation is hosted at kumo-ui.com.
Why is it built on Base UI?Base UI supplies the underlying accessible primitives — keyboard handling, focus management, ARIA — so Kumo layers Cloudflare's design system on top instead of rebuilding that plumbing, and still re-exports the primitives for advanced cases.
How mature is Kumo?It's young — the repository went public at the end of October 2025 — but it already counts around 4,000 GitHub stars with Cloudflare behind it.
Creator
cloudflare
Size
6.3 MB
Stars
4.1K
Age
11mo
Commits · 90 Days