Utility
Terminal
Installation
$ pnpm dlx shadcn@latest add @termcn/ink/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 | - |
Notes
Accessibility
termcn exposes the following behavior through Ink's terminal accessibility APIs. This is not a browser ARIA or general WCAG-conformance claim.
- Keyboard: Arrow keys move the current item or viewport;
Home/Endmove to the boundaries;PageUp/PageDownmove by a page;Enter/Spaceselect or expand when supported;Tab/Shift+Tableave the composite. - Focus and composition: Input is active only while the component's focus target is focused, enabled, active, and inside the topmost focus scope.
- Screen reader: Ink labels and semantic state expose the component without relying on visual styling alone.