Toolbar

Install: npm install @mantine/core@9.7.1 @mantine/hooks@9.7.1

Version and compatibility

Pinned Mantine Core 9.7.1 requires React and React DOM ^19.2.0 and matching @mantine/hooks@9.7.1, from the installed npm package's peerDependencies. Do not force it into React 18 or another incompatible version. Explain upgrade impact and agree on a plan with the project owner; do not hide conflicts with --force/--legacy-peer-deps. The native Provider enables theme.respectReducedMotion and uses forceColorScheme for light/dark.

Use case

Group related actions and toggles in a toolbar.

Native props used by this example

These props are extracted from the local typechecked JSX and grouped by their owning native component. This is not an exhaustive prop list; see pinned source signatures and inheritance below.

Interaction and state checks

Current scenarios: Default. Check actual behavior after selecting supported disabled/error/read-only scenarios; components without those native states do not receive invented universal props. Verify keyboard focus and exits, then connect changed values through the native callback signature.

Business integration boundary

Demo content/state is local, without server persistence, authorization or fetching. A static display component is not a completed business workflow.

Host setup

Install pinned @mantine/core and @mantine/hooks, import @mantine/core/styles.css at the entry and use MantineProvider. The example's theme/variant are JGuang-authored host props, not universal native component APIs; forceColorScheme synchronizes the app theme. Native implementation source is a reading reference: use npm exports rather than copying internal engines. This batch covers Core, not dates/charts/forms extension packages. Detailed upstream prose remains English.

Runnable usage

import { useState } from 'react';
import * as M from '@mantine/core';
import '@mantine/core/styles.css';


function ComponentPreview({ variant = 'Default' }: { variant?: string }) {

return <M.Toolbar><M.Toolbar.Toggle autoWidth>Bold</M.Toolbar.Toggle><M.Toolbar.Toggle autoWidth>Italic</M.Toolbar.Toggle></M.Toolbar>;
}
export default function Example({ variant = 'Default', theme = 'light' }: { variant?: string; theme?: 'light' | 'dark' }) {
return <M.MantineProvider forceColorScheme={theme} theme={{ respectReducedMotion: true }}><ComponentPreview variant={variant} /></M.MantineProvider>;
}

Preview states

Default

The example uses the native Mantine API. For supported input demos, change the local variant to Disabled, Invalid or Read only; these are example labels, not new component props. Keep the documented data, controlled values, stores and compound children when adapting the example.

Usage

Toolbar is a group of toggle buttons with role="toolbar" and arrow keys navigation. Toolbar.Toggle is a polymorphic component, it can be rendered as any element, for example as a link.

Toolbar.Toggle is stateless: pass active and update it in onClick, or use Toolbar.ToggleGroup to manage state of a set of toggles. For a toggle that manages its own state, use the standalone Toggle component.

Toggle groups

Use Toolbar.ToggleGroup with Toolbar.ToggleItem to create groups of toggle buttons. Set type="single" to allow one active item at a time or type="multiple" to allow several. With type="single", clicking the active item deselects it and the value becomes null.

Size, orientation, variant and color

The size prop controls the size of all toggles, padding and gap. Set orientation="vertical" to render a vertical toolbar. variant and color props control the appearance of active toggles.

Auto contrast

Set autoContrast prop to automatically adjust icon color based on the active toggle background color, for example with variant="filled" and light colors.

Auto width

By default, Toolbar.Toggle and Toolbar.ToggleItem render as square buttons. Set autoWidth prop on either of them to allow the toggle width to adjust to its content, for example a text label.

Disabled state

Set disabled prop on individual Toolbar.ToggleItem components, or on Toolbar.ToggleGroup to disable all items within the group.

When Toolbar.Toggle is rendered as a non-button element (for example, component="a"), the disabled prop sets aria-disabled, removes the element from the tab order and prevents clicks.

Accessibility

• Toolbar has role="toolbar" and aria-orientation that matches the orientation prop
• Toolbar.ToggleItem always has aria-pressed attribute. Toolbar.Toggle has it only when the active prop is passed, without it Toolbar.Toggle is a regular button
• Set aria-label on icon-only toggles

Keyboard interactions

Toolbar.Toggle and Toolbar.ToggleItem components share a single tab stop, arrow keys move focus between them. Other interactive children (ActionIcon, Button, standalone Toggle) are not part of the arrow key navigation and remain separate tab stops.

Source-backed parameter reference

Implementation signatures and types are generated from the pinned local source. Optional props, native inherited types, union branches and never exclusions are preserved. A forwardRef implementation's ref is a React reference, not an additional business prop.

Toolbar(_props)

export type ToolbarStylesNames =
  | 'root'
  | ToolbarGroupStylesNames
  | ToolbarToggleStylesNames
  | ToolbarToggleItemStylesNames
  | ToolbarDividerStylesNames;

export type ToolbarCssVariables = {
  root: '--toolbar-toggle-size' | '--toolbar-padding' | '--toolbar-gap' | '--toolbar-radius';
  toggle:
    | '--toolbar-toggle-active-bg'
    | '--toolbar-toggle-active-hover'
    | '--toolbar-toggle-active-color';
};

export interface ToolbarProps
  extends BoxProps, StylesApiProps<ToolbarFactory>, ElementProps<'div'> {
  /** Toolbar orientation, `'horizontal'` by default */
  orientation?: 'horizontal' | 'vertical';

  /** Whether arrow key navigation wraps from last to first item, `true` by default */
  loop?: boolean;

  /** Controls size of toggle components, padding, and gap, `'md'` by default */
  size?: MantineSize | (string & {});

  /** Key of `theme.radius` or any valid CSS value to set `border-radius`, propagated to all children, `theme.defaultRadius` by default */
  radius?: MantineRadius;

  /** Determines whether the toolbar has a border, `true` by default */
  withBorder?: boolean;

  /** Key of `theme.colors` or any valid CSS color, controls color of child toggle components */
  color?: MantineColor;

  /** Determines whether icon color with filled variant should be changed based on the given `color` prop */
  autoContrast?: boolean;

  /** Toolbar content */
  children: React.ReactNode;
}

export type ToolbarFactory = Factory<{
  props: ToolbarProps;
  ref: HTMLDivElement;
  stylesNames: ToolbarStylesNames;
  vars: ToolbarCssVariables;
  variant: ToggleVariant;
  staticComponents: {
    Group: typeof ToolbarGroup;
    Toggle: typeof ToolbarToggle;
    ToggleGroup: typeof ToolbarToggleGroup;
    ToggleItem: typeof ToolbarToggleItem;
    Divider: typeof ToolbarDivider;
  };
}>;

export type Mod = Record<string, any> | string;

export type BoxMod = Mod | Mod[] | BoxMod[];

export interface BoxProps extends MantineStyleProps {
  /** Class added to the root element, if applicable */
  className?: string | undefined;

  /** Inline style added to root component element, can subscribe to theme defined on MantineProvider */
  style?: MantineStyleProp;

  /** CSS variables defined on root component element */
  __vars?: CssVarsProp;

  /** `size` property passed down the HTML element */
  __size?: string;

  /** Breakpoint above which the component is hidden with `display: none` */
  hiddenFrom?: MantineBreakpoint;

  /** Breakpoint below which the component is hidden with `display: none` */
  visibleFrom?: MantineBreakpoint;

  /** Determines whether component should be hidden in light color scheme with `display: none` */
  lightHidden?: boolean;

  /** Determines whether component should be hidden in dark color scheme with `display: none` */
  darkHidden?: boolean;

  /** Element modifiers transformed into `data-` attributes, for example, `{ 'data-size': 'xl' }`, falsy values are removed */
  mod?: BoxMod;
}

export type ElementProps<
  ElementType extends React.ElementType,
  PropsToOmit extends string = never,
> = Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>;

export interface CSSProperties extends React.CSSProperties {
  [key: string]: any;
}

type MantineStyle = CSSProperties | ((theme: MantineTheme) => CSSProperties);

export type MantineStyleProp = MantineStyle | MantineStyle[] | MantineStyleProp[] | undefined;

export type CssVariable = `--${string}`;

export type CssVariables<Variable extends string = CssVariable> = Partial<Record<Variable, string>>;

export type CssVars<Variable extends string = CssVariable> =
  | CssVariables<Variable>
  | ((theme: MantineTheme) => CssVariables<Variable>)
  | CssVars<Variable>[];

export type CssVarsProp<Variable extends string = CssVariable> =
  | CssVars<Variable>
  | CssVars<Variable>[];

Native and external types

External types remain defined by React or native dependencies, not manually expanded into guessed props. The installed version's TypeScript definitions are authoritative.

Factory<{
  props: ToolbarProps;
  ref: HTMLDivElement;
  stylesNames: ToolbarStylesNames;
  vars: ToolbarCssVariables;
  variant: ToggleVariant;
  staticComponents: {
    Group: typeof ToolbarGroup;
    Toggle: typeof ToolbarToggle;
    ToggleGroup: typeof ToolbarToggleGroup;
    ToggleItem: typeof ToolbarToggleItem;
    Divider: typeof ToolbarDivider;
  };
}>
MantineStyleProps
React.CSSProperties
MantineTheme
Partial<Record<Variable, string>>
Record<Variable, string>
Variable
MantineBreakpoint
Record<string, any>
StylesApiProps<ToolbarFactory>
React.ElementType
Omit<React.ComponentProps<ElementType>, 'style' | PropsToOmit>
React.ComponentProps<ElementType>
ElementType
PropsToOmit
MantineSize
MantineRadius
MantineColor
React.ReactNode
HTMLDivElement
ToolbarGroupStylesNames
ToolbarToggleStylesNames
ToolbarToggleItemStylesNames
ToolbarDividerStylesNames
ToggleVariant