caliper uidocs
DemoSign inGet Pro

Pin pad

Pro

A PIN entry: dots fill as digits go in, a wrong code shakes and clears with a reason, and a right one settles green. Keypad or keyboard.

Installs components/ui/pin-pad.tsxDepends on lucide-reactMotion none in component source
pnpm dlx shadcn@latest add @caliper/pin-pad

0 of 4 digits

When to use #

Use it for

  • Unlocking cards, wallets and kiosk apps.
  • Confirming a payment on a phone.

Skip it when

  • Passwords; use the password field.

Installation #

terminal
pnpm dlx shadcn@latest add @caliper/pin-pad

Adds its 3 files to components/ui/, each with its own stylesheet, and installs their packages. Pro installs with your access token, set up once per project. See Pro access. The first part also adds Caliper UI’s tokens; import them once as in Installation.

Usage #

Import it from your copy of the source. The example behind the preview comes with the source.

example.tsx
import { PinPad } from "@/components/ui/pin-pad"

The worked example comes with Pro

The 16-line example behind the preview opens here with a Pro or Team licence.

Checking your licence…

API reference #

PinPad

component
PropTypeDefaultDescription
length4 | 64
labelstring"Enter your PIN"
onComplete *(pin: string) => boolean | Promise<boolean>—Checks the code; resolve true to accept.
classNamestring—

Accessibility #

It exposes group semantics, with aria-describedby, aria-hidden, aria-live and aria-label kept in step with state. Changes that matter are announced through a live region.

No custom key handling; Tab and the native activation keys do the work.

Motion #

It declares no animation in its component source. Any transition comes from its stylesheet, which uses the duration tokens that collapse to instant under prefers-reduced-motion.