mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-26 22:26:05 +00:00
47c47eaed2
* feat: add base and radix docs * feat: transform code for display * fix * fix * fix * fix * fix * chore: remove claude files * fix * fix * fix * chore: run format:write * fix * feat: add more examples * fix * feat: add aspect-ratio * feat: add avatar * feat: add badge * feat: add breadcrumb * fix * feat: add button * fix * fix * fix * feat: add calendar and card * feat: add carousel * fix: chart * feat: add checkbox * feat: add collapsible * feat: add combobox * feat: add command * feat: add context menu * feat: add data-table dialog and drawer * feat: dropdown-menu * feat: add date-picker * feat: add empty * feat: add field and hover-card * fix: input * feat: add input * feat: add input-group * feat: add input-otp * feat: add item * feat: add kbd and label * feat: add menubar * feat: add native-select * feat: add more components * feat: more components * feat: more components * feat: add skeleton, slider and sonner * feat: add spinner and switch * feat: add more components * fix: tabs * fix: tabs * feat: add docs for sidebar * fix * fix * fi * docs: update * fix: create page * fix * fix * chore: add changelog * fix
141 lines
2.9 KiB
Plaintext
141 lines
2.9 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" />
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI](https://base-ui.com/react/components/context-menu#api-reference) documentation for more information.
|