snapshot of https://github.com/shadcn-ui/ui.git (main, 2026-09-15; blobs > 131072B omitted)
This commit is contained in:
173
apps/v4/content/docs/components/radix/context-menu.mdx
Normal file
173
apps/v4/content/docs/components/radix/context-menu.mdx
Normal file
@@ -0,0 +1,173 @@
|
||||
---
|
||||
title: Context Menu
|
||||
description: Displays a menu of actions triggered by a right click.
|
||||
base: radix
|
||||
component: true
|
||||
links:
|
||||
doc: https://www.radix-ui.com/docs/primitives/components/context-menu
|
||||
api: https://www.radix-ui.com/docs/primitives/components/context-menu#api-reference
|
||||
---
|
||||
|
||||
<ComponentPreview
|
||||
styleName="radix-nova"
|
||||
name="context-menu-demo"
|
||||
description="A context menu with sub menu items."
|
||||
/>
|
||||
|
||||
## Installation
|
||||
|
||||
<CodeTabs>
|
||||
|
||||
<TabsList>
|
||||
<TabsTrigger value="cli">Command</TabsTrigger>
|
||||
<TabsTrigger value="manual">Manual</TabsTrigger>
|
||||
</TabsList>
|
||||
<TabsContent value="cli">
|
||||
|
||||
```bash
|
||||
npx shadcn@latest add context-menu
|
||||
```
|
||||
|
||||
</TabsContent>
|
||||
|
||||
<TabsContent value="manual">
|
||||
|
||||
<Steps className="mb-0 pt-2">
|
||||
|
||||
<Step>Install the following dependencies:</Step>
|
||||
|
||||
```bash
|
||||
npm install radix-ui
|
||||
```
|
||||
|
||||
<Step>Copy and paste the following code into your project.</Step>
|
||||
|
||||
<ComponentSource
|
||||
name="context-menu"
|
||||
title="components/ui/context-menu.tsx"
|
||||
styleName="radix-nova"
|
||||
/>
|
||||
|
||||
<Step>Update the import paths to match your project setup.</Step>
|
||||
|
||||
</Steps>
|
||||
|
||||
</TabsContent>
|
||||
|
||||
</CodeTabs>
|
||||
|
||||
## Usage
|
||||
|
||||
```tsx showLineNumbers
|
||||
import {
|
||||
ContextMenu,
|
||||
ContextMenuContent,
|
||||
ContextMenuItem,
|
||||
ContextMenuTrigger,
|
||||
} from "@/components/ui/context-menu"
|
||||
```
|
||||
|
||||
```tsx showLineNumbers
|
||||
<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`:
|
||||
|
||||
```text
|
||||
ContextMenu
|
||||
├── ContextMenuTrigger
|
||||
└── ContextMenuContent
|
||||
├── ContextMenuGroup
|
||||
│ ├── ContextMenuLabel
|
||||
│ ├── ContextMenuItem
|
||||
│ └── ContextMenuItem
|
||||
├── ContextMenuSeparator
|
||||
├── ContextMenuGroup
|
||||
│ ├── ContextMenuLabel
|
||||
│ ├── ContextMenuCheckboxItem
|
||||
│ └── ContextMenuCheckboxItem
|
||||
├── ContextMenuSeparator
|
||||
├── ContextMenuGroup
|
||||
│ ├── ContextMenuLabel
|
||||
│ └── ContextMenuRadioGroup
|
||||
│ ├── ContextMenuRadioItem
|
||||
│ └── ContextMenuRadioItem
|
||||
└── ContextMenuSub
|
||||
├── ContextMenuSubTrigger
|
||||
└── ContextMenuSubContent
|
||||
└── ContextMenuGroup
|
||||
├── ContextMenuItem
|
||||
└── ContextMenuItem
|
||||
```
|
||||
|
||||
## Basic
|
||||
|
||||
A simple context menu with a few actions.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="context-menu-basic" />
|
||||
|
||||
## Submenu
|
||||
|
||||
Use `ContextMenuSub` to nest secondary actions.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="context-menu-submenu" />
|
||||
|
||||
## Shortcuts
|
||||
|
||||
Add `ContextMenuShortcut` to show keyboard hints.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="context-menu-shortcuts" />
|
||||
|
||||
## Groups
|
||||
|
||||
Group related actions and separate them with dividers.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="context-menu-groups" />
|
||||
|
||||
## Icons
|
||||
|
||||
Combine icons with labels for quick scanning.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="context-menu-icons" />
|
||||
|
||||
## Checkboxes
|
||||
|
||||
Use `ContextMenuCheckboxItem` for toggles.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="context-menu-checkboxes" />
|
||||
|
||||
## Radio
|
||||
|
||||
Use `ContextMenuRadioItem` for exclusive choices.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="context-menu-radio" />
|
||||
|
||||
## Destructive
|
||||
|
||||
Use `variant="destructive"` to style the menu item as destructive.
|
||||
|
||||
<ComponentPreview styleName="radix-nova" name="context-menu-destructive" />
|
||||
|
||||
## RTL
|
||||
|
||||
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
||||
|
||||
<ComponentPreview
|
||||
styleName="radix-nova"
|
||||
name="context-menu-rtl"
|
||||
direction="rtl"
|
||||
/>
|
||||
|
||||
## API Reference
|
||||
|
||||
See the [Radix UI](https://www.radix-ui.com/docs/primitives/components/context-menu#api-reference) documentation for more information.
|
||||
Reference in New Issue
Block a user