Utility
Terminal
Installation
$ pnpm dlx shadcn@latest add @termcn/ink/tree
Usage
import { Tree } from "@/components/ui/tree";<Tree
defaultExpanded={["src"]}
nodes={[
{
key: "src",
label: "src",
children: [
{ key: "index", label: "index.ts" },
{ key: "utils", label: "utils.ts" },
],
},
{ key: "pkg", label: "package.json" },
]}
/>API Reference
Tree
| Prop | Type | Default |
|---|---|---|
nodes | TreeNode[] | required |
onSelect | (node: TreeNode) => void | - |
defaultExpanded | string[] | [] |
expandedIcon | string | "▼" |
collapsedIcon | string | "▶" |
leafIcon | string | "•" |
TreeNode
| Prop | Type | Default |
|---|---|---|
key | string | required |
label | string | required |
children | TreeNode[] | - |
icon | 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.