# Account Menu (Lumen Halo): prompt.md (v1.0.0)

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

The account corner of an app's top bar: your avatar with a presence dot opens who you are and your plan, a usage meter in lit cells, workspace switching, your own items with shortcuts, status, theme and a sign out that can wait on a promise.

## 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/controls/account-menu.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-avatar`, `lumen-dropdown-menu`, `lumen-color-mode`, `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: `AccountMenu`, 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-foreground`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-chart-accent`, `--lumen-chart-accent-foreground`, `--lumen-chart-accent-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-account-menu-ground`, `--lumen-font-mono`, `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { AccountMenu } from "@/components/ui/lumen/controls/account-menu";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `AccountMenu` | — | The trigger and the menu. |

## 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/controls/account-menu.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
- user menu, account menu, profile menu, avatar menu, sign out, workspace switcher, top bar, Lumen
- The top-right of an app bar, or the foot of a sidebar

### Not when
- Marketing sites before sign-in: use a Sign in button

## Mistakes
- Keep items to three to five; settings pages hold the rest
- Route with your router in onSelect

## Usage

```tsx
"use client";

import * as React from "react";
import { useRouter } from "next/navigation";
import { AccountMenu } from "@/components/ui/lumen/controls/account-menu";

export function UserMenu() {
  const router = useRouter();
  const signOut = async () => {
    await fetch("/api/logout", { method: "POST" });
    router.push("/login");
  };

  return (
    <AccountMenu
      user={{ name: "Maya Chen", email: "maya@acme.com", plan: "Growth" }}
      items={[
        { label: "Profile", onSelect: () => router.push("/profile") },
        { label: "Settings", shortcut: "⌘,", onSelect: () => router.push("/settings") },
      ]}
      usage={{ label: "Seats", used: 8, limit: 10 }}
      onSignOut={signOut}
    />
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `user` | `{ name, email?, image?, plan? }` |  | Who's signed in. Initials stand in for a missing image. |
| `items` | `{ label, onSelect, icon?, shortcut? }[]` |  | Your account items. shortcut is shown, not bound: bind keys in your app. |
| `workspaces / workspace / onWorkspaceChange` | `{ id, name }[]` |  | Two or more add a Workspace group (radio). |
| `usage` | `{ label, used, limit }` |  | A ten-cell meter under the name; amber from 80%. |
| `status / onStatusChange` | `"online" \| "away" \| "busy"` |  | The presence dot on the avatar and a Status submenu. |
| `theme / onThemeChange` | `"light" \| "dark" \| "system"` |  | A Theme submenu. Without onThemeChange it applies .dark on <html> itself. |
| `onSignOut` | `() => unknown` |  | Adds Sign out; a returned promise shows it working. |
| `showName` | `boolean` | `false` | Name, workspace and a chevron beside the avatar. |
| `align` | `"start" \| "center" \| "end"` | `"end"` | Where the menu lines up with the trigger. |

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

## 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, Space or Arrow down | Open (on the avatar) |
| Arrow keys | Move through the menu; right opens a submenu |
| Escape | Close |

## Motion inventory

| Interaction | What moves |
|---|---|
| Open | The menu opens as every Lumen menu does; the chevron turns |

## Accessibility contract (preserve when editing)
- The trigger names the account (Account: Maya Chen)
- Workspace, status and theme are radio groups, so the current one is announced
- Presence is in words in the Status submenu, not only colour

## Install

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

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.