Utility
Terminal
Installation
$ pnpm dlx shadcn@latest add @termcn/ink/help
Usage
import { Help } from "@/components/ui/help";<Help
title="Keyboard Shortcuts"
keymap={{
q: "Quit",
h: "Help",
j: "Move down",
k: "Move up",
}}
/>API Reference
Help
| Prop | Type | Default |
|---|---|---|
keymap | Record<string, string> | required |
title | string | - |
compact | boolean | false |
Notes
Accessibility
termcn exposes the following behavior through Ink's terminal accessibility APIs. This is not a browser ARIA or general WCAG-conformance claim.
- Screen reader: Ink labels and semantic state expose the component without relying on visual styling alone.