Utility
Terminal
Installation
$ pnpm dlx shadcn@latest add @termcn/ink/password-input
Usage
import { PasswordInput } from "@/components/ui/password-input";<PasswordInput
label="Password"
placeholder="Enter password"
showToggle
onSubmit={(value) => console.log("Password:", value)}
/>API Reference
PasswordInput
| Prop | Type | Default |
|---|---|---|
value | string | - |
onChange | (value: string) => void | - |
onSubmit | (value: string) => void | - |
placeholder | string | "" |
mask | string | "●" |
showToggle | boolean | false |
label | string | - |
id | string | - |
borderStyle | "single" | "double" | "round" | "bold" | "singleDouble" | "doubleSingle" | "classic" | "round" |
paddingX | number | 1 |
width | number | - |
cursor | 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:
Left/Rightmove by grapheme,Home/Endmove to the boundaries, andBackspace/Deleteremove one complete grapheme.Entersubmits or confirms (Ctrl+Enterin TextArea);Tab/Shift+Tableave 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.