# Password Input

Password input with masked characters and reveal toggle



<ComponentPreview base="ink" name="password-input-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/ink/password-input
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Install the following dependencies:
      </Step>

      ```bash
      npm install ink
      ```

      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource src="registry/bases/ink/ui/types.ts" title="components/ui/types.ts" />

      <ComponentSource src="registry/bases/ink/themes/default.ts" title="lib/terminal-themes/default.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-theme.ts" title="hooks/use-theme.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-unicode.ts" title="hooks/use-unicode.ts" />

      <ComponentSource src="registry/bases/ink/hooks/use-interaction.tsx" title="hooks/use-interaction.tsx" />

      <ComponentSource src="registry/bases/ink/lib/terminal-style.ts" title="lib/terminal-style.ts" />

      <ComponentSource src="registry/bases/ink/lib/terminal-symbols.ts" title="lib/terminal-symbols.ts" />

      <ComponentSource base="ink" name="password-input" title="components/ui/password-input.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { PasswordInput } from "@/components/ui/password-input";
```

```tsx
<PasswordInput
  label="Password"
  placeholder="Enter password"
  showToggle
  onSubmit={(value) => console.log("Password:", value)}
/>
```

API Reference [#api-reference]

PasswordInput [#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 [#notes]

Accessibility [#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.