HomeDocsComponentsBlocksForm contractValidation
Components / FileSizeInput

FileSizeInput

Emits bytes. MB is 1000² and MiB is 1024², a 4.9% gap — which is exactly the difference between “a 100 MB limit” and a user’s file being rejected. The field keeps them distinct rather than quietly converting, and the byte count is grouped with an explicit locale so it does not render as 2,50,00,000 on a machine set to en-IN.

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

Hand this to Claude Code

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

1 MB and 1 MiB differ by 4.9%. Try both.

value = 0 · bytes

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?SizeBound—
max?SizeBound—

Props

PROPTYPEDESCRIPTION
binary?booleanUse KiB/MiB/GiB and read ambiguous units as powers of 1024. Default false.
bareUnit?stringUnit assumed when the user types a bare number. Default "MB".
precision?numberDecimals when formatting. Default 2.
locale?stringGrouping locale for the raw byte readout. Default "en-US".
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.
showBytes?booleanShow the raw byte count 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 { fileSizeSchema } from "@inputcn/filesize/schema"
import { FileSizeInput } from "@/components/ui/filesize-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({ limit: fileSizeSchema() })

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

  return (
    <Controller
      name="limit"
      control={control}
      render={({ field, fieldState }) => (
        <FileSizeInput
          label="Upload limit"
          {...field}
          aria-invalid={fieldState.invalid}
        />
      )}
    />
  )
}

With a Server Action

import { FileSizeInput } from "@/components/ui/filesize-input"

export default function Page() {
  return (
    <form action={save}>
      <FileSizeInput name="limit" label="Upload limit" />
      <button>Save</button>
    </form>
  )
}

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

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