# Help Menu

> The "?" menu from the corner of an app: a Search docs field, documentation and shortcut links, the latest changelog entries with unread dots, ways to reach support, and a footer with live system status (operational, degraded or outage) and the app version. An unread dot marks the trigger. Keyboard support from Base UI.

- Slug: `help-menu`
- Category: [Menus](https://www.assembli.design/category/menus.md)
- Type: component
- Tags: dropdown, help, support, changelog, status
- npm dependencies: @base-ui/react, lucide-react
- shadcn/ui dependencies: none
- Live preview: https://www.assembli.design/preview/help-menu
- Page: https://www.assembli.design/components/help-menu

![Help Menu preview](https://www.assembli.design/thumbnails/help-menu-light.png)

## Props

Other props pass through to the root element.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `resources` | `HelpLink[]` | `DEFAULT_RESOURCES` |  |
| `contact` | `HelpLink[]` | `DEFAULT_CONTACT` |  |
| `updates` | `HelpUpdate[]` | `DEFAULT_UPDATES` | Latest changelog entries; unread ones get a dot, and any unread one marks the trigger. |
| `status` | `HelpStatus` | `"operational"` |  |
| `statusHref` | `string` |  | Status page URL. Without it the status row calls `onSelect("status")`. |
| `version` | `string` | `"v2.14.0"` | App version shown in the footer. |
| `search` | `boolean` | `true` | Shows a "Search docs" field at the top. |
| `onSelect` | `(id: string) => void` |  | Called with a link id, "search", "changelog", or an update id. |
| `side` | `"top" \| "bottom" \| "left" \| "right"` | `"top"` |  |
| `align` | `"start" \| "center" \| "end"` | `"end"` |  |

## Install

One-time setup (needs a subscription):

1. Add the registry to the project's `components.json`: `{"@assembli":{"url":"https://www.assembli.design/r/{name}.json","headers":{"Authorization":"Bearer ${ASSEMBLI_API_KEY}"}}}` (merge into `"registries"`).
2. Put an API key from https://www.assembli.design/account in `.env.local` as `ASSEMBLI_API_KEY=asm_…`.

Then install with the shadcn CLI (writes `components/help-menu/help-menu.tsx` and installs dependencies):

```bash
npx shadcn@latest add @assembli/help-menu
```

Registry item JSON: https://www.assembli.design/r/help-menu.json (send `Authorization: Bearer <api key>`)

## Code

> Component source needs an Assembli subscription ($12/month or $96/year) and an API key sent as `Authorization: Bearer <key>`. To get one without copying anything, POST https://www.assembli.design/api/agent/login (or call the MCP tool connect_account), show the user the link it returns, and poll https://www.assembli.design/api/agent/token for the key. Or subscribe at https://www.assembli.design/pricing and create a key at https://www.assembli.design/account.