# Menubar
A visually persistent menu common in desktop applications that provides quick access to a consistent set of commands.
## Import
```
Copyts
import { Menubar } from "@kobalte/core/menubar";
// or
import { Root, Menu, ... } from "@kobalte/core/menubar";
// or (deprecated)
import { Menubar } from "@kobalte/core";
```
```
Copyts
import { Menubar } from "@kobalte/core/menubar";
// or
import { Root, Menu, ... } from "@kobalte/core/menubar";
// or (deprecated)
import { Menubar } from "@kobalte/core";
```
## Features
- Follows the [WAI ARIA Menubar](https://www.w3.org/WAI/ARIA/apg/patterns/menubar/) design pattern.
- Supports modal and non-modal modes.
- Supports submenus.
- Supports items, labels, groups of items.
- Supports checkable items (single or multiple) with optional indeterminate state.
- Support disabled items.
- Complex item labeling support for accessibility.
- Keyboard opening and navigation support.
- Automatic scrolling support during keyboard navigation.
- Typeahead to allow focusing items by typing text.
- Optionally render a pointing arrow.
- Focus is fully managed.
## Anatomy
The menubar consists of:
- **Menubar:** The root container for a menubar.
The menu consists of:
- **Menubar.Menu:** The container of each menu.
- **Menubar.Trigger:** The button that toggles the menu.
- **Menubar.Icon:** A small icon that can be displayed inside the menu trigger as a visual affordance for the fact it can be open.
- **Menubar.Portal:** Portals its children into the `body` when the menu is open.
- **Menubar.Content:** Contains the content to be rendered when the menu is open.
- **Menubar.Arrow:** An optional arrow element to render alongside the menu content.
- **Menubar.Separator:** Used to visually separate items in the menu.
- **Menubar.Group:** Used to group multiple items. Use in conjunction with `Menubar.GroupLabel` to ensure good accessibility via automatic labelling.
- **Menubar.GroupLabel:** Used to render the label of a group. It won't be focusable using arrow keys.
- **Menubar.Sub:** Contains all the parts of a submenu.
- **Menubar.SubTrigger:** An item that opens a submenu. Must be rendered inside `Menubar.Sub`.
- **Menubar.SubContent:** The component that pops out when a submenu is open. Must be rendered inside `Menubar.Sub`.
The menu item consists of:
- **Menubar.Item:** An item of the select.
- **Menubar.ItemLabel:** An accessible label to be announced for the item.
- **Menubar.ItemDescription:** An optional accessible description to be announced for the item.
- **Menubar.ItemIndicator:** The visual indicator rendered when the item is checked.
The checkable menu item consists of:
- **Menubar.RadioGroup:** Used to group multiple `Menubar.RadioItem`s and manage the selection.
- **Menubar.RadioItem:** An item that can be controlled and rendered like a radio.
- **Menubar.CheckboxItem:** An item that can be controlled and rendered like a checkbox.
```
Copytsx
```
```
Copytsx
```
## Example
GitFileEdit
index.tsxstyle.css
```
Copytsx
import { Menubar } from "@kobalte/core/menubar";
import { createSignal } from "solid-js";
import { CheckIcon, ChevronRightIcon, DotFilledIcon } from "some-icon-library";
import "./style.css";
function App() {
const [showGitLog, setShowGitLog] = createSignal(true);
const [showHistory, setShowHistory] = createSignal(false);
const [branch, setBranch] = createSignal("main");
return (
);
}
```
```
Copytsx
import { Menubar } from "@kobalte/core/menubar";
import { createSignal } from "solid-js";
import { CheckIcon, ChevronRightIcon, DotFilledIcon } from "some-icon-library";
import "./style.css";
function App() {
const [showGitLog, setShowGitLog] = createSignal(true);
const [showHistory, setShowHistory] = createSignal(false);
const [branch, setBranch] = createSignal("main");
return (
);
}
```
## Usage
### Link Trigger
To make one of the menubar triggers a link instead of opening a menu, omit the `Menubar.Menu` and set `as="a"` on the `Menubar.Trigger`.
```
Copytsx
Opens a regular menu
...
Opens a link on click and enter
```
```
Copytsx
Opens a regular menu
...
Opens a link on click and enter
```
### Origin-aware animations
We expose a CSS custom property `--kb-menu-content-transform-origin` which can be used to animate the content from its computed origin.
```
Copycss
/* style.css */
.context-menu__content,
.context-menu__sub-content {
transform-origin: var(--kb-menu-content-transform-origin);
animation: contentHide 250ms ease-in forwards;
}
.context-menu__content[data-expanded],
.context-menu__sub-content[data-expanded] {
animation: contentShow 250ms ease-out;
}
@keyframes contentShow {
from {
opacity: 0;
transform: scale(0.96);
}
to {
opacity: 1;
transform: scale(1);
}
}
@keyframes contentHide {
from {
opacity: 1;
transform: scale(1);
}
to {
opacity: 0;
transform: scale(0.96);
}
}
```
```
Copycss
/* style.css */
.context-menu__content,
.context-menu__sub-content {
transform-origin: var(--kb-menu-content-transform-origin);
animation: contentHide 250ms ease-in forwards;
}
.context-menu__content[data-expanded],
.context-menu__sub-content[data-expanded] {
animation: contentShow 250ms ease-out;
}
@keyframes contentShow {
from {
opacity: 0;
transform: scale(0.96);
}
to {
opacity: 1;
transform: scale(1);
}
}
@keyframes contentHide {
from {
opacity: 1;
transform: scale(1);
}
to {
opacity: 0;
transform: scale(0.96);
}
}
```
## API Reference
### Menubar
`Menubar` is equivalent to the `Root` import from `@kobalte/core/menubar` (and deprecated `Menubar.Root`).
| Prop | Description |
| --- | --- |
| defaultValue | `string`
The value of the menu that should be open when initially rendered. Use when you do not need to control the value state. |
| value | `string`
The controlled value of the menu to open. Should be used in conjunction with onValueChange. |
| onValueChange | `(value: string | undefined | null) => void`
Event handler called when the value changes. |
| loop | `boolean`
When true, keyboard navigation will loop from last item to first, and vice versa. |
| focusOnAlt | `boolean`
When true, click on alt by itsef will focus this Menubar (some browsers interfere). |
### Menubar.Menu
| Prop | Description |
| --- | --- |
| onOpenChange | `(open: boolean) => void`
Event handler called when the open state of the menu changes. |
| id | `string`
A unique identifier for the component. The id is used to generate id attributes for nested components. If no id prop is provided, a generated id will be used. |
| modal | `boolean`
Whether the menu should be the only visible content for screen readers, when set to `true`:
\- interaction with outside elements will be disabled.
\- scroll will be locked.
\- focus will be locked inside the menu content.
\- elements outside the menu content will not be visible for screen readers. |
| preventScroll | `boolean`
Whether the scroll should be locked even if the menu is not modal. |
| forceMount | `boolean`
Used to force mounting the menu (portal and content) when more control is needed. Useful when controlling animation with SolidJS animation libraries. |
| value | `string`
A unique value that associates the item with an active value when the navigation menu is controlled. This prop is managed automatically when uncontrolled. |
`Menubar.Menu` also accepts the following props to customize the placement of the `Menubar.Content`.
| Prop | Description |
| --- | --- |
| placement | `Placement`
The placement of the menu content. |
| gutter | `number`
The distance between the menu content and the trigger element. By default, it's 0 plus half of the arrow offset, if it exists. |
| shift | `number`
The skidding of the menu content along the trigger element. |
| flip | `boolean | string`
Controls the behavior of the menu content when it overflows the viewport:
\- If a `boolean`, specifies whether the menu content should flip to the opposite side when it overflows.
\- If a `string`, indicates the preferred fallback placements when it overflows.
The placements must be spaced-delimited, e.g. "top left". |
| slide | `boolean`
Whether the menu content should slide when it overflows. |
| overlap | `boolean`
Whether the menu content can overlap the trigger element when it overflows. |
| sameWidth | `boolean`
Whether the menu content should have the same width as the trigger element. This will be exposed to CSS as `--kb-popper-anchor-width`. |
| fitViewport | `boolean`
Whether the menu content should fit the viewport. If this is set to true, the menu content will have `maxWidth` and `maxHeight` set to the viewport size. This will be exposed to CSS as `--kb-popper-available-width` and `--kb-popper-available-height`. |
| hideWhenDetached | `boolean`
Whether to hide the menu content when the trigger element becomes occluded. |
| detachedPadding | `number`
The minimum padding in order to consider the trigger element occluded. |
| arrowPadding | `number`
The minimum padding between the arrow and the menu content corner. |
| overflowPadding | `number`
The minimum padding between the menu content and the viewport edge. This will be exposed to CSS as `--kb-popper-overflow-padding`. |
### Menubar.Trigger
| Prop | Description |
| --- | --- |
| disabled | `boolean`
Whether the context menu trigger is disabled or not. |
| Data attribute | Description |
| --- | --- |
| data-expanded | Present when the menu is open. |
| data-closed | Present when the menu is close. |
| data-disabled | Present when the trigger is disabled. |
`Menubar.Icon`, `Menubar.Content`, `Menubar.SubTrigger` and `Menubar.SubContent` share the same `data-expanded` attribute.
### Menubar.Content
The popper positioner will copy the same `z-index` as the `Menubar.Content`.
| Prop | Description |
| --- | --- |
| onOpenAutoFocus | `(event: Event) => void`
Event handler called when focus moves into the component after opening. It can be prevented by calling `event.preventDefault`. |
| onCloseAutoFocus | `(event: Event) => void`
Event handler called when focus moves to the trigger after closing. It can be prevented by calling `event.preventDefault`. |
| onEscapeKeyDown | `(event: KeyboardEvent) => void`
Event handler called when the escape key is down. It can be prevented by calling `event.preventDefault`. |
| onPointerDownOutside | `(event: PointerDownOutsideEvent) => void`
Event handler called when a pointer event occurs outside the bounds of the component. It can be prevented by calling `event.preventDefault`. |
| onFocusOutside | `(event: FocusOutsideEvent) => void`
Event handler called when the focus moves outside the bounds of the component. It can be prevented by calling `event.preventDefault`. |
| onInteractOutside | `(event: InteractOutsideEvent) => void`
Event handler called when an interaction (pointer or focus event) happens outside the bounds of the component. It can be prevented by calling `event.preventDefault`. |
### Menubar.Arrow
| Prop | Description |
| --- | --- |
| size | `number`
The size of the arrow. |
### Menubar.Item
| Prop | Description |
| --- | --- |
| textValue | `string`
Optional text used for typeahead purposes. By default, the typeahead behavior will use the .textContent of the `Menubar.ItemLabel` part if provided, or fallback to the .textContent of the `Menubar.Item`. Use this when the content is complex, or you have non-textual content inside. |
| disabled | `boolean`
Whether the item is disabled or not. |
| closeOnSelect | `boolean`
Whether the menu should close when the item is activated. |
| onSelect | `() => void`
Event handler called when the user selects an item (via mouse or keyboard). |
| Data attribute | Description |
| --- | --- |
| data-disabled | Present when the item is disabled. |
| data-highlighted | Present when the item is highlighted. |
`Menubar.ItemLabel`, `Menubar.ItemDescription` and `Menubar.ItemIndicator` shares the same data-attributes.
### Menubar.ItemIndicator
| Prop | Description |
| --- | --- |
| forceMount | `boolean`
Used to force mounting when more control is needed. Useful when controlling animation with SolidJS animation libraries. |
### Menubar.RadioGroup
| Prop | Description |
| --- | --- |
| value | `string`
The controlled value of the menu radio item to check. |
| defaultValue | `string`
The value of the menu radio item that should be checked when initially rendered. Useful when you do not need to control the state of the radio group. |
| onChange | `(value: string) => void`
Event handler called when the value changes. |
| disabled | `boolean`
Whether the radio group is disabled or not. |
### Menubar.RadioItem
| Prop | Description |
| --- | --- |
| value | `string`
The value of the menu item radio. |
| textValue | `string`
Optional text used for typeahead purposes. By default, the typeahead behavior will use the .textContent of the `Menubar.ItemLabel` part if provided, or fallback to the .textContent of the `Menubar.Item`. Use this when the content is complex, or you have non-textual content inside. |
| disabled | `boolean`
Whether the item is disabled or not. |
| closeOnSelect | `boolean`
Whether the menu should close when the item is checked. |
| onSelect | `() => void`
Event handler called when the user selects an item (via mouse or keyboard). |
| Data attribute | Description |
| --- | --- |
| data-disabled | Present when the item is disabled. |
| data-checked | Present when the item is checked. |
| data-highlighted | Present when the item is highlighted. |
### Menubar.CheckboxItem
| Prop | Description |
| --- | --- |
| checked | `boolean`
The controlled checked state of the item. |
| defaultChecked | `boolean`
The default checked state when initially rendered. Useful when you do not need to control the checked state. |
| onChange | `(checked: boolean) => void`
Event handler called when the checked state of the item changes. |
| textValue | `string`
Optional text used for typeahead purposes. By default, the typeahead behavior will use the .textContent of the `Menubar.ItemLabel` part if provided, or fallback to the .textContent of the `Menubar.Item`. Use this when the content is complex, or you have non-textual content inside. |
| indeterminate | `boolean`
Whether the item is in an indeterminate state. |
| disabled | `boolean`
Whether the item is disabled or not. |
| closeOnSelect | `boolean`
Whether the menu should close when the item is checked/unchecked. |
| onSelect | `() => void`
Event handler called when the user selects an item (via mouse or keyboard). |
| Data attribute | Description |
| --- | --- |
| data-disabled | Present when the item is disabled. |
| data-indeterminate | Present when the item is in an indeterminate state. |
| data-checked | Present when the item is checked. |
| data-highlighted | Present when the item is highlighted. |
### Menubar.Sub
| Prop | Description |
| --- | --- |
| open | `boolean`
The controlled open state of the sub menu. |
| defaultOpen | `boolean`
The default open state when initially rendered. Useful when you do not need to control the open state. |
| onOpenChange | `(open: boolean) => void`
Event handler called when the open state of the sub menu changes. |
`Menubar.Sub` also accepts the following props to customize the placement of the `Menubar.SubContent`.
| Prop | Description |
| --- | --- |
| getAnchorRect | `(anchor?: HTMLElement) => AnchorRect | undefined`
Function that returns the trigger element's DOMRect. |
| gutter | `number`
The distance between the sub menu content and the trigger element. By default, it's 0 plus half of the arrow offset, if it exists. |
| shift | `number`
The skidding of the sub menu content along the trigger element. |
| slide | `boolean`
Whether the sub menu content should slide when it overflows. |
| overlap | `boolean`
Whether the sub menu content can overlap the trigger element when it overflows. |
| fitViewport | `boolean`
Whether the sub menu content should fit the viewport. If this is set to true, the sub menu content will have `maxWidth` and `maxHeight` set to the viewport size. This will be exposed to CSS as `--kb-popper-available-width` and `--kb-popper-available-height`. |
| hideWhenDetached | `boolean`
Whether to hide the sub menu content when the trigger element becomes occluded. |
| detachedPadding | `number`
The minimum padding in order to consider the trigger element occluded. |
| arrowPadding | `number`
The minimum padding between the arrow and the sub menu content corner. |
| overflowPadding | `number`
The minimum padding between the sub menu content and the viewport edge. This will be exposed to CSS as `--kb-popper-overflow-padding`. |
### Menubar.SubTrigger
| Prop | Description |
| --- | --- |
| textValue | `string`
Optional text used for typeahead purposes. By default, the typeahead behavior will use the .textContent of the `Menubar.SubTrigger`. Use this when the content is complex, or you have non-textual content inside. |
| disabled | `boolean`
Whether the sub menu trigger is disabled or not. |
| Data attribute | Description |
| --- | --- |
| data-disabled | Present when the item is disabled. |
| data-highlighted | Present when the item is highlighted. |
### Menubar.SubContent
| Prop | Description |
| --- | --- |
| onEscapeKeyDown | `(event: KeyboardEvent) => void`
Event handler called when the escape key is down. It can be prevented by calling `event.preventDefault`. |
| onPointerDownOutside | `(event: PointerDownOutsideEvent) => void`
Event handler called when a pointer event occurs outside the bounds of the component. It can be prevented by calling `event.preventDefault`. |
| onFocusOutside | `(event: FocusOutsideEvent) => void`
Event handler called when the focus moves outside the bounds of the component. It can be prevented by calling `event.preventDefault`. |
| onInteractOutside | `(event: InteractOutsideEvent) => void`
Event handler called when an interaction (pointer or focus event) happens outside the bounds of the component. It can be prevented by calling `event.preventDefault`. |
## Rendered elements
| Component | Default rendered element |
| --- | --- |
| `Menubar` | `div` |
| `Menubar.Menu` | none |
| `Menubar.Trigger` | `div` |
| `Menubar.Icon` | `div` |
| `Menubar.Portal` | `Portal` |
| `Menubar.Content` | `div` |
| `Menubar.Arrow` | `div` |
| `Menubar.Separator` | `hr` |
| `Menubar.Group` | `div` |
| `Menubar.GroupLabel` | `span` |
| `Menubar.Sub` | none |
| `Menubar.SubTrigger` | `div` |
| `Menubar.SubContent` | `div` |
| `Menubar.Item` | `div` |
| `Menubar.ItemLabel` | `div` |
| `Menubar.ItemDescription` | `div` |
| `Menubar.ItemIndicator` | `div` |
| `Menubar.RadioGroup` | `div` |
| `Menubar.RadioItem` | `div` |
| `Menubar.CheckboxItem` | `div` |
## Accessibility
### Keyboard Interactions
| Key | Description |
| --- | --- |
| `Space` | When focus is on an item, activates the item. |
| `Enter` | When focus is on an item, activates the item. |
| `ArrowDown` | When focus is on an item, moves focus to the next item. |
| `ArrowUp` | When focus is on an item, moves focus to the previous item. |
| `ArrowRight` | When focus is on an item (not sub menu trigger), moves focus to the next menu. |
| `ArrowLeft` | When focus is on an item (not sub menu item), moves focus to the previous menu. |
| `ArrowRight` / `ArrowLeft` | When focus is on a sub menu trigger, opens or closes the submenu depending on reading direction. |
| `Home` | When focus is on an item, moves focus to first item. |
| `End` | When focus is on an item, moves focus to last item. |
| `Esc` | Closes the menu. |
Previous[←Link](https://kobalte.dev/docs/core/components/link)Next[Meter→](https://kobalte.dev/docs/core/components/meter)