inputcnv1.0
Star
HomeDocsComponentsBlocksForm contractValidation
Components / MaskedInput

MaskedInput

The generic mask, and the reason the rest of the library exists. The caret is tracked as a count of significant characters to its left rather than as a string offset, so inserting a digit in the middle does not throw the cursor to the end. The emitted value is the raw input — the mask characters are presentation and never reach your state.

$ npx shadcn@latest add https://input-cn.vercel.app/r/masked-input.json
Build with an agent

Hand this to Claude Code

1,472 chars

Most people reach this component through an agent rather than by reading the page. Pick how you want it wired and take a prompt that already carries the canonical value, the real prop names and the mistakes worth avoiding.

Wiring
Extras
Open in Claude Code

Nothing runs on its own. The link opens the tool with the prompt typed into the box; you read it and press Enter. If the button does nothing, Claude Code is not installed on this machine — use Copy prompt instead.

Live demo

Click into the middle and type — the caret holds.

value = "" · raw, no mask characters

Constraints

Validation rules, declared as props. Each one produces its own message and its own data-rule value, so a test can assert the rule rather than the sentence.

PROPTYPEDESCRIPTION
complete?booleanRequire every slot in the mask to be filled.
minLength?number—
maxLength?number—
pattern?RegExpTested against the RAW (unmasked) value.

Props

PROPTYPEDESCRIPTION
maskstringTemplate. `#` digit, `A` letter, `*` alphanumeric, `\` escapes. e.g. `"###.###.###-##"`, `"##/##/####"`, `"AA-####"`.
label?ReactNodeVisible label. Supply this or `aria-label` — a field with neither has no accessible name.
hint?ReactNodeHelper text under the field. Replaced by the error message while one is showing.
prefix?ReactNodeRendered before the field, inside the border.
suffix?ReactNodeRendered after the field, inside the border.

Shared props

Implemented identically by all eleven components. These tables are generated from the source interfaces at build time, so a renamed prop changes this page rather than quietly making it wrong.

PROPTYPEDESCRIPTION
value?TCanonical value. Controlled mode.
defaultValue?TCanonical value. Uncontrolled mode. Mutually exclusive with `value`.
onChange?(value: T) => voidEmits the canonical value — never a DOM event.
onBlur?() => voidFires when focus leaves the whole component, not between its parts.
name?stringApplied to the hidden canonical input so FormData carries the real value.
disabled?boolean—
readOnly?boolean—
required?boolean | string—
validate?(value: T) => true | stringCustom synchronous rule. Return true, or the message to display.
messages?MessageMapOverride built-in messages by rule name.
showError?ShowErrorDefault `"touched"`.
onValidityChange?(state: ValidityState) => voidReports validity upward regardless of mode.
mode?FieldModeForce a mode instead of auto-detecting. Escape hatch only.
variant?FieldVariantSurface treatment. Default `"outline"`.
size?FieldSizeDensity. Default `"default"` (32px).
id?string—
className?string—
placeholder?string—
autoFocus?boolean—
aria-label?string—
aria-labelledby?string—
aria-describedby?string—
aria-invalid?boolean | "true" | "false"—

With react-hook-form

import { useForm, Controller } from "react-hook-form"
import { zodResolver } from "@hookform/resolvers/zod"
import { maskedSchema } from "@inputcn/masked/schema"
import { MaskedInput } from "@/components/ui/masked-input"
import { z } from "zod"

// The companion schema validates the CANONICAL value, so the resolver and the
// field can never disagree about what "valid" means.
const schema = z.object({ taxId: maskedSchema() })

export function Example() {
  const { control } = useForm({ resolver: zodResolver(schema) })

  return (
    <Controller
      name="taxId"
      control={control}
      render={({ field, fieldState }) => (
        <MaskedInput
          label="Tax ID"
          {...field}
          aria-invalid={fieldState.invalid}
        />
      )}
    />
  )
}

With a Server Action

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

export default function Page() {
  return (
    <form action={save}>
      <MaskedInput name="taxId" label="Tax ID" />
      <button>Save</button>
    </form>
  )
}

async function save(data: FormData) {
  "use server"
  // The hidden canonical input carries the real value, not the display text.
  const taxId = data.get("taxId") // "12345678901"
}

Keyboard

KEYDOES
Any keyInserts at the caret; the mask reflows around it.
BackspaceDeletes the significant character to the left, skipping separators.
PasteStrips formatting, then refills the mask from the digits.

Emits string, for example "12345678901". Keyboard operation is covered by automated tests; screen readers have not been verified yet.

←CurrencyInput