162 lines
3.7 KiB
Plaintext
162 lines
3.7 KiB
Plaintext
---
|
|
title: Menubar
|
|
description: A visually persistent menu common in desktop applications that provides quick access to a consistent set of commands.
|
|
base: base
|
|
component: true
|
|
links:
|
|
doc: https://base-ui.com/react/components/menubar
|
|
api: https://base-ui.com/react/components/menubar#api-reference
|
|
---
|
|
|
|
<ComponentPreview styleName="base-nova" name="menubar-demo" />
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
```bash
|
|
npx shadcn@latest add menubar
|
|
```
|
|
|
|
</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="menubar"
|
|
title="components/ui/menubar.tsx"
|
|
styleName="base-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import {
|
|
Menubar,
|
|
MenubarContent,
|
|
MenubarGroup,
|
|
MenubarItem,
|
|
MenubarMenu,
|
|
MenubarSeparator,
|
|
MenubarShortcut,
|
|
MenubarTrigger,
|
|
} from "@/components/ui/menubar"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<Menubar>
|
|
<MenubarMenu>
|
|
<MenubarTrigger>File</MenubarTrigger>
|
|
<MenubarContent>
|
|
<MenubarGroup>
|
|
<MenubarItem>
|
|
New Tab <MenubarShortcut>⌘T</MenubarShortcut>
|
|
</MenubarItem>
|
|
<MenubarItem>New Window</MenubarItem>
|
|
</MenubarGroup>
|
|
<MenubarSeparator />
|
|
<MenubarGroup>
|
|
<MenubarItem>Share</MenubarItem>
|
|
<MenubarItem>Print</MenubarItem>
|
|
</MenubarGroup>
|
|
</MenubarContent>
|
|
</MenubarMenu>
|
|
</Menubar>
|
|
```
|
|
|
|
## Composition
|
|
|
|
Use the following composition to build a `Menubar`:
|
|
|
|
```text
|
|
Menubar
|
|
├── MenubarMenu
|
|
│ ├── MenubarTrigger
|
|
│ └── MenubarContent
|
|
│ ├── MenubarGroup
|
|
│ │ ├── MenubarLabel
|
|
│ │ ├── MenubarItem
|
|
│ │ └── MenubarItem
|
|
│ ├── MenubarSeparator
|
|
│ ├── MenubarGroup
|
|
│ │ ├── MenubarLabel
|
|
│ │ ├── MenubarCheckboxItem
|
|
│ │ └── MenubarCheckboxItem
|
|
│ ├── MenubarSeparator
|
|
│ ├── MenubarGroup
|
|
│ │ ├── MenubarLabel
|
|
│ │ └── MenubarRadioGroup
|
|
│ │ ├── MenubarRadioItem
|
|
│ │ └── MenubarRadioItem
|
|
│ └── MenubarSub
|
|
│ ├── MenubarSubTrigger
|
|
│ └── MenubarSubContent
|
|
│ └── MenubarGroup
|
|
│ ├── MenubarLabel
|
|
│ ├── MenubarItem
|
|
│ └── MenubarItem
|
|
└── MenubarMenu
|
|
├── MenubarTrigger
|
|
└── MenubarContent
|
|
└── MenubarGroup
|
|
├── MenubarLabel
|
|
├── MenubarItem
|
|
└── MenubarItem
|
|
```
|
|
|
|
## Checkbox
|
|
|
|
Use `MenubarCheckboxItem` for toggleable options.
|
|
|
|
<ComponentPreview styleName="base-nova" name="menubar-checkbox" />
|
|
|
|
## Radio
|
|
|
|
Use `MenubarRadioGroup` and `MenubarRadioItem` for single-select options.
|
|
|
|
<ComponentPreview styleName="base-nova" name="menubar-radio" />
|
|
|
|
## Submenu
|
|
|
|
Use `MenubarSub`, `MenubarSubTrigger`, and `MenubarSubContent` for nested menus.
|
|
|
|
<ComponentPreview styleName="base-nova" name="menubar-submenu" />
|
|
|
|
## With Icons
|
|
|
|
<ComponentPreview styleName="base-nova" name="menubar-icons" />
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview styleName="base-nova" name="menubar-rtl" direction="rtl" />
|
|
|
|
## API Reference
|
|
|
|
See the [Base UI Menubar](https://base-ui.com/react/components/menubar#api-reference) documentation.
|