{"slug":"menu","name":"Menu","category":"Overlays","summary":"A vertical list of commands, options, or links.","status":"stable","since":"0.2.0","import":"import { Menu } from '@elluzion/iv-ui';","usage":["`entries` is a typed list of headers, items, separators, and submenus.","`semantic=\"listbox\"` switches the roles for selection menus; pair it with `multiselect`.","`onclick` receives the native event and the activated entry."],"props":[{"name":"entries","type":"MenuEntry[]","default":"[]","description":"Menu structure: headers, items, separators, and submenus.","required":false,"bindable":false},{"name":"semantic","type":"MenuSemantic","default":"'menu'","description":"ARIA role: a command menu or a listbox.","required":false,"bindable":false},{"name":"multiselect","type":"boolean","default":"false","description":"Allows several items to show as selected.","required":false,"bindable":false},{"name":"emptyLabel","type":"string","default":"''","description":"Text shown when there are no entries.","required":false,"bindable":false},{"name":"label","type":"string","default":"''","description":"Accessible name for the menu.","required":false,"bindable":false},{"name":"id","type":"string","default":"''","description":"Element id. A generated id is used when omitted.","required":false,"bindable":false},{"name":"className","type":"string","default":"''","description":"Extra classes merged onto the root element.","required":false,"bindable":false}],"events":[{"name":"click","type":"(e: MouseEvent, entry: MenuEntry) => void","default":null,"description":"Called with the native event and the activated entry.","required":false,"bindable":false}],"snippets":[],"types":[{"name":"MenuSemantic","kind":"type","code":"type MenuSemantic = 'menu' | 'listbox';","description":"ARIA role used for the menu container."},{"name":"MenuItem","kind":"interface","code":"interface MenuItem {\n\tlabel: string;\n\ticon?: Icon;\n\tshortcut?: string;\n\ttrailingIcon?: Icon;\n\tdisabled?: boolean;\n\tdim?: boolean;\n\tselected?: boolean;\n\tactive?: boolean;\n\tonclick?: (e: MouseEvent) => void;\n\tonmouseenter?: (e: MouseEvent) => void;\n}","description":"A single actionable menu row."},{"name":"MenuEntry","kind":"type","code":"type MenuEntry =\n\t| { type: 'header'; id: string; label: string }\n\t| { type: 'separator'; id: string }\n\t| { type: 'item'; id: string; item: MenuItem }\n\t| {\n\t\t\ttype: 'submenu';\n\t\t\tid: string;\n\t\t\tlabel: string;\n\t\t\ticon?: Icon;\n\t\t\tchildren: MenuEntry[];\n\t\t\tdisabled?: boolean;\n\t  };","description":"One row of the menu structure, including headers and separators."}],"manual":[],"tokens":["--iv_border","--iv_bracket","--iv_disabled-opacity","--iv_ease-out","--iv_font-mono","--iv_font-ui","--iv_foreground","--iv_foreground-dim","--iv_menu-lead-size","--iv_radius","--iv_radius-sm","--iv_reverse-bg","--iv_reverse-fg","--iv_shadow-sm","--iv_spacing-md","--iv_spacing-sm","--iv_spacing-xs","--iv_submenu-min-w","--iv_surface-hover","--iv_surface-raised","--iv_text-body","--iv_text-label","--iv_text-sm","--iv_text-xs","--iv_tracking-wide","--iv_transition-fast","--iv_z-dropdown"],"cssHooks":["iv-active","iv-checkbox","iv-checked","iv-dim","iv-disabled","iv-empty","iv-item","iv-label","iv-leading","iv-menu","iv-section-header","iv-selected","iv-separator","iv-shortcut","iv-submenu","iv-submenu-item","iv-trailing"],"accessibility":{"notes":["Headers and separators are visual structure; items carry `menuitem` or `option`.","Selected items expose `aria-checked` in menu mode and `aria-selected` in listbox mode.","Items are not in the tab order by design — place the menu in `ContextMenu` or move focus yourself."]},"related":[{"title":"ContextMenu","summary":"Opens a menu at the pointer or from the keyboard Menu key.","url":"/components/context-menu","kind":"Component"},{"title":"Select","summary":"A custom listbox with search, multiple selection, and clearing.","url":"/components/select","kind":"Component"},{"title":"Popover","summary":"A floating panel anchored to an element.","url":"/components/popover","kind":"Component"},{"title":"Shortcut","summary":"Renders a keyboard combination as key caps.","url":"/components/shortcut","kind":"Component"}],"examples":[{"id":"basic","title":"Basic","description":"A header, items with shortcuts, and a separator.","code":"<script lang=\"ts\">\n\timport type { MenuEntry } from '@elluzion/iv-ui';\n\timport { Menu } from '@elluzion/iv-ui';\n\n\tlet last = $state('none');\n\n\tconst entries: MenuEntry[] = [\n\t\t{ type: 'header', id: 'project', label: 'Project' },\n\t\t{ type: 'item', id: 'open', item: { label: 'Open', shortcut: '⏎' } },\n\t\t{ type: 'item', id: 'duplicate', item: { label: 'Duplicate', shortcut: '⌘D' } },\n\t\t{ type: 'separator', id: 'sep' },\n\t\t{ type: 'item', id: 'archive', item: { label: 'Archive' } },\n\t\t{ type: 'item', id: 'delete', item: { label: 'Delete', disabled: true } }\n\t];\n\n\tfunction handle(_event: MouseEvent, entry: MenuEntry) {\n\t\tif (entry.type === 'item') last = entry.item.label;\n\t}\n</script>\n\n<div class=\"stack\">\n\t<div class=\"surface\">\n\t\t<Menu {entries} label=\"Project actions\" onclick={handle} />\n\t</div>\n\t<p class=\"readout\">last action: {last}</p>\n</div>\n\n<style>\n\t.stack {\n\t\tdisplay: flex;\n\t\tflex-direction: column;\n\t\talign-items: center;\n\t\tgap: var(--iv_spacing-sm);\n\t}\n\n\t.surface {\n\t\twidth: 260px;\n\t\tborder: 1px solid var(--iv_border);\n\t\tborder-radius: var(--iv_radius-sm);\n\t\tbackground: var(--iv_surface-raised);\n\t}\n\n\t.readout {\n\t\tmargin: 0;\n\t\tfont-family: var(--iv_font-mono);\n\t\tfont-size: var(--iv_text-sm);\n\t\tcolor: var(--iv_foreground-dim);\n\t}\n</style>"},{"id":"listbox","title":"Listbox","description":"Selection semantics with selected rows and a multiple mode.","code":"<script lang=\"ts\">\n\timport type { MenuEntry } from '@elluzion/iv-ui';\n\timport { Menu } from '@elluzion/iv-ui';\n\n\tlet selected = $state<string[]>(['logs']);\n\n\tconst options = [\n\t\t{ id: 'logs', label: 'Logs' },\n\t\t{ id: 'metrics', label: 'Metrics' },\n\t\t{ id: 'traces', label: 'Traces' }\n\t];\n\n\tconst entries = $derived<MenuEntry[]>(\n\t\toptions.map((option) => ({\n\t\t\ttype: 'item' as const,\n\t\t\tid: option.id,\n\t\t\titem: { label: option.label, selected: selected.includes(option.id) }\n\t\t}))\n\t);\n\n\tfunction handle(_event: MouseEvent, entry: MenuEntry) {\n\t\tif (entry.type !== 'item') return;\n\t\tselected = selected.includes(entry.id)\n\t\t\t? selected.filter((id) => id !== entry.id)\n\t\t\t: [...selected, entry.id];\n\t}\n</script>\n\n<div class=\"stack\">\n\t<div class=\"surface\">\n\t\t<Menu {entries} semantic=\"listbox\" multiselect label=\"Signals\" onclick={handle} />\n\t</div>\n\t<p class=\"readout\">selected: {selected.join(', ') || '—'}</p>\n</div>\n\n<style>\n\t.stack {\n\t\tdisplay: flex;\n\t\tflex-direction: column;\n\t\talign-items: center;\n\t\tgap: var(--iv_spacing-sm);\n\t}\n\n\t.surface {\n\t\twidth: 260px;\n\t\tborder: 1px solid var(--iv_border);\n\t\tborder-radius: var(--iv_radius-sm);\n\t\tbackground: var(--iv_surface-raised);\n\t}\n\n\t.readout {\n\t\tmargin: 0;\n\t\tfont-family: var(--iv_font-mono);\n\t\tfont-size: var(--iv_text-sm);\n\t\tcolor: var(--iv_foreground-dim);\n\t}\n</style>"},{"id":"submenu","title":"Submenu","description":"A nested menu that opens on hover or the right arrow key.","code":"<script lang=\"ts\">\n\timport type { MenuEntry } from '@elluzion/iv-ui';\n\timport { Menu } from '@elluzion/iv-ui';\n\n\tlet last = $state('none');\n\n\tconst entries: MenuEntry[] = [\n\t\t{ type: 'item', id: 'rename', item: { label: 'Rename' } },\n\t\t{\n\t\t\ttype: 'submenu',\n\t\t\tid: 'share',\n\t\t\tlabel: 'Share',\n\t\t\tchildren: [\n\t\t\t\t{ type: 'item', id: 'link', item: { label: 'Copy link' } },\n\t\t\t\t{ type: 'item', id: 'email', item: { label: 'Email invite' } }\n\t\t\t]\n\t\t},\n\t\t{ type: 'item', id: 'details', item: { label: 'Details' } }\n\t];\n\n\tfunction handle(_event: MouseEvent, entry: MenuEntry) {\n\t\tif (entry.type === 'item') last = entry.item.label;\n\t}\n</script>\n\n<div class=\"stack\">\n\t<div class=\"surface\">\n\t\t<Menu {entries} label=\"Item actions\" onclick={handle} />\n\t</div>\n\t<p class=\"readout\">last action: {last}</p>\n</div>\n\n<style>\n\t.stack {\n\t\tdisplay: flex;\n\t\tflex-direction: column;\n\t\talign-items: center;\n\t\tgap: var(--iv_spacing-sm);\n\t}\n\n\t.surface {\n\t\twidth: 260px;\n\t\tborder: 1px solid var(--iv_border);\n\t\tborder-radius: var(--iv_radius-sm);\n\t\tbackground: var(--iv_surface-raised);\n\t}\n\n\t.readout {\n\t\tmargin: 0;\n\t\tfont-family: var(--iv_font-mono);\n\t\tfont-size: var(--iv_text-sm);\n\t\tcolor: var(--iv_foreground-dim);\n\t}\n</style>"}],"markdown":"/components/menu.md","page":"/components/menu"}