# Menu (Notchset): prompt.md (v2.0.0) - id: `menu` · version 2.0.0 · component · free - category: Overlays - build: one set of files for every shadcn style - install: `npx shadcn@latest add https://notchset.dev/r/menu.json` - npm dependencies: @base-ui/react@^1, lucide-react@^1 - registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json, @notchset/keyboard-hint - docs: https://notchset.dev/components/menu - The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand. The actions for a thing, opened from a button. Items carry an icon and the shortcut the app binds; group labels name a set, and the one destructive step is said in words and red. A bottom sheet on a phone.. ## 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: `@base-ui/react@^1`, `lucide-react@^1`. - Files: `components/ui/notchset/menu.tsx`; shared code: `lib/notchset/popup.ts`, `lib/notchset/portal.ts`. - Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`, `keyboard-hint`. - Builds: one set of files, the same for every shadcn style. - Exports to keep: `Menu`, `MenuCheckboxItem`, `MenuGroup`, `MenuItem`, `MenuSeparator`, 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. - This item reads `--ns-bad-ink`, `--ns-ease`, `--ns-ease-panel`, `--ns-hover`, `--ns-ink`, `--ns-ink-3`, `--ns-line`, `--ns-line-soft`, `--ns-menu-row`, `--ns-radius-lg`, `--ns-radius-xl`, `--ns-raised`, `--ns-shadow-float`, `--ns-sheet-bottom`, `--ns-text-body`, `--ns-text-meta`, `--ns-text-small`, `--ns-time-menu`, `--ns-time-panel`, `--ns-weight-medium`. - 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 { Button } from "@/components/ui/notchset/button"; ``` ## Parts - A single export that takes props. ## Match the original - Read `components/ui/notchset/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 - keyboard-hint (`keyboard-hint`), installed with it: reuse it, don't rebuild it - Popup placement (shared helper, ships with it) - Portal (shared helper, ships with it) ## Mistakes - Recreating the component instead of installing it ## Usage ```tsx "use client"; import * as React from "react"; import { ArrowRightLeft, Ellipsis, Pencil, Pin, Trash2 } from "lucide-react"; import { Button } from "@/components/ui/notchset/button"; import { Menu, MenuGroup, MenuItem, MenuSeparator } from "@/components/ui/notchset/menu"; export default function MenuDemo() { const [last, setLast] = React.useState(null); // The hints the items print are bound here, as an app binds them: E and P, never while typing in a field. React.useEffect(() => { const onKey = (e: KeyboardEvent) => { const t = e.target as HTMLElement | null; if (e.metaKey || e.ctrlKey || e.altKey || e.repeat || t?.closest("input, textarea, select, [contenteditable='true']")) return; if (e.key === "e" || e.key === "E") setLast("Editing Airtable"); else if (e.key === "p" || e.key === "P") setLast("Pinned Airtable"); }; document.addEventListener("keydown", onKey); return () => document.removeEventListener("keydown", onKey); }, []); return (
} > } shortcut="E" onClick={() => setLast("Editing Airtable")}> Edit } shortcut="P" onClick={() => setLast("Pinned Airtable")}> Pin to sidebar {["Discovery", "Evaluation", "Proposal"].map((k) => ( } onClick={() => setLast(`Moved to ${k}`)}> {k} ))} } danger onClick={() => setLast("Delete Airtable…")}> Delete Airtable… {last && {last}}
); } ``` This example also uses `button` (https://notchset.dev/components/button). Installing this item doesn't bring them; to paste the example as it is: `npx shadcn@latest add https://notchset.dev/r/menu.json https://notchset.dev/r/button.json`. ## Props | Prop | Type | Default | What it does | |---|---|---|---| | `trigger` | `React.ReactElement` | | The button that opens it: one element that takes a ref. | | `align` | `"start" \| "center" \| "end"` | `"start"` | | | `open` | `boolean` | | | | `onOpenChange` | `(open: boolean) => void` | | | Full docs: https://notchset.dev/components/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/menu.json ``` Or add the `@notchset` registry to components.json and run `npx shadcn@latest add @notchset/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/menu.tsx ```tsx // Notchset menu 2.0.0 · https://notchset.dev/changelog "use client"; import * as React from "react"; import { Menu as Base } from "@base-ui/react/menu"; import { Check } from "lucide-react"; import { cn } from "@/lib/utils"; import { KeyboardHint } from "@/components/ui/notchset/keyboard-hint"; import { popupItem, popupPositioner, popupSurface } from "@/lib/notchset/popup"; import { usePortalContainer } from "@/lib/notchset/portal"; /* * Menu: the actions for a thing, opened from a button (⋯, a row's menu, the account). Same surface as every * popup: drops below, a bottom sheet on a phone. Items carry an icon, the shortcut the app binds, and danger in * words and colour for the one destructive step. Group labels name a set; separators split sets. */ type MenuProps = { /** The button that opens it: one element that takes a ref. */ trigger: React.ReactElement; children: React.ReactNode; align?: "start" | "center" | "end" | undefined; open?: boolean | undefined; onOpenChange?: ((open: boolean) => void) | undefined; className?: string | undefined; }; function Menu({ trigger, children, align = "start", open, onOpenChange, className }: MenuProps) { const portalContainer = usePortalContainer(); return ( onOpenChange(o) : undefined}> {children} ); } type MenuItemProps = Omit, "className"> & { icon?: React.ReactNode; /** A shortcut the app binds ("E", "⌘⌫"); printed on the right. */ shortcut?: string | undefined; danger?: boolean | undefined; className?: string | undefined; }; function MenuItem({ icon, shortcut, danger, className, children, ...props }: MenuItemProps) { return ( {icon} {children} {shortcut && } ); } type MenuCheckboxItemProps = Omit, "className"> & { icon?: React.ReactNode; className?: string | undefined; }; function MenuCheckboxItem({ icon, className, children, ...props }: MenuCheckboxItemProps) { return ( {icon} {children} ); } function MenuGroup({ label, children }: { label: string; children: React.ReactNode }) { return ( {label} {children} ); } function MenuSeparator() { return ; } export { Menu, MenuCheckboxItem, MenuGroup, MenuItem, MenuSeparator, type MenuItemProps, type MenuProps }; ``` ### lib/notchset/popup.ts ```tsx // Notchset menu 2.0.0 · https://notchset.dev/changelog /* * The one popup surface every list that opens from a control uses (select, combobox, recipient picker, and * menus in batch 3): the prototype's .menu. It drops just below its control, and on a phone it becomes a * bottom sheet with a grab handle and finger-sized rows. Kept as class strings so each primitive's own parts * wear the same look. */ /** On the Positioner: above everything but dialogs; on a phone, pinned to the bottom edge as a sheet (above a tab bar when the app sets --ns-sheet-bottom to its height). */ export const popupPositioner = "z-50 outline-hidden max-[600px]:!fixed max-[600px]:!inset-x-2 max-[600px]:!top-auto max-[600px]:!bottom-[calc(var(--ns-sheet-bottom)+env(safe-area-inset-bottom,0px))] max-[600px]:!left-2 max-[600px]:!w-auto max-[600px]:!transform-none"; /** On the Popup. */ export const popupSurface = "min-w-[max(var(--anchor-width,0px),180px)] max-h-[min(420px,70vh,var(--available-height,70vh))] overflow-auto overscroll-contain rounded-[var(--ns-radius-lg)] bg-[var(--ns-raised)] p-[5px] text-[length:var(--ns-text-body)] text-[var(--ns-ink)] shadow-[0_0_0_1px_var(--ns-line),var(--ns-shadow-float)] outline-hidden origin-[var(--transform-origin)] " + "[animation:ns-menu-in_var(--ns-time-menu)_var(--ns-ease)] data-ending-style:opacity-0 data-ending-style:[transition:opacity_110ms_ease] " + "max-[600px]:w-auto max-[600px]:min-w-0 max-[600px]:max-h-[70dvh] max-[600px]:rounded-[var(--ns-radius-xl)] max-[600px]:px-1.5 max-[600px]:pt-3.5 max-[600px]:pb-1.5 max-[600px]:[animation:ns-sheet-up_var(--ns-time-panel)_var(--ns-ease-panel)] " + "max-[600px]:before:absolute max-[600px]:before:top-[5px] max-[600px]:before:left-1/2 max-[600px]:before:h-1 max-[600px]:before:w-9 max-[600px]:before:-translate-x-1/2 max-[600px]:before:rounded-full max-[600px]:before:bg-[var(--ns-line)] max-[600px]:before:content-['']"; /** On each item. Highlight (pointer or arrow keys) is the hover wash; the chosen item carries a check. */ export const popupItem = "flex w-full min-h-[var(--ns-menu-row)] cursor-default items-center gap-[9px] rounded-[7px] px-[9px] text-left outline-hidden select-none data-highlighted:bg-[var(--ns-hover)] data-disabled:opacity-45 [&_svg:not([data-slot=company-mark])]:size-3.5 [&_svg]:shrink-0"; /** The quiet line a list shows when nothing matches. */ export const popupEmpty = "px-[9px] py-2 text-[length:var(--ns-text-small)] text-[var(--ns-ink-3)] empty:hidden"; ``` ### lib/notchset/portal.ts ```tsx // Notchset menu 2.0.0 · https://notchset.dev/changelog import * as React from "react"; /* * Where overlays (dialogs, menus, popovers, tooltips, toasts, sheets) portal to. By default the document body; a * host that themes or scopes a region (a preview stage, a shadow root, a tile in another theme) wraps it in * PortalContainer with an element inside that scope, so its overlays keep the region's roles and light or dark. */ const PortalContainerContext = React.createContext(null); const PortalContainer = PortalContainerContext.Provider; /** The element overlays portal into here, or undefined for the document body. */ function usePortalContainer(): HTMLElement | undefined { return React.useContext(PortalContainerContext) ?? undefined; } export { PortalContainer, PortalContainerContext, usePortalContainer }; ``` 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.