A collection of beautifully designed, accessible, and customizable terminal UI components. Built on Ink. Works with shadcn/ui.

How do I publish components with termcn?

Add or edit components under registry/bases/ink/ or registry/bases/opentui/, register them in registry.json, run pnpm registry:build (which refreshes public/r/), then deploy. Consumers install with npx shadcn@latest add against your published registry URL.

Is termcn open source?

Yes. The source is on GitHub and released under the MIT License.

List

Navigable list with optional filtering

Terminal

list-demo

No opentui live preview is registered for this example yet.

Installation


$ pnpm dlx shadcn@latest add @termcn/list

Usage

import { List } from "@/components/ui/list";

<List
  items={[
    { key: "ts", label: "TypeScript", description: "Typed JavaScript" },
    { key: "rs", label: "Rust", description: "Systems language" },
    { key: "go", label: "Go", description: "Cloud-native language" },
  ]}
  onSelect={(item) => console.log(item.key)}
/>

API Reference

List

Prop	Type	Default
`items`	`ListItem[]`	`required`
`onSelect`	`(item: ListItem) => void`	-
`filterable`	`boolean`	`false`
`height`	`number`	`10`
`cursor`	`string`	`"›"`

ListItem

Prop	Type	Default
`key`	`string`	`required`
`label`	`string`	`required`
`description`	`string`	-
`color`	`string`	-

Key Value Table

On This Page

Installation Usage API Reference List ListItem

Edit this page Follow @shadcnlabs Join community