A collection of beautifully designed, accessible, and customizable terminal UI components. Built on Ink and OpenTUI. Works with shadcn/ui.

How do I publish components with termcn?

Add or edit components under registry/bases/ink/ or registry/bases/opentui/, register them in registry.json, run pnpm registry:build (which refreshes public/r/), then deploy. Consumers install with npx shadcn@latest add against your published registry URL.

Is termcn open source?

Yes. The source is on GitHub and released under the MIT License.

Timer

Countdown timer with pause/resume and auto-start

Ink OpenTUI

Terminal

Installation


$ pnpm dlx shadcn@latest add @termcn/ink/timer

Usage

import { Timer } from "@/components/ui/timer";

<Timer duration={300} format="ms" label="Pomodoro" autoStart />

API Reference

Timer

Prop	Type	Default
`duration`	`number`	`required`
`onComplete`	`() => void`	-
`autoStart`	`boolean`	`false`
`format`	`"hms" \| "ms" \| "s"`	`"hms"`
`color`	`string`	-
`label`	`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: Enter / Space activate the focused action when enabled; Escape dismisses or cancels when supported; Tab / Shift+Tab move through Ink focus targets.
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.

Stopwatch Toggle

On This Page

Installation Usage API Reference Timer Notes Accessibility

Edit this page Follow @shadcnlabs Join community