Context Menu

A menu that opens on right click or long press.

Right-click hereor long-press on touch devices

import { CopyIcon, FolderIcon, ScissorsIcon, Trash2Icon } from "lucide-react";

import {
  ContextMenu,
  ContextMenuContent,
  ContextMenuItem,
  ContextMenuSeparator,
  ContextMenuShortcut,
  ContextMenuTrigger,
} from "@/components/ui/context-menu";

export default function ContextMenuBasic() {
  return (
    <ContextMenu>
      <ContextMenuTrigger className="flex h-40 w-full max-w-sm flex-col items-center justify-center gap-1 rounded-md border border-dashed border-border-strong text-center text-sm text-muted-foreground">
        <span>Right-click here</span>
        <span className="text-xs text-faint">or long-press on touch devices</span>
      </ContextMenuTrigger>
      <ContextMenuContent className="w-56">
        <ContextMenuItem>
          <FolderIcon />
          Open
          <ContextMenuShortcut>⌘O</ContextMenuShortcut>
        </ContextMenuItem>
        <ContextMenuItem>
          <ScissorsIcon />
          Cut
          <ContextMenuShortcut>⌘X</ContextMenuShortcut>
        </ContextMenuItem>
        <ContextMenuItem>
          <CopyIcon />
          Copy
          <ContextMenuShortcut>⌘C</ContextMenuShortcut>
        </ContextMenuItem>
        <ContextMenuSeparator />
        <ContextMenuItem variant="destructive">
          <Trash2Icon />
          Move to trash
          <ContextMenuShortcut>⌘⌫</ContextMenuShortcut>
        </ContextMenuItem>
      </ContextMenuContent>
    </ContextMenu>
  );
}

Installation

Add the registryOnce per project
pnpm dlx shadcn@latest registry add @jarvis=https://ui.jarv.is/r/{name}.json
Add context-menu
pnpm dlx shadcn@latest add @jarvis/context-menu

Usage

import {
  ContextMenu,
  ContextMenuContent,
  ContextMenuItem,
  ContextMenuSeparator,
  ContextMenuShortcut,
  ContextMenuTrigger,
} from "@/components/ui/context-menu";

export function FileContextMenu() {
  return (
    <ContextMenu>
      <ContextMenuTrigger className="rounded-md border p-6">homepage-v2.fig</ContextMenuTrigger>
      <ContextMenuContent>
        <ContextMenuItem>
          Open
          <ContextMenuShortcut>⌘O</ContextMenuShortcut>
        </ContextMenuItem>
        <ContextMenuItem>Rename</ContextMenuItem>
        <ContextMenuSeparator />
        <ContextMenuItem variant="destructive">Move to trash</ContextMenuItem>
      </ContextMenuContent>
    </ContextMenu>
  );
}

ContextMenuTrigger wraps the area that opens the menu. Items work like those in a Dropdown Menu.

People won't always think to right-click, so make these actions available somewhere else too.

Composition

ContextMenu
- ContextMenuTrigger
- ContextMenuContent

Examples

Submenus

Nest a menu with ContextMenuSub, ContextMenuSubTrigger and ContextMenuSubContent.

Right-click here

import { FileTextIcon, FolderIcon, ImageIcon, PlusIcon } from "lucide-react";

import {
  ContextMenu,
  ContextMenuContent,
  ContextMenuItem,
  ContextMenuSub,
  ContextMenuSubContent,
  ContextMenuSubTrigger,
  ContextMenuTrigger,
} from "@/components/ui/context-menu";

export default function ContextMenuSubmenu() {
  return (
    <ContextMenu>
      <ContextMenuTrigger className="flex h-40 w-full max-w-sm items-center justify-center rounded-md border border-dashed border-border-strong text-sm text-muted-foreground">
        Right-click here
      </ContextMenuTrigger>
      <ContextMenuContent className="w-56">
        <ContextMenuSub>
          <ContextMenuSubTrigger>
            <PlusIcon />
            New
          </ContextMenuSubTrigger>
          <ContextMenuSubContent className="w-44">
            <ContextMenuItem>
              <FolderIcon />
              Folder
            </ContextMenuItem>
            <ContextMenuItem>
              <FileTextIcon />
              Document
            </ContextMenuItem>
            <ContextMenuItem>
              <ImageIcon />
              Image
            </ContextMenuItem>
          </ContextMenuSubContent>
        </ContextMenuSub>
        <ContextMenuItem>Refresh</ContextMenuItem>
      </ContextMenuContent>
    </ContextMenu>
  );
}

Checkbox and radio items

Use ContextMenuCheckboxItem for toggles, and ContextMenuRadioItems inside a ContextMenuRadioGroup to pick one of several options.

Right-click here

import * as React from "react";

import {
  ContextMenu,
  ContextMenuCheckboxItem,
  ContextMenuContent,
  ContextMenuGroup,
  ContextMenuLabel,
  ContextMenuRadioGroup,
  ContextMenuRadioItem,
  ContextMenuSeparator,
  ContextMenuTrigger,
} from "@/components/ui/context-menu";

export default function ContextMenuCheckboxAndRadioItems() {
  const [showHidden, setShowHidden] = React.useState(false);
  const [showPreview, setShowPreview] = React.useState(true);
  const [sort, setSort] = React.useState("name");
  return (
    <ContextMenu>
      <ContextMenuTrigger className="flex h-40 w-full max-w-sm items-center justify-center rounded-md border border-dashed border-border-strong text-sm text-muted-foreground">
        Right-click here
      </ContextMenuTrigger>
      <ContextMenuContent className="w-56">
        <ContextMenuCheckboxItem checked={showHidden} onCheckedChange={setShowHidden}>
          Show hidden files
        </ContextMenuCheckboxItem>
        <ContextMenuCheckboxItem checked={showPreview} onCheckedChange={setShowPreview}>
          Show preview
        </ContextMenuCheckboxItem>
        <ContextMenuSeparator />
        <ContextMenuGroup>
          <ContextMenuLabel>Sort by</ContextMenuLabel>
          <ContextMenuRadioGroup value={sort} onValueChange={setSort}>
            <ContextMenuRadioItem value="name">Name</ContextMenuRadioItem>
            <ContextMenuRadioItem value="modified">Date modified</ContextMenuRadioItem>
            <ContextMenuRadioItem value="size">Size</ContextMenuRadioItem>
          </ContextMenuRadioGroup>
        </ContextMenuGroup>
      </ContextMenuContent>
    </ContextMenu>
  );
}

Props

Items, labels and submenu triggers take inset to line up with items that have an icon.

Part	Extends
ContextMenu	Base UI's ContextMenu.Root
ContextMenuPortal	Base UI's ContextMenu.Portal
ContextMenuTrigger	Base UI's ContextMenu.Trigger
ContextMenuContent	Base UI's ContextMenu.Popup
ContextMenuGroup	Base UI's ContextMenu.Group
ContextMenuLabel	Base UI's ContextMenu.GroupLabel
ContextMenuItem	Base UI's ContextMenu.Item
ContextMenuSub	Base UI's ContextMenu.SubmenuRoot
ContextMenuSubTrigger	Base UI's ContextMenu.SubmenuTrigger
ContextMenuSubContent	ContextMenuContent
ContextMenuCheckboxItem	Base UI's ContextMenu.CheckboxItem
ContextMenuRadioGroup	Base UI's ContextMenu.RadioGroup
ContextMenuRadioItem	Base UI's ContextMenu.RadioItem
ContextMenuSeparator	Base UI's ContextMenu.Separator
ContextMenuShortcut	<span>

The tables leave out className, style and render. Parts built on Base UI take them as its styling and composition guides describe.

ContextMenu

Prop	Type	Default
`onOpenChange` Event handler called when the menu is opened or closed.	`((open: boolean, eventDetails: ContextMenu.Root.ChangeEventDetails) => void)`	—
`closeParentOnEsc`	`boolean`	—
`children`	`React.ReactNode`	—
`defaultOpen` Whether the menu is initially open. To render a controlled menu, use the `open` prop instead.	`boolean`	`false`
`loopFocus` Whether to loop keyboard focus back to the first item when the end of the list is reached while using the arrow keys.	`boolean`	`true`
`highlightItemOnHover` Whether moving the pointer over items should highlight them. Disabling this prop allows CSS `:hover` to be differentiated from the `:focus` (`data-highlighted`) state.	`boolean`	`true`
`onOpenChangeComplete` Event handler called after any animations complete when the menu is opened or closed.	`((open: boolean) => void)`	—
`onItemHighlighted` Callback fired when an item is highlighted or unhighlighted. Receives the highlighted item element (or `undefined` if no item is highlighted) and details containing the reason for the change, the event, and the item's text label. The `reason` can be: `'keyboard'`: the highlight changed due to keyboard navigation. `'pointer'`: the highlight changed due to pointer hovering. The event may be a `MouseEvent` rather than a `PointerEvent`. `'none'`: the highlight changed for another reason, such as automatic highlighting while filtering, the item list changing, or the popup opening or closing.	`((highlightedItem: HTMLElement \| undefined, eventDetails: MenuRoot.HighlightEventDetails) => void)`	—
`open` Whether the menu is currently open.	`boolean`	—
`orientation` The visual orientation of the menu. Controls whether roving focus uses up/down or left/right arrow keys.	`"horizontal" \| "vertical"`	`'vertical'`
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`
`actionsRef` A ref to imperative actions. `unmount`: Ends the closing phase of the menu after an externally controlled closing animation finishes. Call `preventUnmountOnClose()` in `onOpenChange` first, otherwise the menu completes closing on its own. Whether it leaves the DOM is decided by `keepMounted` on the portal. `close`: Closes the menu imperatively when called.	`React.RefObject<MenuRootActions \| null>`	—

ContextMenuPortal

Prop	Type	Default
`keepMounted` Whether to keep the portal mounted in the DOM while the popup is hidden.	`boolean`	`false`
`container` A parent element to render the portal element into.	`HTMLElement \| React.RefObject<HTMLElement \| ShadowRoot \| null> \| ShadowRoot \| null`	—

ContextMenuContent

Prop	Type	Default
`children`	`React.ReactNode`	—
`id`	`string`	—
`finalFocus` Determines the element to focus when the menu is closed. `false`: Do not move focus. `true`: Move focus based on the default behavior (trigger or previously focused element). `RefObject`: Move focus to the ref element. `function`: Called with the interaction type (`mouse`, `touch`, `pen`, or `keyboard`). Return an element to focus, `true` to use the default behavior, or `false`/`undefined` to do nothing.	`boolean \| React.RefObject<HTMLElement \| null> \| ((closeType: InteractionType) => boolean \| HTMLElement \| null \| void)`	—
`side` Which side of the anchor element to align the popup against. May automatically change to avoid collisions. Submenus default to `'inline-end'`.	`"bottom" \| "inline-end" \| "inline-start" \| "left" \| "right" \| "top"`	`"right"`
`sideOffset` Distance between the anchor and the popup in pixels. Also accepts a function that returns the distance to read the dimensions of the anchor and positioner elements, along with its side and alignment. The function takes a `data` object parameter with the following properties: `data.anchor`: the dimensions of the anchor element with properties `width` and `height`. `data.positioner`: the dimensions of the positioner element with properties `width` and `height`. `data.side`: which side of the anchor element the positioner is aligned against. `data.align`: how the positioner is aligned relative to the specified side. Defaults to `-5` for root context menus when `side` is not specified and `align` is not `'center'`. Otherwise, it defaults to `0`.	`number \| OffsetFunction`	`0`
`align` How to align the popup relative to the specified side.	`"center" \| "end" \| "start"`	`"start"`
`alignOffset` Additional offset along the alignment axis in pixels. Also accepts a function that returns the offset to read the dimensions of the anchor and positioner elements, along with its side and alignment. The function takes a `data` object parameter with the following properties: `data.anchor`: the dimensions of the anchor element with properties `width` and `height`. `data.positioner`: the dimensions of the positioner element with properties `width` and `height`. `data.side`: which side of the anchor element the positioner is aligned against. `data.align`: how the positioner is aligned relative to the specified side. Defaults to `2` for root context menus when `side` is not specified and `align` is not `'center'`. Otherwise, it defaults to `0`.	`number \| OffsetFunction`	`4`

ContextMenuGroup

ContextMenuLabel

Prop	Type	Default
`inset`	`boolean`	—

ContextMenuItem

Prop	Type	Default
`onClick` The click handler for the menu item.	`((event: BaseUIEvent<React.MouseEvent<HTMLDivElement, MouseEvent>>) => void)`	—
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`
`label` Overrides the text used for keyboard text navigation and filtering. Falls back to the rendered text when not provided.	`string`	—
`id`	`string`	—
`closeOnClick` Whether to close the menu when the item is clicked.	`boolean`	`true`
`nativeButton` Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `true` if the rendered element is a native button.	`boolean`	`false`
`inset`	`boolean`	—
`variant`	`"default" \| "destructive"`	`"default"`

ContextMenuSub

Prop	Type	Default
`onOpenChange` Event handler called when the menu is opened or closed.	`((open: boolean, eventDetails: ContextMenu.SubmenuRoot.ChangeEventDetails) => void)`	—
`closeParentOnEsc` When in a submenu, determines whether pressing the Escape key closes the entire menu, or only the current child menu.	`boolean`	`false`
`children` The content of the submenu.	`React.ReactNode`	—
`defaultOpen` Whether the menu is initially open. To render a controlled menu, use the `open` prop instead.	`boolean`	`false`
`loopFocus` Whether to loop keyboard focus back to the first item when the end of the list is reached while using the arrow keys.	`boolean`	`true`
`highlightItemOnHover` Whether moving the pointer over items should highlight them. Disabling this prop allows CSS `:hover` to be differentiated from the `:focus` (`data-highlighted`) state.	`boolean`	`true`
`onOpenChangeComplete` Event handler called after any animations complete when the menu is opened or closed.	`((open: boolean) => void)`	—
`onItemHighlighted` Callback fired when an item is highlighted or unhighlighted. Receives the highlighted item element (or `undefined` if no item is highlighted) and details containing the reason for the change, the event, and the item's text label. The `reason` can be: `'keyboard'`: the highlight changed due to keyboard navigation. `'pointer'`: the highlight changed due to pointer hovering. The event may be a `MouseEvent` rather than a `PointerEvent`. `'none'`: the highlight changed for another reason, such as automatic highlighting while filtering, the item list changing, or the popup opening or closing.	`((highlightedItem: HTMLElement \| undefined, eventDetails: MenuRoot.HighlightEventDetails) => void)`	—
`open` Whether the menu is currently open.	`boolean`	—
`orientation` The visual orientation of the menu. Controls whether roving focus uses up/down or left/right arrow keys.	`"horizontal" \| "vertical"`	`'vertical'`
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`
`actionsRef` A ref to imperative actions. `unmount`: Ends the closing phase of the menu after an externally controlled closing animation finishes. Call `preventUnmountOnClose()` in `onOpenChange` first, otherwise the menu completes closing on its own. Whether it leaves the DOM is decided by `keepMounted` on the portal. `close`: Closes the menu imperatively when called.	`React.RefObject<MenuRootActions \| null>`	—

ContextMenuSubTrigger

Prop	Type	Default
`onClick`	`((event: BaseUIEvent<React.MouseEvent<HTMLDivElement, MouseEvent>>) => void)`	—
`label` Overrides the text used for keyboard text navigation and filtering. Falls back to the rendered text when not provided.	`string`	—
`id`	`string`	—
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`
`delay` How long to wait before the menu may be opened on hover. Specified in milliseconds. Requires the `openOnHover` prop.	`number`	`100`
`closeDelay` How long to wait before closing the menu that was opened on hover. Specified in milliseconds. Requires the `openOnHover` prop.	`number`	`0`
`openOnHover` Whether the menu should also open when the trigger is hovered.	`boolean`	`true`
`nativeButton` Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `true` if the rendered element is a native button.	`boolean`	`false`
`inset`	`boolean`	—

ContextMenuSubContent

Prop	Type	Default
`children`	`React.ReactNode`	—
`id`	`string`	—
`finalFocus` Determines the element to focus when the menu is closed. `false`: Do not move focus. `true`: Move focus based on the default behavior (trigger or previously focused element). `RefObject`: Move focus to the ref element. `function`: Called with the interaction type (`mouse`, `touch`, `pen`, or `keyboard`). Return an element to focus, `true` to use the default behavior, or `false`/`undefined` to do nothing.	`boolean \| React.RefObject<HTMLElement \| null> \| ((closeType: InteractionType) => boolean \| HTMLElement \| null \| void)`	—
`side` Which side of the anchor element to align the popup against. May automatically change to avoid collisions. Submenus default to `'inline-end'`.	`"bottom" \| "inline-end" \| "inline-start" \| "left" \| "right" \| "top"`	`"right"`
`sideOffset` Distance between the anchor and the popup in pixels. Also accepts a function that returns the distance to read the dimensions of the anchor and positioner elements, along with its side and alignment. The function takes a `data` object parameter with the following properties: `data.anchor`: the dimensions of the anchor element with properties `width` and `height`. `data.positioner`: the dimensions of the positioner element with properties `width` and `height`. `data.side`: which side of the anchor element the positioner is aligned against. `data.align`: how the positioner is aligned relative to the specified side. Defaults to `-5` for root context menus when `side` is not specified and `align` is not `'center'`. Otherwise, it defaults to `0`.	`number \| OffsetFunction`	`2`
`align` How to align the popup relative to the specified side.	`"center" \| "end" \| "start"`	`"start"`
`alignOffset` Additional offset along the alignment axis in pixels. Also accepts a function that returns the offset to read the dimensions of the anchor and positioner elements, along with its side and alignment. The function takes a `data` object parameter with the following properties: `data.anchor`: the dimensions of the anchor element with properties `width` and `height`. `data.positioner`: the dimensions of the positioner element with properties `width` and `height`. `data.side`: which side of the anchor element the positioner is aligned against. `data.align`: how the positioner is aligned relative to the specified side. Defaults to `2` for root context menus when `side` is not specified and `align` is not `'center'`. Otherwise, it defaults to `0`.	`number \| OffsetFunction`	`-2`

ContextMenuCheckboxItem

Prop	Type	Default
`checked` Whether the checkbox item is currently ticked. To render an uncontrolled checkbox item, use the `defaultChecked` prop instead.	`boolean`	—
`defaultChecked` Whether the checkbox item is initially ticked. To render a controlled checkbox item, use the `checked` prop instead.	`boolean`	`false`
`onCheckedChange` Event handler called when the checkbox item is ticked or unticked.	`((checked: boolean, eventDetails: ContextMenu.CheckboxItem.ChangeEventDetails) => void)`	—
`onClick` The click handler for the menu item.	`((event: BaseUIEvent<React.MouseEvent<HTMLDivElement, MouseEvent>>) => void)`	—
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`
`label` Overrides the text used for keyboard text navigation and filtering. Falls back to the rendered text when not provided.	`string`	—
`id`	`string`	—
`closeOnClick` Whether to close the menu when the item is clicked.	`boolean`	`false`
`nativeButton` Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `true` if the rendered element is a native button.	`boolean`	`false`
`inset`	`boolean`	—

ContextMenuRadioGroup

Prop	Type	Default
`children` The content of the component.	`React.ReactNode`	—
`value` The controlled value of the radio item that should be currently selected. To render an uncontrolled radio group, use the `defaultValue` prop instead.	`any`	—
`defaultValue` The uncontrolled value of the radio item that should be initially selected. To render a controlled radio group, use the `value` prop instead.	`any`	—
`onValueChange` Function called when the selected value changes.	`((value: any, eventDetails: ContextMenu.RadioGroup.ChangeEventDetails) => void)`	—
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`

ContextMenuRadioItem

Prop	Type	Default
`value` Value of the radio item. This is the value that will be set in the MenuRadioGroup when the item is selected.	`any`	—
`onClick` The click handler for the menu item.	`((event: BaseUIEvent<React.MouseEvent<HTMLDivElement, MouseEvent>>) => void)`	—
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`
`label` Overrides the text used for keyboard text navigation and filtering. Falls back to the rendered text when not provided.	`string`	—
`id`	`string`	—
`closeOnClick` Whether to close the menu when the item is clicked.	`boolean`	`false`
`nativeButton` Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `true` if the rendered element is a native button.	`boolean`	`false`
`inset`	`boolean`	—