Stable in React

Menubar

A menu bar with commands and options for your application, as in a desktop app.

Loading React 19.3.1…

Hover a part or use it. The code follows. · Loading React…

198Tests passing in React · 0 failing

8.0 KiBSize

Not measured yetMemory

Not measured yetSpeed

productdevbook and 13 upstream authors8 commits · last Nov 4

Install#

One package per framework. Menubar's parts come from it; the anatomy tab at the top shows how they nest.

bun add @▢▢▢▢/react

One part. The example uses one of them; the data does not say which are required.

MenubarThe container for menus.

Examples#

The demo at the top is the one example this component has so far.

Styling and accessibility#

The parts ship no styles. Style their states with these attributes; the CSS tab at the top has a sheet. The same CSS works in all five frameworks.

[data-modal]Present when the corresponding menubar is modal. On Menubar.
[data-orientation]Determines the orientation of the menubar. On Menubar.
[data-has-submenu-open]Present when any submenu within the menubar is open. On Menubar.

Keyboard

ArrowLeftArrowRightMoves between the menus' triggers On Menubar.
HomeEndMoves to the first or last trigger On Menubar.
SpaceOpens the focused menu On Menubar.
ArrowDownArrowUpMoves through the open menu's items On Menubar.
ArrowLeftArrowRightWith a menu open, opens the previous or next menu instead On Menubar.
ArrowRightOpens a submenu On Menubar.
ArrowLeftCloses a submenu and returns focus to its trigger On Menubar.
EscapeCloses the open menu On Menubar.

Set for you

role="menubar", aria-orientationa screen reader announces a menu bar and which arrow keys move in itMenubar
gives each Menu trigger inside role="menuitem"the triggers are read as the bar's itemsMenubar

API reference#

4 props across 1 parts, in React syntax, and className, style, render once for every part. Open a row to try it.

Filter props

Menubar · all parts

Shared propsEvery part that renders an element takes these.

classNameCSS class applied to the element, or a function that returns a class based on the component's state.string | ((state: State) => string | undefined)

styleStyle applied to the element, or a function that returns a style object based on the component's state.React.CSSProperties | ((state: State) => React.CSSProperties | undefined)

renderAllows you to replace the component's HTML element with a different tag, or compose it with another component.React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, State>

Use it in React#

What differs from the React API. Switch the framework at the top of the page.

@▢▢▢▢/react is the React 19 package. Its parts, props, data attributes and error messages are upstream Base UI's, and upstream's own tests run against it.

Parts
Each component is its own entry point and exports one namespace named after it.
```
import { Switch } from '@base-ui-next/react/switch'

export function Example() {
  return (
    <Switch.Root>
      <Switch.Thumb />
    </Switch.Root>
  )
}
```
A part renders the element its API reference names, such as a <span> for Switch.Root.
Props and events
Props and callbacks have upstream's names and signatures: onCheckedChange(checked, details), onOpenChange(open, details), onValueChange(value, details). details carries reason, event, cancel() and allowPropagation(). Native handlers are React's (onClick, onKeyDown), and event.preventBaseUIHandler() stops a part's own handler.
Styling
className takes a string or a function (state) => string; style takes an object or a function (state) => object. The state's data-* attributes are on the element for CSS.
render
render takes an element (render={<a href="/docs" />}) or a function (props, state) => element that spreads props on what it returns.
Refs
ref reaches the part's element. Imperative handles are ref props, as upstream: inputRef, and actionsRef ({ validate } on Field and Form, { unmount, close } on Dialog).
Binding
A part is controlled when its value prop (checked, open, value) is set, and uncontrolled with the default form (defaultChecked, defaultOpen, defaultValue). React has no two-way binding: pair the value with its change callback.
From @base-ui/react
Change the import from @base-ui/react/<component> to @▢▢▢▢/react/<component>.
From @base-ui/react
Nothing else changes: props, parts, data attributes and errors are the same.