Skip to content

docs: sync README with shipped components #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
clawgreen wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: sync README with shipped components #54

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64dcf94
docs: sync README with shipped component inventory
clawgreen Feb 28, 2026
729aabb
Merge branch 'main' into codex/atomic-01-readme-sync
BunsDev Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 28 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ pnpm add @openknots/terminal-ui
```

```tsx
import { Terminal, TerminalCommand } from '@openknots/terminal-ui'
import { Terminal, TerminalCommand, TerminalOutput } from '@openknots/terminal-ui'

export default function App() {
return (
Expand All @@ -48,19 +48,33 @@ export default function App() {

## 📦 Components

### Available Now

- **Terminal** - Main container with window chrome
- **TerminalCommand** - Render a command with prompt
- **TerminalOutput** - Format command output
- **TerminalSpinner** - Loading indicators

### Coming Soon (Good First Issues!)

- **TerminalProgress** - Progress bars → [Issue #2](../../issues/2)
- **TerminalTable** - Render tables → [Issue #4](../../issues/4)
- **TerminalTree** - File tree views → [Issue #9](../../issues/9)
- **TerminalPrompt** - Interactive input → [Issue #12](../../issues/12)
### Core Terminal

- **Terminal** - Main container with window chrome and copy action
- **TerminalCommand** - Render command lines with prompt context
- **TerminalOutput** - Semantic output (success/error/info/warning) with optional typing and syntax highlighting
- **TerminalSpinner** - Animated loading indicator

### Feed and Data Visualization

- **TerminalLog** - Scrolling log buffer with optional auto-scroll
- **TerminalDiff** - Unified and split terminal-style diffs
- **TerminalTable** - ASCII table rendering with alignment and striping
- **TerminalBarChart** / **TerminalSparkline** - ASCII chart primitives
- **TerminalProgress** - Progress bars with variants and ARIA support
- **TerminalBadge** - Compact status badges
- **TerminalAlert** - Dismissible terminal alert blocks
- **TerminalTree** - Expandable tree with keyboard navigation and render props

### Interactive Controls and Layout

- **TerminalPrompt** - Command input with history navigation
- **TerminalSelect** - Keyboard-driven option picker
- **TerminalTabs** - Terminal tab bar component
- **TerminalSplit** - Resizable two-pane split layout
- **TerminalAutocomplete** - Suggestion list + `useAutocomplete` helper and suggestion presets
- **ThemeSwitcher** - Theme chooser for shipped themes
- **TerminalGhosttyTheme** / **GhosttyThemePicker** - Ghostty theme utilities

## 📊 Component Status Matrix

Expand Down