0

Context Menu

PreviousNext

Displays a menu of actions triggered by a right click.

import {
  ContextMenu,
  ContextMenuCheckboxItem,

Installation

bunx --bun shadcn@latest add @ondo-ui/context-menu

Usage

import {
  ContextMenu,
  ContextMenuContent,
  ContextMenuItem,
  ContextMenuTrigger,
} from "@/components/ui/context-menu"
<ContextMenu>
  <ContextMenuTrigger>Right click here</ContextMenuTrigger>
  <ContextMenuContent>
    <ContextMenuItem>Profile</ContextMenuItem>
    <ContextMenuItem>Billing</ContextMenuItem>
    <ContextMenuItem>Team</ContextMenuItem>
    <ContextMenuItem>Subscription</ContextMenuItem>
  </ContextMenuContent>
</ContextMenu>

Composition

Use the following composition to build a ContextMenu:

ContextMenu
├── ContextMenuTrigger
└── ContextMenuContent
    ├── ContextMenuGroup
    │   ├── ContextMenuLabel
    │   ├── ContextMenuItem
    │   └── ContextMenuItem
    ├── ContextMenuSeparator
    ├── ContextMenuGroup
    │   ├── ContextMenuLabel
    │   ├── ContextMenuCheckboxItem
    │   └── ContextMenuCheckboxItem
    ├── ContextMenuSeparator
    ├── ContextMenuGroup
    │   ├── ContextMenuLabel
    │   └── ContextMenuRadioGroup
    │       ├── ContextMenuRadioItem
    │       └── ContextMenuRadioItem
    └── ContextMenuSub
        ├── ContextMenuSubTrigger
        └── ContextMenuSubContent
            └── ContextMenuGroup
                ├── ContextMenuItem
                └── ContextMenuItem

Examples

Basic

A simple context menu with a few actions.

import {
  ContextMenu,
  ContextMenuContent,

Use ContextMenuSub to nest secondary actions.

import {
  ContextMenu,
  ContextMenuContent,

Shortcuts

Add ContextMenuShortcut to show keyboard hints.

import {
  ContextMenu,
  ContextMenuContent,

Groups

Group related actions and separate them with dividers.

import {
  ContextMenu,
  ContextMenuContent,

Icons

Combine icons with labels for quick scanning.

import {
  IconClipboardCopy,
  IconCopy,

Checkboxes

Use ContextMenuCheckboxItem for toggles.

import {
  ContextMenu,
  ContextMenuCheckboxItem,

Radio

Use ContextMenuRadioItem for exclusive choices.

"use client"

import * as React from "react"

Destructive

Use variant="destructive" to style the menu item as destructive.

import { IconPencil, IconShare, IconTrash } from "@tabler/icons-react"

import {

Sides

Control submenu placement with side and align props.

import {
  ContextMenu,
  ContextMenuContent,

API reference

The component wraps Base UI Context Menu and accepts all of its props.