inputcnv1.0
Star
HomeDocsComponentsBlocksForm contractValidation
Components / CurrencyInput

CurrencyInput

A money field that fills from the right like a cash register, so the caret can never drift into the middle of a number. Separators, symbol placement and the number of fraction digits come from Intl for the active locale and currency, including zero-decimal currencies such as JPY. The value is an integer count of minor units, so no float ever touches a price.

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

Hand this to Claude Code

1,919 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

Digits fill from the right, like a register.

value = 0 · minor units

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
min?numberMinor units.
max?numberMinor units.
positive?boolean—
negative?boolean—
nonZero?boolean—
wholeUnitsOnly?booleanReject fractional currency units (e.g. whole dollars only).
multipleOf?numberMinor units the value must be a multiple of.

Props

PROPTYPEDESCRIPTION
currency?stringISO 4217. Default "USD".
locale?stringBCP 47. Default "en-US".
allowNegative?booleanAllow typing a negative value with "-". Default false.
step?numberStepper increment in minor units. Default one whole unit.
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.
layout?CurrencyLayoutPRD §6 layouts. `inline` is the default form-row shape.
showCode?booleanShow the ISO code as a trailing affix. Default true.

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 { moneySchema } from "@inputcn/currency/schema"
import { CurrencyInput } from "@/components/ui/currency-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({ price: moneySchema() })

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

  return (
    <Controller
      name="price"
      control={control}
      render={({ field, fieldState }) => (
        <CurrencyInput
          label="Amount"
          {...field}
          aria-invalid={fieldState.invalid}
        />
      )}
    />
  )
}

With a Server Action

import { CurrencyInput } from "@/components/ui/currency-input"

export default function Page() {
  return (
    <form action={save}>
      <CurrencyInput name="price" label="Amount" />
      <button>Save</button>
    </form>
  )
}

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

Keyboard

KEYDOES
0 – 9Appends a digit at the minor-unit end.
BackspaceRemoves the last digit; the value shifts one place right.
Arrow up / downSteps by `step`, defaulting to one major unit.

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

←PhoneInput