mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-22 20:25:44 +00:00
38de7fddc2
* feat: rtl * feat * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * feat: add sidebar * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * chore: changeset * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix
165 lines
3.5 KiB
Plaintext
165 lines
3.5 KiB
Plaintext
---
|
|
title: Context Menu
|
|
description: Displays a menu of actions triggered by a right click.
|
|
base: base
|
|
component: true
|
|
links:
|
|
doc: https://base-ui.com/react/components/context-menu
|
|
api: https://base-ui.com/react/components/context-menu#api-reference
|
|
---
|
|
|
|
<ComponentPreview
|
|
styleName="base-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 @base-ui/react
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="context-menu"
|
|
title="components/ui/context-menu.tsx"
|
|
styleName="base-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>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Basic
|
|
|
|
A simple context menu with a few actions.
|
|
|
|
<ComponentPreview styleName="base-nova" name="context-menu-basic" />
|
|
|
|
### Submenu
|
|
|
|
Use `ContextMenuSub` to nest secondary actions.
|
|
|
|
<ComponentPreview styleName="base-nova" name="context-menu-submenu" />
|
|
|
|
### Shortcuts
|
|
|
|
Add `ContextMenuShortcut` to show keyboard hints.
|
|
|
|
<ComponentPreview styleName="base-nova" name="context-menu-shortcuts" />
|
|
|
|
### Groups
|
|
|
|
Group related actions and separate them with dividers.
|
|
|
|
<ComponentPreview styleName="base-nova" name="context-menu-groups" />
|
|
|
|
### Icons
|
|
|
|
Combine icons with labels for quick scanning.
|
|
|
|
<ComponentPreview styleName="base-nova" name="context-menu-icons" />
|
|
|
|
### Checkboxes
|
|
|
|
Use `ContextMenuCheckboxItem` for toggles.
|
|
|
|
<ComponentPreview styleName="base-nova" name="context-menu-checkboxes" />
|
|
|
|
### Radio
|
|
|
|
Use `ContextMenuRadioItem` for exclusive choices.
|
|
|
|
<ComponentPreview styleName="base-nova" name="context-menu-radio" />
|
|
|
|
### Destructive
|
|
|
|
Use `variant="destructive"` to style the menu item as destructive.
|
|
|
|
<ComponentPreview styleName="base-nova" name="context-menu-destructive" />
|
|
|
|
### Sides
|
|
|
|
Control submenu placement with side and align props.
|
|
|
|
<ComponentPreview styleName="base-nova" name="context-menu-sides" />
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="context-menu-rtl"
|
|
direction="rtl"
|
|
/>
|
|
|
|
Use `side="inline-end"` to place the menu on the logical right side of the trigger.
|
|
|
|
```tsx showLineNumbers
|
|
<ContextMenu>
|
|
<ContextMenuTrigger>Right click here</ContextMenuTrigger>
|
|
<ContextMenuContent side="inline-end">
|
|
<ContextMenuItem>Profile</ContextMenuItem>
|
|
<ContextMenuItem>Billing</ContextMenuItem>
|
|
<ContextMenuItem>Team</ContextMenuItem>
|
|
<ContextMenuItem>Subscription</ContextMenuItem>
|
|
</ContextMenuContent>
|
|
</ContextMenu>
|
|
```
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI](https://base-ui.com/react/components/context-menu#api-reference) documentation for more information.
|