# Auth (Lumen Halo): prompt.md (v1.0.0)

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

Sign in, sign up and reset password in one card, switching in place. Your onSubmit does the work with any auth provider and throws to show an error; single sign-on buttons; the autocomplete tokens password managers need; a strength meter on sign-up; and a reset that never says whether an email has an account.

## 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/lumen/blocks/auth.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-button`, `lumen-card`, `lumen-field`, `lumen-input`, `lumen-password-field`, `lumen-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: `Auth`, and every exported type.
- CSS: the install merges this item's rules (the registry `css` field) into your global stylesheet, in `@layer components`, and adds the lumen foundation (tokens, keyframes, motion levels) 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 `--lumen-*` custom properties (`--lumen-accent`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-focus`, `--lumen-good`, `--lumen-good-text`, `--lumen-hairline`, `--lumen-ink`, `--lumen-muted-ink`, `--lumen-series-1`, `--lumen-series-2`, `--lumen-series-3`, `--lumen-series-4`, `--lumen-series-5`, `--lumen-series-6`, `--lumen-warn`, `--lumen-warn-text`); this item's CSS also reads `--lumen-font-mono`, `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { Auth } from "@/components/ui/lumen/blocks/auth";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Auth` | `auth` | The auth card. |

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 `GlassSoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/glass-sound.json`, import from `@/components/beautiful-ui/glass-sound`); `GlassSoundToggle` is its mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/lumen/blocks/auth.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
- login page, sign in form, sign up form, forgot password, reset password, auth card, SSO buttons, Lumen
- Your app's sign-in and sign-up screens, in Lumen
- With Auth.js, Clerk, Supabase or your own API: onSubmit calls it

### Not when
- Hosted auth pages you don't control

## Mistakes
- Rate-limit and validate on your server; the form's checks are for people, not attackers
- Keep reset's wording the same for every email

## Usage

```tsx
import { Auth } from "@/components/ui/lumen/blocks/auth";

<Auth providers={[{ id: "github", label: "GitHub" }]} onProvider={(id) => signIn(id)} onSubmit={async ({ mode, email, password }) => {
  if (mode === "sign-in") await signIn("credentials", { email, password });
}} />
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `mode / defaultMode / onModeChange` | `"sign-in" \| "sign-up" \| "reset"` |  | Which form shows; the links switch in place. |
| `onSubmit` | `({ mode, email, password, name }) => void \| Promise` |  | Do the work; throw an Error to show its message. |
| `providers / onProvider` | `{ id, label }[] / (id) => void \| Promise` |  | Single sign-on buttons. |
| `brand` | `string` | `"Lumen"` | The name above the title. |

Full docs: https://beautiful-ui.dev/components/lumen-auth

## Customising
- Colours: set the `--lumen-*` tokens on `:root`, or on a container with the `lumen-scope` class to retheme one area. Add the `lumen-inherit` class to follow your shadcn palette instead (`--chart-N`, `--destructive`).
- 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 |

## Motion inventory

| Interaction | What moves |
|---|---|
| Switch | The form changes in place |

## Accessibility contract (preserve when editing)
- One h1; every field labelled; errors in role=alert
- autocomplete: username and current-password on sign-in, new-password on sign-up
- Reset says the same thing for every email, so it can't be used to find accounts

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-auth
```

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 lumen 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/lumen-foundation.json.