mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-25 05:35:48 +00:00
74c4c7508b
* docs: review all docs * fix Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * docs(spinner): reintroduce data-icon attribute guidance in radix spinner docs (#10059) * Initial plan * docs: add data-icon attribute instructions to radix/spinner.mdx button and badge sections Co-authored-by: shadcn <124599+shadcn@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: shadcn <124599+shadcn@users.noreply.github.com> --------- Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
176 lines
3.7 KiB
Plaintext
176 lines
3.7 KiB
Plaintext
---
|
|
title: Dropdown Menu
|
|
description: Displays a menu to the user — such as a set of actions or functions — triggered by a button.
|
|
featured: true
|
|
base: base
|
|
component: true
|
|
links:
|
|
doc: https://base-ui.com/react/components/menu
|
|
api: https://base-ui.com/react/components/menu#api-reference
|
|
---
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="dropdown-menu-demo"
|
|
description="A dropdown menu with icons, shortcuts and 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 dropdown-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="dropdown-menu"
|
|
title="components/ui/dropdown-menu.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import { Button } from "@/components/ui/button"
|
|
import {
|
|
DropdownMenu,
|
|
DropdownMenuContent,
|
|
DropdownMenuGroup,
|
|
DropdownMenuItem,
|
|
DropdownMenuLabel,
|
|
DropdownMenuSeparator,
|
|
DropdownMenuTrigger,
|
|
} from "@/components/ui/dropdown-menu"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<DropdownMenu>
|
|
<DropdownMenuTrigger render={<Button variant="outline" />}>
|
|
Open
|
|
</DropdownMenuTrigger>
|
|
<DropdownMenuContent>
|
|
<DropdownMenuGroup>
|
|
<DropdownMenuLabel>My Account</DropdownMenuLabel>
|
|
<DropdownMenuItem>Profile</DropdownMenuItem>
|
|
<DropdownMenuItem>Billing</DropdownMenuItem>
|
|
</DropdownMenuGroup>
|
|
<DropdownMenuSeparator />
|
|
<DropdownMenuGroup>
|
|
<DropdownMenuItem>Team</DropdownMenuItem>
|
|
<DropdownMenuItem>Subscription</DropdownMenuItem>
|
|
</DropdownMenuGroup>
|
|
</DropdownMenuContent>
|
|
</DropdownMenu>
|
|
```
|
|
|
|
## Examples
|
|
|
|
### Basic
|
|
|
|
A basic dropdown menu with labels and separators.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dropdown-menu-basic" />
|
|
|
|
### Submenu
|
|
|
|
Use `DropdownMenuSub` to nest secondary actions.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dropdown-menu-submenu" />
|
|
|
|
### Shortcuts
|
|
|
|
Add `DropdownMenuShortcut` to show keyboard hints.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dropdown-menu-shortcuts" />
|
|
|
|
### Icons
|
|
|
|
Combine icons with labels for quick scanning.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dropdown-menu-icons" />
|
|
|
|
### Checkboxes
|
|
|
|
Use `DropdownMenuCheckboxItem` for toggles.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dropdown-menu-checkboxes" />
|
|
|
|
### Checkboxes Icons
|
|
|
|
Add icons to checkbox items.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dropdown-menu-checkboxes-icons" />
|
|
|
|
### Radio Group
|
|
|
|
Use `DropdownMenuRadioGroup` for exclusive choices.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dropdown-menu-radio-group" />
|
|
|
|
### Radio Icons
|
|
|
|
Show radio options with icons.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dropdown-menu-radio-icons" />
|
|
|
|
### Destructive
|
|
|
|
Use `variant="destructive"` for irreversible actions.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dropdown-menu-destructive" />
|
|
|
|
### Avatar
|
|
|
|
An account switcher dropdown triggered by an avatar.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dropdown-menu-avatar" />
|
|
|
|
### Complex
|
|
|
|
A richer example combining groups, icons, and submenus.
|
|
|
|
<ComponentPreview styleName="base-nova" name="dropdown-menu-complex" />
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview
|
|
styleName="base-nova"
|
|
name="dropdown-menu-rtl"
|
|
direction="rtl"
|
|
/>
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI documentation](https://base-ui.com/react/components/menu) for the full API reference.
|