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.

Masked Input

Masked input for phone, date, credit card formats

Ink OpenTUI

Terminal

Installation


$ pnpm dlx shadcn@latest add @termcn/ink/masked-input

Usage

import { MaskedInput } from "@/components/ui/masked-input";

<MaskedInput
  mask="(###) ###-####"
  label="Phone Number"
  placeholder="(555) 123-4567"
/>

API Reference

MaskedInput

Prop	Type	Default
`mask`	`string`	`required`
`value`	`string`	-
`onChange`	`(value: string) => void`	-
`onSubmit`	`(value: string) => void`	-
`label`	`string`	-
`placeholder`	`string`	-
`autoFocus`	`boolean`	`false`
`id`	`string`	-
`width`	`number`	`40`

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: Left / Right move by grapheme, Home / End move to the boundaries, and Backspace / Delete remove one complete grapheme. Enter submits or confirms (Ctrl+Enter in TextArea); Tab / Shift+Tab leave through Ink focus traversal.
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.

Email Input Number Input

On This Page

Installation Usage API Reference MaskedInput Notes Accessibility

Edit this page Follow @shadcnlabs Join community