# Help menu (Notchset): prompt.md (v2.0.0)
- id: `help-menu` · version 2.0.0 · component · free
- category: Navigation
- build: one set of files for every shadcn style
- install: `npx shadcn@latest add https://notchset.dev/r/help-menu.json`
- npm dependencies: lucide-react@^1
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json, @notchset/bottom-sheet, @notchset/menu
- docs: https://notchset.dev/components/help-menu
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.
Help lives where people look for themselves: one config adds Help, with F1, and Contact support (mail or a page) to the account menu, and the same rows to a phone's account sheet. A part left unset isn't drawn..
## Build it
- Stack: React 18.3 or 19, TypeScript, Tailwind CSS v4 utility classes on the foundation's roles, a components.json (imports use its aliases).
- Packages: `lucide-react@^1`.
- Files: `components/ui/notchset/help-menu.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`, `bottom-sheet`, `menu`.
- Builds: one set of files, the same for every shadcn style.
- Exports to keep: `HelpMenuItems`, `HelpSheetItems`, `helpActions`, `useHelpShortcut`, and every exported type.
- CSS: the install adds the notchset foundation (its roles, keyframes and motion switch, reading your shadcn tokens for colour) 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.
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- Retune it (on any ancestor) with the foundation's roles and hooks: `--ns-bad`, `--ns-bad-ink`, `--ns-band`, `--ns-band-edge`, `--ns-band-grade`, `--ns-band-optimal`, `--ns-beat`, `--ns-bezel`, `--ns-canvas`, `--ns-cat-1`, `--ns-cat-2`, `--ns-cat-3`, `--ns-cat-4`, `--ns-cat-5`, `--ns-cat-6`, `--ns-check`, `--ns-chip`, `--ns-control`, `--ns-control-pad`, `--ns-control-sm`, `--ns-deep`, `--ns-deep-ink`, `--ns-deep-ink-2`, `--ns-deep-line`, `--ns-dialog`, `--ns-dialog-lg`, `--ns-dialog-sm`, `--ns-ease`, `--ns-ease-in`, `--ns-ease-panel`, `--ns-ease-pop`, `--ns-field`, `--ns-flood-arc`, `--ns-flood-aurora`, `--ns-flood-behind-1`, `--ns-flood-behind-2`, `--ns-flood-bloom`, `--ns-flood-deep`, `--ns-flood-dial-bloom`, `--ns-flood-glass`, `--ns-flood-grain`, `--ns-flood-image`, `--ns-flood-ink`, `--ns-flood-ink-low`, `--ns-flood-light`, `--ns-flood-mid`, `--ns-flood-pale`, `--ns-flood-pane`, `--ns-flood-pane-edge`, `--ns-flood-pill-ink`, `--ns-flood-ribbon`, `--ns-flood-ribbon-core`, `--ns-flood-shadow`, `--ns-flood-sheen`, `--ns-flood-wash`, `--ns-font-body`, `--ns-font-display`, `--ns-font-mono`, `--ns-font-script`, `--ns-glass`, `--ns-glass-blur`, `--ns-glass-shadow`, `--ns-glow`, `--ns-grain`, `--ns-gutter`, `--ns-header`, `--ns-heat`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-ink-4`, `--ns-leading`, `--ns-lift`, `--ns-light-1`, `--ns-light-2`, `--ns-light-3`, `--ns-light-spread`, `--ns-light-strength`, `--ns-line`, `--ns-line-soft`, `--ns-lit-edge`, `--ns-menu-dy`, `--ns-menu-row`, `--ns-mesh`, `--ns-mesh-frost`, `--ns-ok`, `--ns-ok-ink`, `--ns-orb-body`, `--ns-orb-cool`, `--ns-orb-core`, `--ns-orb-dawn`, `--ns-orb-deep`, `--ns-orb-edge`, `--ns-orb-grain`, `--ns-orb-ground`, `--ns-orb-halo`, `--ns-orb-inner`, `--ns-orb-key`, `--ns-orb-lift`, `--ns-orb-limb`, `--ns-orb-limb-from`, `--ns-orb-rim`, `--ns-orb-skin-hi`, `--ns-orb-skin-lo`, `--ns-orb-skin-mid`, `--ns-orb-warm`, `--ns-panel`, `--ns-panel-w`, `--ns-prism-edge`, `--ns-prism-glint`, `--ns-prism-sheen`, `--ns-prism-tint`, `--ns-pulse`, `--ns-radius`, `--ns-radius-card`, `--ns-radius-full`, `--ns-radius-lg`, `--ns-radius-sm`, `--ns-radius-xl`, `--ns-raised`, `--ns-range`, `--ns-row`, `--ns-row-compact`, `--ns-segment`, `--ns-selected`, `--ns-series`, `--ns-series-core`, `--ns-series-lilac`, `--ns-series-tint`, `--ns-shadow-dialog`, `--ns-shadow-float`, `--ns-shadow-panel`, `--ns-sheet`, `--ns-sheet-bottom`, `--ns-side`, `--ns-signal`, `--ns-sleep-awake`, `--ns-sleep-deep`, `--ns-sleep-light`, `--ns-sleep-rem`, `--ns-space-1`, `--ns-space-2`, `--ns-space-3`, `--ns-space-4`, `--ns-space-5`, `--ns-space-6`, `--ns-space-8`, `--ns-space-section`, `--ns-stack-on`, `--ns-standing-critical`, `--ns-standing-in`, `--ns-standing-out`, `--ns-state-doing`, `--ns-state-done`, `--ns-state-review`, `--ns-state-todo`, `--ns-switch-h`, `--ns-switch-w`, `--ns-text-body`, `--ns-text-control`, `--ns-text-display`, `--ns-text-figure`, `--ns-text-headline`, `--ns-text-hero`, `--ns-text-lede`, `--ns-text-meta`, `--ns-text-page`, `--ns-text-record`, `--ns-text-small`, `--ns-text-strong`, `--ns-text-sub`, `--ns-text-title`, `--ns-tile-shadow`, `--ns-time-born`, `--ns-time-color`, `--ns-time-dialog`, `--ns-time-menu`, `--ns-time-page`, `--ns-time-panel`, `--ns-time-toast`, `--ns-tint`, `--ns-tint-ink`, `--ns-toast-bottom`, `--ns-toast-left`, `--ns-touch`, `--ns-tracking-display`, `--ns-tracking-headline`, `--ns-warn`, `--ns-warn-ink`, `--ns-wash-clay`, `--ns-wash-dusk`, `--ns-wash-graphite`, `--ns-wash-ink`, `--ns-wash-sage`, `--ns-wash-sand`, `--ns-weight-light`, `--ns-weight-medium`, `--ns-weight-regular`, `--ns-weight-strong`, `--ns-well`.
- Never add Tailwind colour classes inside the component.
```tsx
import { Avatar } from "@/components/ui/notchset/avatar";
```
## Parts
- A single export that takes props.
## Match the original
- Read `components/ui/notchset/help-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
### Not when
## Built from
- bottom-sheet (`bottom-sheet`), installed with it: reuse it, don't rebuild it
- menu (`menu`), installed with it: reuse it, don't rebuild it
## Mistakes
- Recreating the component instead of installing it
## Usage
```tsx
"use client";
import { ChevronsUpDown, Keyboard, LogOut, Settings } from "lucide-react";
import { Avatar } from "@/components/ui/notchset/avatar";
import { HelpMenuItems, useHelpShortcut, type HelpConfig } from "@/components/ui/notchset/help-menu";
import { Menu, MenuItem, MenuSeparator } from "@/components/ui/notchset/menu";
/* one config: Help (F1) and Contact support join the account menu; leave a part out and its item isn't drawn */
const HELP: HelpConfig = { url: "https://example.com/help", support: { email: "support@example.com" } };
export default function HelpMenuDemo() {
useHelpShortcut(HELP);
return (
);
}
```
This example also uses `avatar` (https://notchset.dev/components/avatar). Installing this item doesn't bring them; to paste the example as it is: `npx shadcn@latest add https://notchset.dev/r/help-menu.json https://notchset.dev/r/avatar.json`.
## Props
| Prop | Type | Default | What it does |
|---|---|---|---|
| `help` | `HelpConfig \| undefined` | | Required. |
Full docs: https://notchset.dev/components/help-menu
## Customising
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- Dark mode follows the `.dark` class or `data-theme="dark"` on an ancestor (the shadcn and next-themes conventions).
- Update later: Commit or stash local changes first (or copy the files), so the update can be undone. Read https://notchset.dev/r/changelog.json for the new versions: a major version, an entry marked breaking or a merge says what to change. Then re-run the install with `--overwrite`, on a branch. It replaces the component's files, the shared helper files they import, and the item's CSS rules in the global stylesheet, so review the whole diff (components, shared files, CSS), re-apply your own edits, and run the app's typecheck, tests and build.
## Accessibility contract (preserve when editing)
## Install
```bash
npx shadcn@latest add https://notchset.dev/r/help-menu.json
```
Or add the `@notchset` registry to components.json and run `npx shadcn@latest add @notchset/help-menu`. Every components.json style gets the same files.
## Continue the workflow
- [Bottom sheet](https://notchset.dev/components/bottom-sheet)
- [Command menu](https://notchset.dev/components/command-menu)
- [Dialog](https://notchset.dev/components/dialog)
## Source
### components/ui/notchset/help-menu.tsx
```tsx
// Notchset help-menu 2.0.0 · https://notchset.dev/changelog
"use client";
import * as React from "react";
import { CircleHelp, LifeBuoy } from "lucide-react";
import { SheetItem } from "@/components/ui/notchset/bottom-sheet";
import { MenuItem } from "@/components/ui/notchset/menu";
/*
* Help menu: Help lives where people already look for themselves, in the account menu beside Keyboard shortcuts.
* One config adds "Help" (with F1) and "Contact support"; leave a part unset and its item isn't drawn.
*
* const help: HelpConfig = { url: "https://docs.example.com", support: { email: "help@example.com" } };
* useHelpShortcut(help);
*
*
* On a phone the account sheet takes HelpSheetItems. Point-of-use explanations are Explain (components/explain.tsx).
*/
export type HelpConfig = {
/** The help centre, opened in a new tab. */
url?: string | undefined;
/** Opens help in the app instead (a panel, a chat); wins over url. */
onOpen?: (() => void) | undefined;
/** Where Contact support goes: an address (opens mail) or a page. */
support?: { email?: string | undefined; url?: string | undefined } | undefined;
/** The key that opens Help; false binds none. Defaults to F1. */
shortcut?: "F1" | false | undefined;
};
const open = (url: string) => {
if (typeof window !== "undefined") window.open(url, "_blank", "noopener,noreferrer");
};
/** What each item does, or undefined when the config leaves it out. */
export function helpActions(help: HelpConfig | undefined) {
const openHelp = help?.onOpen ?? (help?.url ? () => open(help.url!) : undefined);
const s = help?.support;
const contact = s?.url ? () => open(s.url!) : s?.email ? () => open(`mailto:${s.email}`) : undefined;
return { openHelp, contact };
}
/** Binds the Help key (F1) while mounted, when help is configured. */
export function useHelpShortcut(help: HelpConfig | undefined) {
const { openHelp } = helpActions(help);
const key = help?.shortcut ?? "F1";
const latest = React.useRef(openHelp);
React.useEffect(() => {
latest.current = openHelp;
});
const on = !!openHelp && key !== false;
React.useEffect(() => {
if (!on) return;
const down = (e: KeyboardEvent) => {
if (e.key !== key || e.isComposing || e.metaKey || e.ctrlKey || e.altKey) return;
e.preventDefault();
latest.current?.();
};
window.addEventListener("keydown", down);
return () => window.removeEventListener("keydown", down);
}, [on, key]);
}
type HelpMenuItemsProps = {
help: HelpConfig | undefined;
};
/** Help and Contact support, for the account menu; nothing when the config leaves them out. */
function HelpMenuItems({ help }: HelpMenuItemsProps) {
const { openHelp, contact } = helpActions(help);
const key = help?.shortcut ?? "F1";
return (
<>
{openHelp && (
} shortcut={key || undefined} onClick={openHelp}>
Help
)}
{contact && (
} onClick={contact}>
Contact support
)}
);
}
/** The same two items as finger-sized rows, for a phone's account sheet. */
function HelpSheetItems({ help, onDone }: HelpMenuItemsProps & { onDone?: (() => void) | undefined }) {
const { openHelp, contact } = helpActions(help);
return (
<>
{openHelp && (
} onClick={() => (onDone?.(), openHelp())}>
Help
)}
{contact && (
} onClick={() => (onDone?.(), contact())}>
Contact support
)}
);
}
export { HelpMenuItems, HelpSheetItems, type HelpMenuItemsProps };
```
The foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://notchset.dev/r/notchset-foundation.json.