# Password Field (Notchset): prompt.md (v1.0.0)

- id: `password-field` · version 1.0.0 · component · pro (Pro)
- category: Inputs
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/password-field`
- npm dependencies: none
- registry dependencies: utils, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/password-field
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

A labelled 40px password field: a lock glyph, mono input tracked wide while masked, a CAPS chip while Caps Lock is on, a show/hide key whose slash draws away, a Forgot link, and a mechanical shake when an attempt is refused.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: none beyond React.
- Files: `components/ui/notchset/password-field.tsx`; shared code: `lib/beautiful-ui/notchset/password.tsx`, `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`.
- Builds: one set of files for both, but its dependencies come in Base UI and Radix builds. Install the one that matches the project (see Install): a free item's bare URL installs the Base UI build of it and its dependencies.
- Exports to keep: `PasswordField`, `PasswordInput`, and every exported type.
- CSS: the install adds the notchset foundation (tokens, keyframes, motion levels) to your global stylesheet once. Nothing to import by hand.
- Re-running `add` (or `--overwrite`) re-applies those rules: put overrides in your own CSS, never in the installed rules.
- Tokens: retheme with the `--notchset-*` custom properties (`--notchset-check`, `--notchset-control-edge`, `--notchset-draw-from`, `--notchset-ease-bloom`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`). Never add Tailwind colour classes inside the component.

```tsx
import { PasswordField } from "@/components/ui/notchset/password-field";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `PasswordField` | `password-field-root` | Label, field and help. |
| `field` | `password-field` | The 40px field. |

Style a part with `[data-slot="<slot>"]` selectors or its `className`; keep the attributes when editing.

## Sound
- Keep every `data-slot` and `data-sound` attribute: the sound layer reads them.
- Installing this item adds no audio. Nothing plays until the app mounts `SoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/notchset-sound.json`, import from `@/components/ui/notchset/sound-provider`); `useSound()` gives `muted` and `setMuted` for a mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/notchset/password-field.tsx` as the reference implementation before changing or recreating anything, and match it: sizes, colours per theme, motion timings, copy and behaviour.
- If you deviate (a prop you can't honour, a style you changed, a dependency you swapped), say so in your reply, part by part.
- Keep the accessibility contract, the keyboard map and the motion levels listed below.

## Use it when
- password field, password input, sign in, show password, caps lock warning, login form, Notchset
- Sign-in and re-authentication forms

### Not when
- Choosing a new password: use Password Strength

## Mistakes
- Clear the error as the user types, so the next refusal reads as new

## Usage

```tsx
"use client";

import * as React from "react";
import { PasswordField } from "@/components/ui/notchset/password-field";

export function SignInPassword({ signIn }: { signIn: (password: string) => Promise<boolean> }) {
  const [password, setPassword] = React.useState("");
  const [error, setError] = React.useState<string | undefined>();
  const [attempts, setAttempts] = React.useState(0);
  return (
    <form
      onSubmit={async (e) => {
        e.preventDefault();
        if (await signIn(password)) return;
        setError("That password doesn't match.");
        setAttempts((a) => a + 1);
      }}
    >
      <PasswordField value={password} onValueChange={setPassword} error={error} shake={attempts} forgotHref="/reset" />
    </form>
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `value / onValueChange` | `string / fn` |  | Controlled. |
| `error` | `string` |  | Signal border and help line; sets aria-invalid. |
| `shake` | `number` |  | Bump it to shake on a refused attempt. |
| `revealable / capsLockHint` | `boolean` |  | The show/hide key and the CAPS chip (both on). |
| `forgotHref / onForgot` | `string / fn` |  | The Forgot link. |
| `help` | `ReactNode` |  | The help line when there is no error. |

Full docs: https://beautiful-ui.dev/components/password-field

## Customising
- Colours: the component reads your shadcn tokens (`--background`, `--foreground`, `--border` …), refined by the `--notchset-*` tokens. The signal colour is `--notchset-signal` (it falls back to `--destructive`). Set tokens on `:root`, or on any container to retheme one area.
- Dark mode follows the `.dark` class on an ancestor (the shadcn and next-themes convention).
- Update later by re-running the install with `--overwrite` (review the diff if you edited it). Changelog: https://beautiful-ui.dev/r/changelog.json

## Keyboard

| Keys | Action |
|---|---|
| Enter | Submit the form |
| Tab | Reach show/hide |

## Performance

- A native input; the shake uses the Web Animations API on the field, so the input keeps focus.

## Responsive

- Fills its container; the show/hide key and CAPS chip keep their size.
- 44px tall on touch screens.

## Motion inventory

| Interaction | What moves |
|---|---|
| Show / hide | The slash draws away (280ms) and the pupil grows |
| Refused | Shakes ±3px in four 50ms steps |

## Accessibility contract (preserve when editing)
- A real label; the help line describes the input and is polite live text
- The show/hide key is type="button" with aria-pressed: it never submits the form
- Caps Lock is announced in the help line

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/password-field
```

Pro item: needs the `@beautiful-ui-pro` registry in `components.json` and `BEAUTIFUL_UI_TOKEN` in `.env.local` (https://beautiful-ui.dev/account). Setup: https://beautiful-ui.dev/docs/pro. Your components.json `style` picks the build: radix-*, new-york and default get Radix, base-* gets Base UI.

## Credits
- Built on shadcn/ui (https://ui.shadcn.com)

The notchset foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://beautiful-ui.dev/r/notchset-foundation.json.