mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-24 21:25:55 +00:00
81 lines
1.6 KiB
Plaintext
81 lines
1.6 KiB
Plaintext
---
|
|
title: Context Menu
|
|
description: Displays a menu to the user — such as a set of actions or functions — triggered by a button.
|
|
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</ContextMenuTrigger>
|
|
<ContextMenuContent>
|
|
<ContextMenuItem>Profile</ContextMenuItem>
|
|
<ContextMenuItem>Billing</ContextMenuItem>
|
|
<ContextMenuItem>Team</ContextMenuItem>
|
|
<ContextMenuItem>Subscription</ContextMenuItem>
|
|
</ContextMenuContent>
|
|
</ContextMenu>
|
|
```
|