Toolbar

HomeHome PrimitivesPrimitives VisualizesVisualizes HooksHooks

A container for grouping a set of controls, such as buttons, toggle groups or dropdown menus.

Features

Full keyboard navigation.

Installation

Install the component from your command line.

npm install @tealess/toolbar

Anatomy

Import the component.

import * as Toolbar from "@tealess/toolbar";

export default () => (
  <Toolbar.Root>
    <Toolbar.Button />
    <Toolbar.Separator />
    <Toolbar.Link />
    <Toolbar.ToggleGroup>
      <Toolbar.ToggleItem />
    </Toolbar.ToggleGroup>
  </Toolbar.Root>
);

API Reference

Root

Contains all the toolbar component parts.

Prop	Type	Default
`asChild`	`boolean`	`false`
`orientation`	`enum`	`"horizontal"`
`dir`	`enum`	No default value
`loop`	`boolean`	`true`

Data attribute	Values
`[data-orientation]`	`"vertical" \| "horizontal"`

Button

A button item.

Prop	Type	Default
`asChild`	`boolean`	`false`

Data attribute	Values
`[data-orientation]`	`"vertical" \| "horizontal"`

Link

A link item.

Prop	Type	Default
`asChild`	`boolean`	`false`

ToggleGroup

A set of two-state buttons that can be toggled on or off.

Prop	Type	Default
`asChild`	`boolean`	`false`
`type*`	`enum`	No default value
`value`	`string`	No default value
`defaultValue`	`string`	No default value
`onValueChange`	`function`	No default value
`value`	`string[]`	`[]`
`defaultValue`	`string[]`	`[]`
`onValueChange`	`function`	No default value
`disabled`	`boolean`	`false`

Data attribute	Values
`[data-orientation]`	`"vertical" \| "horizontal"`

ToggleItem

An item in the group.

Prop	Type	Default
`asChild`	`boolean`	`false`
`value*`	`string`	No default value
`disabled`	`boolean`	No default value

Data attribute	Values
`[data-state]`	`"on" \| "off"`
`[data-disabled]`	Present when disabled
`[data-orientation]`	`"vertical" \| "horizontal"`

Separator

Used to visually separate items in the toolbar.

Prop	Type	Default
`asChild`	`boolean`	`false`

Data attribute	Values
`[data-orientation]`	`"vertical" \| "horizontal"`

Examples

Use with other primitives

All our primitives which expose a Trigger part, such as Dialog, AlertDialog, Popover, DropdownMenu can be composed within a toolbar by using the asChild prop.

Here is an example using our DropdownMenu primitive.

import * as Toolbar from "@tealess/toolbar";
import * as DropdownMenu from "@tealess/dropdown-menu";

export default () => (
  <Toolbar.Root>
    <Toolbar.Button>Action 1</Toolbar.Button>
    <Toolbar.Separator />
    <DropdownMenu.Root>
      <Toolbar.Button asChild>
        <DropdownMenu.Trigger>Trigger</DropdownMenu.Trigger>
      </Toolbar.Button>
      <DropdownMenu.Content>…</DropdownMenu.Content>
    </DropdownMenu.Root>
  </Toolbar.Root>
);

Accessibility

Uses roving tabindex to manage focus movement among items.

Keyboard Interactions

Key	Description
`Tab`	Moves focus to the first item in the group.
`Space`	Activates/deactivates the item.
`Enter`	Activates/deactivates the item.
`ArrowDown`	Moves focus to the next item depending on `orientation`.
`ArrowRight`	Moves focus to the next item depending on `orientation`.
`ArrowUp`	Moves focus to the previous item depending on `orientation`.
`ArrowLeft`	Moves focus to the previous item depending on `orientation`.
`Home`	Moves focus to the first item.
`End`	Moves focus to the last item.

PreviousToggle Group

NextTooltip

Edit this page on GitHub.

Overview

Guides

Components

Utilities