import { html } from '@webjsdev/core';
export default function ContextMenuDemo() {
return html`
<ui-context-menu>
<ui-context-menu-trigger>
<div tabindex="0" class="flex aspect-video w-full max-w-xs items-center justify-center rounded-xl border border-dashed text-sm">
<span class="hidden pointer-fine:inline-block">Right click here</span>
<span class="hidden pointer-coarse:inline-block">Long press here</span>
</div>
</ui-context-menu-trigger>
<ui-context-menu-content class="w-48">
<ui-context-menu-group>
<ui-context-menu-item>
Back
<ui-context-menu-shortcut>⌘[</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item data-disabled>
Forward
<ui-context-menu-shortcut>⌘]</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item>
Reload
<ui-context-menu-shortcut>⌘R</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-sub>
<ui-context-menu-sub-trigger>More Tools</ui-context-menu-sub-trigger>
<ui-context-menu-sub-content>
<ui-context-menu-group>
<ui-context-menu-item>Save Page...</ui-context-menu-item>
<ui-context-menu-item>Create Shortcut...</ui-context-menu-item>
<ui-context-menu-item>Name Window...</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item>Developer Tools</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item variant="destructive">Delete</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-sub-content>
</ui-context-menu-sub>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item type="checkbox" checked>Show Bookmarks</ui-context-menu-item>
<ui-context-menu-item type="checkbox">Show Full URLs</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group aria-label="People">
<ui-context-menu-label>People</ui-context-menu-label>
<ui-context-menu-item type="radio" value="pedro" checked>Pedro Duarte</ui-context-menu-item>
<ui-context-menu-item type="radio" value="colm">Colm Tuite</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-content>
</ui-context-menu>
`;
}
View Code
Installation
Copy and paste the following code into your project.
/**
* Context menu: the menu a right-click (or the keyboard's menu key, or
* Shift+F10) opens at the pointer, over a region of the page. Tier-2. It is
* the dropdown menu opened a different way, as in shadcn, so every part is a
* dropdown element under the `ui-context-menu-*` tags: the same items,
* checkbox and radio items, labels, separators, shortcuts, groups and
* sub-menus, the same keyboard model (arrows, Home / End, typeahead, Enter /
* Space, Escape, Tab) and the same focus care on every close path.
*
* shadcn parity:
* ContextMenu → <ui-context-menu>
* ContextMenuTrigger → <ui-context-menu-trigger> around the region; a class
* written on it lands on the region box it renders
* ContextMenuContent → <ui-context-menu-content>
* ContextMenuItem → <ui-context-menu-item> (variant, type="checkbox" | "radio", checked, value)
* ContextMenuLabel / Separator / Shortcut / Group
* → <ui-context-menu-label> / -separator / -shortcut / -group
* ContextMenuSub / SubTrigger / SubContent
* → <ui-context-menu-sub> / -sub-trigger / -sub-content
*
* The menu opens at the pointer for a right-click, and below the focused
* element when the keyboard opened it. A left click never opens it, and a
* click outside the panel (in the region or anywhere else) or Escape closes it.
*
* A11y (handled by the element, plus one obligation): the panel is a
* `role="menu"` named "Context menu" unless you name it (`aria-label` on
* `<ui-context-menu-content>`), items are menuitems with roving focus, and
* closing returns focus to whatever had it before the menu opened. A context
* menu is a shortcut, never the only way to reach an action: put each of its
* commands somewhere a keyboard or touch user finds without a right-click
* (a toolbar, a dropdown, a button), and make the region itself focusable
* (`tabindex="0"` or a focusable child) so the keyboard can open the menu.
*
* @example
* ```html
* <ui-context-menu>
* <ui-context-menu-trigger>
* <div tabindex="0" class="flex h-36 items-center justify-center rounded-md border border-dashed">Right-click here</div>
* </ui-context-menu-trigger>
* <ui-context-menu-content aria-label="File actions">
* <ui-context-menu-item>Rename</ui-context-menu-item>
* <ui-context-menu-item variant="destructive">Delete</ui-context-menu-item>
* </ui-context-menu-content>
* </ui-context-menu>
* ```
*/
import {
UiDropdownMenu,
UiDropdownMenuTrigger,
UiDropdownMenuContent,
UiDropdownMenuItem,
UiDropdownMenuLabel,
UiDropdownMenuSeparator,
UiDropdownMenuShortcut,
UiDropdownMenuGroup,
UiDropdownMenuSub,
UiDropdownMenuSubTrigger,
UiDropdownMenuSubContent,
type MenuClasses,
} from './dropdown-menu.ts';
import { html } from '@webjsdev/core';
import { cn, takeAuthoredClass } from '../lib/utils.ts';
import { positionFloating } from './floating.ts';
/** The trigger region's classes (the element applies them). */
export const contextMenuTriggerClass = (): string => 'select-none';
/** The menu panel's classes (the element applies them). */
export const contextMenuContentClass = (): string =>
'fixed max-h-[--available-height] min-w-[8rem] m-0 rounded-md border bg-popover p-1 text-popover-foreground shadow-md z-50 origin-(--radix-context-menu-content-transform-origin) overflow-x-hidden overflow-y-auto not-open:hidden';
/** A menu item's classes (the element applies them). */
export const contextMenuItemClass = (): string =>
"gap-2 rounded-sm px-2 py-1.5 text-sm focus:bg-accent focus:text-accent-foreground hover:bg-accent hover:text-accent-foreground data-[disabled]:pointer-events-none data-[disabled]:opacity-50 data-[inset]:ps-8 data-[variant=destructive]:text-destructive data-[variant=destructive]:focus:bg-destructive/10 data-[variant=destructive]:focus:text-destructive data-[variant=destructive]:hover:bg-destructive/10 data-[variant=destructive]:hover:text-destructive dark:data-[variant=destructive]:focus:bg-destructive/20 dark:data-[variant=destructive]:hover:bg-destructive/20 [&_svg:not([class*='size-'])]:size-4 group/context-menu-item relative flex cursor-default items-center outline-hidden select-none data-disabled:pointer-events-none data-disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0";
/** A checkbox item's classes (the element applies them). */
export const contextMenuCheckboxItemClass = (): string =>
'gap-2 rounded-sm py-1.5 pe-2 ps-8 text-sm focus:bg-accent focus:text-accent-foreground hover:bg-accent hover:text-accent-foreground data-[disabled]:pointer-events-none data-[disabled]:opacity-50 data-[inset]:ps-8 relative flex cursor-default items-center outline-hidden select-none data-disabled:pointer-events-none data-disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0';
/** A radio item's classes (the element applies them). */
export const contextMenuRadioItemClass = (): string =>
'gap-2 rounded-sm py-1.5 pe-2 ps-8 text-sm focus:bg-accent focus:text-accent-foreground hover:bg-accent hover:text-accent-foreground data-[disabled]:pointer-events-none data-[disabled]:opacity-50 data-[inset]:ps-8 relative flex cursor-default items-center outline-hidden select-none data-disabled:pointer-events-none data-disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0';
/** A group label's classes. */
export const contextMenuLabelClass = (): string =>
'px-2 pt-2 pb-1.5 text-xs font-semibold text-muted-foreground data-[inset]:ps-8';
/** A separator's classes. */
export const contextMenuSeparatorClass = (): string => '-mx-1 my-1 h-px bg-border';
/** A keyboard shortcut hint's classes. */
export const contextMenuShortcutClass = (): string =>
'ms-auto text-xs tracking-widest text-muted-foreground';
/** A sub-menu trigger's classes (the element applies them). */
export const contextMenuSubTriggerClass = (): string =>
"rounded-sm px-2 py-1.5 text-sm focus:bg-accent focus:text-accent-foreground hover:bg-accent hover:text-accent-foreground data-[state=open]:bg-accent data-[state=open]:text-accent-foreground data-[disabled]:pointer-events-none data-[disabled]:opacity-50 data-[inset]:ps-8 [&_svg:not([class*='size-'])]:size-4 [&>svg:last-child]:ms-auto flex cursor-default items-center select-none outline-hidden [&_svg]:pointer-events-none [&_svg]:shrink-0";
/** A sub-menu panel's classes (the element applies them). */
export const contextMenuSubContentClass = (): string =>
'fixed min-w-[8rem] m-0 rounded-md border bg-popover p-1 text-popover-foreground shadow-lg z-50 origin-(--radix-context-menu-content-transform-origin) overflow-hidden not-open:hidden';
const contextMenuItemIndicatorClass = (): string =>
'absolute start-2 flex size-3.5 items-center justify-center pointer-events-none';
// The dropdown elements paint each part through this table, so every part
// carries a cn-context-menu-* name, the one shadcn's styles give it.
const CONTEXT_MENU_CLASSES: MenuClasses = {
content: contextMenuContentClass,
item: contextMenuItemClass,
checkboxItem: contextMenuCheckboxItemClass,
radioItem: contextMenuRadioItemClass,
itemIndicator: contextMenuItemIndicatorClass,
label: contextMenuLabelClass,
separator: contextMenuSeparatorClass,
shortcut: contextMenuShortcutClass,
subTrigger: contextMenuSubTriggerClass,
subContent: contextMenuSubContentClass,
};
const FAMILY = 'ui-context-menu';
export class UiContextMenu extends UiDropdownMenu {
static family = FAMILY;
static classes = CONTEXT_MENU_CLASSES;
// Where the menu opens, and who gets focus back when it closes.
_point: { x: number; y: number } | null = null;
_returnFocus: HTMLElement | null = null;
/** Open the menu with its corner at (x, y), returning focus to `returnTo` on close. */
openAt(x: number, y: number, returnTo: HTMLElement | null): void {
this._point = { x, y };
this._returnFocus = returnTo;
if (this.open) this._reposition();
else this.show();
}
// A context menu has no trigger button to sit against, so it is placed at
// the pointer through a zero-size virtual anchor.
_reposition(): void {
const content = this._content();
if (!content) return;
const p = this._point ?? { x: 0, y: 0 };
const anchor = { getBoundingClientRect: () => new DOMRect(p.x, p.y, 0, 0) } as unknown as HTMLElement;
positionFloating(anchor, content, { side: 'bottom', align: 'start', sideOffset: 0, alignOffset: 0, radix: this.localName.slice(3) });
}
// Every close path returns focus through this: to the element that had focus
// when the menu opened, else the region.
_triggerControl(): HTMLElement | null {
if (this._returnFocus?.isConnected) return this._returnFocus;
return this.querySelector<HTMLElement>(`${FAMILY}-trigger`);
}
// The region is not a button, so it gets no aria-haspopup / aria-expanded.
// The menu still needs a name, and a sub-menu is named by its sub-trigger.
_wireAria(): void {
const menu = this._menuEl();
if (menu && !menu.hasAttribute('aria-label') && !menu.hasAttribute('aria-labelledby')) {
const authored = this.querySelector(`${FAMILY}-content`)?.getAttribute('aria-label');
menu.setAttribute('aria-label', authored || 'Context menu');
}
this._wireSubmenuAria();
}
/** Close, returning focus only when it was in the panel (a click in the region keeps its own focus). */
_dismiss(): void {
const panel = this.querySelector(`${FAMILY}-content`);
const active = typeof document !== 'undefined' ? document.activeElement : null;
if (active && panel?.contains(active)) this._triggerControl()?.focus();
this.hide();
}
// A right-click elsewhere fires no click, so the outside dismiss has to
// happen on its pointerdown, or the menu would stay open beside the native
// one the browser then shows.
_onDocPointerDown(e: Event): void {
super._onDocPointerDown(e);
if (!this.open || (e as PointerEvent).button !== 2) return;
if (e.composedPath().some((n) => n === this)) return;
this._dismiss();
}
}
UiContextMenu.register('ui-context-menu');
export class UiContextMenuTrigger extends UiDropdownMenuTrigger {
static family = FAMILY;
static classes = CONTEXT_MENU_CLASSES;
_authored: string | null = null;
// shadcn's className on ContextMenuTrigger styles the region itself (its
// size, the dashed border), so the class written on this host moves to the
// box it renders and the host becomes `display: contents`. The host's box is
// turned off through its style, which the server serves, so the first paint
// has one region, not a host and a region both carrying the class.
render() {
this._authored = takeAuthoredClass(this, null);
if (!this.getAttribute?.('style')) this.setAttribute?.('style', 'display: contents');
return html`<div
data-slot="context-menu-trigger"
class=${cn(contextMenuTriggerClass(), this._authored)}
@click=${this._onClick}
><slot></slot></div>`;
}
// A left click on the region never opens the menu. It closes an open one,
// as a click anywhere outside the panel does.
_onClick = (): void => {
const root = this._root();
if (root?.open) root._dismiss();
};
connectedCallback(): void {
super.connectedCallback?.();
this.addEventListener('contextmenu', this._onContextMenu);
this.addEventListener('keydown', this._onKeyDown);
}
disconnectedCallback(): void {
this.removeEventListener('contextmenu', this._onContextMenu);
this.removeEventListener('keydown', this._onKeyDown);
super.disconnectedCallback?.();
}
_root(): UiContextMenu | null {
return this.closest(FAMILY) as UiContextMenu | null;
}
// The element focus returns to: what had it, when that is in the region,
// else the region's first focusable.
_returnTarget(): HTMLElement | null {
const active = typeof document !== 'undefined' ? (document.activeElement as HTMLElement | null) : null;
if (active && this.contains(active)) return active;
return this.querySelector<HTMLElement>('[tabindex], button, a[href], input, select, textarea');
}
// Below the focused element's start corner, where a keyboard-opened menu goes.
_openFromFocus(): void {
const returnTo = this._returnTarget();
// The host is display: contents and has no box of its own.
const r = (returnTo ?? this.querySelector<HTMLElement>('[data-slot="context-menu-trigger"]') ?? this).getBoundingClientRect();
this._root()?.openAt(r.left, r.bottom, returnTo);
}
_onContextMenu = (e: MouseEvent): void => {
const root = this._root();
if (!root) return;
e.preventDefault();
// A keyboard-fired contextmenu can report (0, 0) instead of a pointer.
if (e.clientX === 0 && e.clientY === 0) this._openFromFocus();
else root.openAt(e.clientX, e.clientY, this._returnTarget());
};
// The menu key and Shift+F10 are handled here rather than left to the
// contextmenu they fire, which some engines place at (0, 0) and none fire
// for a synthetic key event.
_onKeyDown = (e: KeyboardEvent): void => {
if (!(e.key === 'ContextMenu' || (e.key === 'F10' && e.shiftKey))) return;
e.preventDefault();
this._openFromFocus();
};
}
UiContextMenuTrigger.register('ui-context-menu-trigger');
export class UiContextMenuContent extends UiDropdownMenuContent {
static family = FAMILY;
static classes = CONTEXT_MENU_CLASSES;
}
UiContextMenuContent.register('ui-context-menu-content');
export class UiContextMenuItem extends UiDropdownMenuItem {
static family = FAMILY;
static classes = CONTEXT_MENU_CLASSES;
}
UiContextMenuItem.register('ui-context-menu-item');
export class UiContextMenuLabel extends UiDropdownMenuLabel {
static family = FAMILY;
static classes = CONTEXT_MENU_CLASSES;
}
UiContextMenuLabel.register('ui-context-menu-label');
export class UiContextMenuSeparator extends UiDropdownMenuSeparator {
static family = FAMILY;
static classes = CONTEXT_MENU_CLASSES;
}
UiContextMenuSeparator.register('ui-context-menu-separator');
export class UiContextMenuShortcut extends UiDropdownMenuShortcut {
static family = FAMILY;
static classes = CONTEXT_MENU_CLASSES;
}
UiContextMenuShortcut.register('ui-context-menu-shortcut');
export class UiContextMenuGroup extends UiDropdownMenuGroup {
static family = FAMILY;
static classes = CONTEXT_MENU_CLASSES;
}
UiContextMenuGroup.register('ui-context-menu-group');
export class UiContextMenuSub extends UiDropdownMenuSub {
static family = FAMILY;
static classes = CONTEXT_MENU_CLASSES;
}
UiContextMenuSub.register('ui-context-menu-sub');
export class UiContextMenuSubTrigger extends UiDropdownMenuSubTrigger {
static family = FAMILY;
static classes = CONTEXT_MENU_CLASSES;
}
UiContextMenuSubTrigger.register('ui-context-menu-sub-trigger');
export class UiContextMenuSubContent extends UiDropdownMenuSubContent {
static family = FAMILY;
static classes = CONTEXT_MENU_CLASSES;
}
UiContextMenuSubContent.register('ui-context-menu-sub-content');
Update the import paths to match your project setup.
Usage
The context menu is a set of custom elements. Importing the module registers every ui-context-menu-* tag.
import '#components/ui/context-menu.ts';
<ui-context-menu>
<ui-context-menu-trigger>
<div tabindex="0">Right click here</div>
</ui-context-menu-trigger>
<ui-context-menu-content>
<ui-context-menu-item>Profile</ui-context-menu-item>
<ui-context-menu-item>Billing</ui-context-menu-item>
<ui-context-menu-item>Team</ui-context-menu-item>
<ui-context-menu-item>Subscription</ui-context-menu-item>
</ui-context-menu-content>
</ui-context-menu>
Composition
Use the following composition to build a context menu:
ui-context-menu
├── ui-context-menu-trigger
└── ui-context-menu-content
├── ui-context-menu-group
│ ├── ui-context-menu-label
│ ├── ui-context-menu-item
│ └── ui-context-menu-item
├── ui-context-menu-separator
├── ui-context-menu-group
│ ├── ui-context-menu-label
│ ├── ui-context-menu-item type="checkbox"
│ └── ui-context-menu-item type="checkbox"
├── ui-context-menu-separator
├── ui-context-menu-group
│ ├── ui-context-menu-label
│ ├── ui-context-menu-item type="radio"
│ └── ui-context-menu-item type="radio"
└── ui-context-menu-sub
├── ui-context-menu-sub-trigger
└── ui-context-menu-sub-content
└── ui-context-menu-group
├── ui-context-menu-item
└── ui-context-menu-item
Basic
A simple context menu with a few actions.
import { html } from '@webjsdev/core';
export default function ContextMenuBasic() {
return html`
<ui-context-menu class="w-full max-w-xs">
<ui-context-menu-trigger>
<div tabindex="0" class="flex aspect-video w-full max-w-xs items-center justify-center rounded-xl border border-dashed text-sm">
<span class="hidden pointer-fine:inline-block">Right click here</span>
<span class="hidden pointer-coarse:inline-block">Long press here</span>
</div>
</ui-context-menu-trigger>
<ui-context-menu-content>
<ui-context-menu-group>
<ui-context-menu-item>Back</ui-context-menu-item>
<ui-context-menu-item data-disabled>Forward</ui-context-menu-item>
<ui-context-menu-item>Reload</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-content>
</ui-context-menu>
`;
}
View Code
Submenu
Use <ui-context-menu-sub> to nest secondary actions.
import { html } from '@webjsdev/core';
export default function ContextMenuSubmenu() {
return html`
<ui-context-menu class="w-full max-w-xs">
<ui-context-menu-trigger>
<div tabindex="0" class="flex aspect-video w-full max-w-xs items-center justify-center rounded-xl border border-dashed text-sm">
<span class="hidden pointer-fine:inline-block">Right click here</span>
<span class="hidden pointer-coarse:inline-block">Long press here</span>
</div>
</ui-context-menu-trigger>
<ui-context-menu-content>
<ui-context-menu-group>
<ui-context-menu-item>
Copy
<ui-context-menu-shortcut>⌘C</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item>
Cut
<ui-context-menu-shortcut>⌘X</ui-context-menu-shortcut>
</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-sub>
<ui-context-menu-sub-trigger>More Tools</ui-context-menu-sub-trigger>
<ui-context-menu-sub-content>
<ui-context-menu-group>
<ui-context-menu-item>Save Page...</ui-context-menu-item>
<ui-context-menu-item>Create Shortcut...</ui-context-menu-item>
<ui-context-menu-item>Name Window...</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item>Developer Tools</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item variant="destructive">Delete</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-sub-content>
</ui-context-menu-sub>
</ui-context-menu-content>
</ui-context-menu>
`;
}
View Code
Shortcuts
Add <ui-context-menu-shortcut> to show keyboard hints.
import { html } from '@webjsdev/core';
export default function ContextMenuShortcuts() {
return html`
<ui-context-menu class="w-full max-w-xs">
<ui-context-menu-trigger>
<div tabindex="0" class="flex aspect-video w-full max-w-xs items-center justify-center rounded-xl border border-dashed text-sm">
<span class="hidden pointer-fine:inline-block">Right click here</span>
<span class="hidden pointer-coarse:inline-block">Long press here</span>
</div>
</ui-context-menu-trigger>
<ui-context-menu-content>
<ui-context-menu-group>
<ui-context-menu-item>
Back
<ui-context-menu-shortcut>⌘[</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item data-disabled>
Forward
<ui-context-menu-shortcut>⌘]</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item>
Reload
<ui-context-menu-shortcut>⌘R</ui-context-menu-shortcut>
</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item>
Save
<ui-context-menu-shortcut>⌘S</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item>
Save As...
<ui-context-menu-shortcut>⇧⌘S</ui-context-menu-shortcut>
</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-content>
</ui-context-menu>
`;
}
View Code
Groups
Group related actions and separate them with dividers.
import { html } from '@webjsdev/core';
export default function ContextMenuGroups() {
return html`
<ui-context-menu class="w-full max-w-xs">
<ui-context-menu-trigger>
<div tabindex="0" class="flex aspect-video w-full max-w-xs items-center justify-center rounded-xl border border-dashed text-sm">
<span class="hidden pointer-fine:inline-block">Right click here</span>
<span class="hidden pointer-coarse:inline-block">Long press here</span>
</div>
</ui-context-menu-trigger>
<ui-context-menu-content>
<ui-context-menu-group>
<ui-context-menu-label>File</ui-context-menu-label>
<ui-context-menu-item>
New File
<ui-context-menu-shortcut>⌘N</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item>
Open File
<ui-context-menu-shortcut>⌘O</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item>
Save
<ui-context-menu-shortcut>⌘S</ui-context-menu-shortcut>
</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-label>Edit</ui-context-menu-label>
<ui-context-menu-item>
Undo
<ui-context-menu-shortcut>⌘Z</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item>
Redo
<ui-context-menu-shortcut>⇧⌘Z</ui-context-menu-shortcut>
</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item>
Cut
<ui-context-menu-shortcut>⌘X</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item>
Copy
<ui-context-menu-shortcut>⌘C</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item>
Paste
<ui-context-menu-shortcut>⌘V</ui-context-menu-shortcut>
</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item variant="destructive">
Delete
<ui-context-menu-shortcut>⌫</ui-context-menu-shortcut>
</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-content>
</ui-context-menu>
`;
}
View Code
Icons
Combine icons with labels for quick scanning.
import { html } from '@webjsdev/core';
import {
ClipboardPasteIcon, CopyIcon, ScissorsIcon, TrashIcon,
} from '#lib/ui/lucide.ts';
export default function ContextMenuIcons() {
return html`
<ui-context-menu class="w-full max-w-xs">
<ui-context-menu-trigger>
<div tabindex="0" class="flex aspect-video w-full max-w-xs items-center justify-center rounded-xl border border-dashed text-sm">
<span class="hidden pointer-fine:inline-block">Right click here</span>
<span class="hidden pointer-coarse:inline-block">Long press here</span>
</div>
</ui-context-menu-trigger>
<ui-context-menu-content>
<ui-context-menu-group>
<ui-context-menu-item>
${CopyIcon()}
Copy
</ui-context-menu-item>
<ui-context-menu-item>
${ScissorsIcon()}
Cut
</ui-context-menu-item>
<ui-context-menu-item>
${ClipboardPasteIcon()}
Paste
</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item variant="destructive">
${TrashIcon()}
Delete
</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-content>
</ui-context-menu>
`;
}
View Code
Checkboxes
Use type="checkbox" on an item for toggles. The checked attribute sets its starting state.
import { html } from '@webjsdev/core';
export default function ContextMenuCheckboxes() {
return html`
<ui-context-menu class="w-full max-w-xs">
<ui-context-menu-trigger>
<div tabindex="0" class="flex aspect-video w-full max-w-xs items-center justify-center rounded-xl border border-dashed text-sm">
<span class="hidden pointer-fine:inline-block">Right click here</span>
<span class="hidden pointer-coarse:inline-block">Long press here</span>
</div>
</ui-context-menu-trigger>
<ui-context-menu-content>
<ui-context-menu-group>
<ui-context-menu-item type="checkbox" checked>Show Bookmarks Bar</ui-context-menu-item>
<ui-context-menu-item type="checkbox">Show Full URLs</ui-context-menu-item>
<ui-context-menu-item type="checkbox" checked>Show Developer Tools</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-content>
</ui-context-menu>
`;
}
View Code
Radio
Use type="radio" on an item for exclusive choices. The radio items in one <ui-context-menu-group> form one set, so name the set with aria-label on the group.
import { html } from '@webjsdev/core';
// Each group is one radio set: checking an item unchecks the others in its
// group, so the two groups keep their own choice.
export default function ContextMenuRadio() {
return html`
<ui-context-menu class="w-full max-w-xs">
<ui-context-menu-trigger>
<div tabindex="0" class="flex aspect-video w-full max-w-xs items-center justify-center rounded-xl border border-dashed text-sm">
<span class="hidden pointer-fine:inline-block">Right click here</span>
<span class="hidden pointer-coarse:inline-block">Long press here</span>
</div>
</ui-context-menu-trigger>
<ui-context-menu-content>
<ui-context-menu-group aria-label="People">
<ui-context-menu-label>People</ui-context-menu-label>
<ui-context-menu-item type="radio" value="pedro" checked>Pedro Duarte</ui-context-menu-item>
<ui-context-menu-item type="radio" value="colm">Colm Tuite</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group aria-label="Theme">
<ui-context-menu-label>Theme</ui-context-menu-label>
<ui-context-menu-item type="radio" value="light" checked>Light</ui-context-menu-item>
<ui-context-menu-item type="radio" value="dark">Dark</ui-context-menu-item>
<ui-context-menu-item type="radio" value="system">System</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-content>
</ui-context-menu>
`;
}
View Code
Destructive
Use variant="destructive" to style the menu item as destructive.
import { html } from '@webjsdev/core';
import { PencilIcon, ShareIcon, TrashIcon } from '#lib/ui/lucide.ts';
export default function ContextMenuDestructive() {
return html`
<ui-context-menu class="w-full max-w-xs">
<ui-context-menu-trigger>
<div tabindex="0" class="flex aspect-video w-full max-w-xs items-center justify-center rounded-xl border border-dashed text-sm">
<span class="hidden pointer-fine:inline-block">Right click here</span>
<span class="hidden pointer-coarse:inline-block">Long press here</span>
</div>
</ui-context-menu-trigger>
<ui-context-menu-content>
<ui-context-menu-group>
<ui-context-menu-item>
${PencilIcon()}
Edit
</ui-context-menu-item>
<ui-context-menu-item>
${ShareIcon()}
Share
</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item variant="destructive">
${TrashIcon()}
Delete
</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-content>
</ui-context-menu>
`;
}
View Code
RTL
To enable RTL support, see the RTL configuration guide.
import { html, nothing } from '@webjsdev/core';
import { ArrowLeftIcon, ArrowRightIcon, RotateCwIcon } from '#lib/ui/lucide.ts';
const translations = {
en: {
dir: 'ltr',
values: {
rightClick: 'Right click here',
longPress: 'Long press here',
navigation: 'Navigation',
back: 'Back',
forward: 'Forward',
reload: 'Reload',
moreTools: 'More Tools',
savePage: 'Save Page...',
createShortcut: 'Create Shortcut...',
nameWindow: 'Name Window...',
developerTools: 'Developer Tools',
delete: 'Delete',
showBookmarks: 'Show Bookmarks',
showFullUrls: 'Show Full URLs',
people: 'People',
pedro: 'Pedro Duarte',
colm: 'Colm Tuite',
},
},
ar: {
dir: 'rtl',
values: {
rightClick: 'انقر بزر الماوس الأيمن هنا',
longPress: 'اضغط مطولاً هنا',
navigation: 'التنقل',
back: 'رجوع',
forward: 'تقدم',
reload: 'إعادة تحميل',
moreTools: 'المزيد من الأدوات',
savePage: 'حفظ الصفحة...',
createShortcut: 'إنشاء اختصار...',
nameWindow: 'تسمية النافذة...',
developerTools: 'أدوات المطور',
delete: 'حذف',
showBookmarks: 'إظهار الإشارات المرجعية',
showFullUrls: 'إظهار عناوين URL الكاملة',
people: 'الأشخاص',
pedro: 'Pedro Duarte',
colm: 'Colm Tuite',
},
},
he: {
dir: 'rtl',
values: {
rightClick: 'לחץ לחיצה ימנית כאן',
longPress: 'לחץ לחיצה ארוכה כאן',
navigation: 'ניווט',
back: 'חזור',
forward: 'קדימה',
reload: 'רענן',
moreTools: 'כלים נוספים',
savePage: 'שמור עמוד...',
createShortcut: 'צור קיצור דרך...',
nameWindow: 'שם חלון...',
developerTools: 'כלי מפתח',
delete: 'מחק',
showBookmarks: 'הצג סימניות',
showFullUrls: 'הצג כתובות URL מלאות',
people: 'אנשים',
pedro: 'Pedro Duarte',
colm: 'Colm Tuite',
},
},
};
// The provider is the dir attribute: every part styles itself with logical
// properties, so dir="rtl" on the menu flips its panels.
export default function ContextMenuRtl() {
const lang = 'ar';
const { dir, values: t } = translations[lang];
return html`
<ui-context-menu dir=${dir} class="w-full max-w-xs">
<ui-context-menu-trigger>
<div tabindex="0" class="flex aspect-video w-full max-w-xs items-center justify-center rounded-xl border border-dashed text-sm">
<span class="hidden pointer-fine:inline-block">${t.rightClick}</span>
<span class="hidden pointer-coarse:inline-block">${t.longPress}</span>
</div>
</ui-context-menu-trigger>
<ui-context-menu-content class="w-48" data-lang=${dir === 'rtl' ? lang : nothing}>
<ui-context-menu-group>
<ui-context-menu-sub>
<ui-context-menu-sub-trigger>${t.navigation}</ui-context-menu-sub-trigger>
<ui-context-menu-sub-content class="w-44" data-lang=${dir === 'rtl' ? lang : nothing}>
<ui-context-menu-group>
<ui-context-menu-item>
${ArrowLeftIcon()}
${t.back}
<ui-context-menu-shortcut>⌘[</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item data-disabled>
${ArrowRightIcon()}
${t.forward}
<ui-context-menu-shortcut>⌘]</ui-context-menu-shortcut>
</ui-context-menu-item>
<ui-context-menu-item>
${RotateCwIcon()}
${t.reload}
<ui-context-menu-shortcut>⌘R</ui-context-menu-shortcut>
</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-sub-content>
</ui-context-menu-sub>
<ui-context-menu-sub>
<ui-context-menu-sub-trigger>${t.moreTools}</ui-context-menu-sub-trigger>
<ui-context-menu-sub-content class="w-44" data-lang=${dir === 'rtl' ? lang : nothing}>
<ui-context-menu-group>
<ui-context-menu-item>${t.savePage}</ui-context-menu-item>
<ui-context-menu-item>${t.createShortcut}</ui-context-menu-item>
<ui-context-menu-item>${t.nameWindow}</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item>${t.developerTools}</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item variant="destructive">${t.delete}</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-sub-content>
</ui-context-menu-sub>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group>
<ui-context-menu-item type="checkbox" checked>${t.showBookmarks}</ui-context-menu-item>
<ui-context-menu-item type="checkbox">${t.showFullUrls}</ui-context-menu-item>
</ui-context-menu-group>
<ui-context-menu-separator></ui-context-menu-separator>
<ui-context-menu-group aria-label=${t.people}>
<ui-context-menu-label>${t.people}</ui-context-menu-label>
<ui-context-menu-item type="radio" value="pedro" checked>${t.pedro}</ui-context-menu-item>
<ui-context-menu-item type="radio" value="colm">${t.colm}</ui-context-menu-item>
</ui-context-menu-group>
</ui-context-menu-content>
</ui-context-menu>
`;
}
View Code
API Reference
The context menu is the dropdown menu opened a different way: every part is a dropdown menu element under a ui-context-menu-* tag, with the same attributes, events and keyboard model. See the Dropdown Menu documentation for the shared parts.
ui-context-menu
The root. The menu opens at the pointer on a right-click, and below the focused element on Shift+F10 or the ContextMenu key. A left click never opens it, and a click outside the panel or Escape closes it.
ui-context-menu-trigger
Wraps the region that opens the menu. Make the region focusable (tabindex="0" or a focusable child) so the keyboard can open the menu, and put each command somewhere a keyboard or touch user reaches without a right-click.
ui-context-menu-content
The menu panel, a role="menu" named "Context menu" unless you give it an aria-label. A class written on it lands on the panel.
ui-context-menu-item
Activating an item dispatches a cancelable ui-item-select event with { detail: { value, item, type, checked } }. Calling preventDefault() keeps the menu open.