shadcn-labs/termcn / .agents/skills/ink
ink
VerifiedComprehensive Ink skill for building CLI applications with React. Covers components (Text, Box, Static, Transform), hooks (useInput, useApp, useFocus), Flexbox layout, testing, and accessibility.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 10.2 KB |
| references/accessibility/REFERENCE.md | markdown | 5.3 KB |
| references/components/REFERENCE.md | markdown | 1.7 KB |
| references/components/box.md | markdown | 4.9 KB |
| references/components/text.md | markdown | 2.4 KB |
| references/components/utilities.md | markdown | 3.3 KB |
| references/core/REFERENCE.md | markdown | 3.1 KB |
| references/core/api.md | markdown | 3.4 KB |
| references/core/configuration.md | markdown | 3.7 KB |
| references/core/gotchas.md | markdown | 4.6 KB |
| references/core/patterns.md | markdown | 6.7 KB |
| references/hooks/REFERENCE.md | markdown | 1.7 KB |
| references/hooks/app-lifecycle.md | markdown | 1.9 KB |
| references/hooks/focus.md | markdown | 5.2 KB |
| references/hooks/input.md | markdown | 3.7 KB |
| references/hooks/stdio.md | markdown | 3.1 KB |
| references/layout/REFERENCE.md | markdown | 4.1 KB |
| references/layout/patterns.md | markdown | 3.8 KB |
| references/testing/REFERENCE.md | markdown | 5.3 KB |
| rules/RULES.md | markdown | 1.4 KB |
| rules/components.md | markdown | 8.3 KB |
| rules/core.md | markdown | 9.0 KB |
| rules/hooks.md | markdown | 10.1 KB |
| rules/performance.md | markdown | 6.6 KB |
references/components/REFERENCE.md
View on GitHub# Ink Components
Reference for all built-in Ink components.
## Component Overview
| Component | Purpose | File |
|-----------|---------|------|
| `<Text>` | Display and style text | [text.md](./text.md) |
| `<Box>` | Layout container (Flexbox), borders, backgrounds | [box.md](./box.md) |
| `<Newline>` | Insert line breaks | [utilities.md](./utilities.md) |
| `<Spacer>` | Flexible space filler | [utilities.md](./utilities.md) |
| `<Static>` | Permanently rendered output | [utilities.md](./utilities.md) |
| `<Transform>` | Transform string output | [utilities.md](./utilities.md) |
## Component Chooser
```
Need a component?
├─ Styled text (color, bold, italic, etc.) -> text.md
├─ Layout container with flexbox -> box.md
├─ Borders around content -> box.md (borderStyle)
├─ Background color -> box.md (backgroundColor)
├─ Line break in text -> utilities.md (Newline)
├─ Push elements apart -> utilities.md (Spacer)
├─ Log/permanent output -> utilities.md (Static)
└─ Text transform (uppercase, gradient) -> utilities.md (Transform)
```
## Quick Import
```jsx
import {Text, Box, Newline, Spacer, Static, Transform} from 'ink';
```
## Key Rules
1. **All text must be in `<Text>`** — raw strings in `<Box>` throw errors
2. **`<Text>` only contains text and nested `<Text>`** — no `<Box>` inside `<Text>`
3. **`<Box>` is always flexbox** — every `<Box>` is `display: flex`
4. **`<Static>` only renders new items** — previously rendered items don't update
## See Also
- [Layout](../layout/REFERENCE.md) - Flexbox layout system
- [Hooks](../hooks/REFERENCE.md) - All hooks reference
- [Core API](../core/api.md) - render(), renderToString()
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |