# Masked Input

Masked input for phone, date, credit card formats



<ComponentPreview base="ink" name="masked-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/masked-input
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

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

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

Usage [#usage]

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

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

API Reference [#api-reference]

MaskedInput [#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`       |