ComponentsHelp
Help
stableAuto-generated keybinding help panel for terminal UIs.
Browser preview is a simulation. The copied component runs in actual terminal apps.
help.tsx
↑/kmove up
↓/jmove down
←/hmove left
→/lmove right
?toggle help
qquit
help.tsx
Installation
npx orizen-tui@latest add help
if dependency install fails, run: npm install ink@^5.0.1 react@^18.3.1 @types/react@^18.3.18 orizen-tui-core@latest
- Copy and paste the following code into your project.
- Update import paths to match your project setup.
components/ui/orizen/help.tsx
Usage
help.imports.tsx
help.example.tsx
Examples
Usage
help.example1.tsx
↑/kmove up
↓/jmove down
←/hmove left
→/lmove right
?toggle help
qquit
help.example1.tsx
API Reference
Help
PropTypeDefaultDescription
bindingsKeyBinding[]—Array of { key, description } pairs
bindings—
KeyBinding[]Array of { key, description } pairs
direction"row" | "column""row"Layout direction for the binding list
direction"row"
"row" | "column"Layout direction for the binding list