ButtonGroup

Grouped action container for related buttons.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { ButtonGroup } from "@tavojs/ui/button-group";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/button-group.

When to use

Use it when

Use `ButtonGroup` to group related button actions

Choose something else when

Avoid ButtonGroup when wrapping controls without labels or accessible names.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

ButtonGroup example

TSXCreate: src/components/examples/ButtonGroupExample1.tsx

tsximport { ButtonGroup } from "@tavojs/ui/button-group";
import { Button } from "@tavojs/ui";

export function ButtonGroupExample1() {
  return (
    <>
      <ButtonGroup tone="neutral" variant="outline">
        <Button>Day</Button>
        <Button variant="soft">Week</Button>
      </ButtonGroup>
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`orientation`	`"horizontal" \| "vertical"`	—	Configures orientation for this component.
`fullWidth`	`boolean`	—	Configures fullWidth for this component.
`tone`	`"primary" \| "secondary" \| "neutral" \| "danger"`	—	Configures tone for this component.
`variant`	`"solid" \| "soft" \| "outline" \| "ghost" \| "text"`	—	Configures variant for this component.

Complete TypeScript API

Import from @tavojs/ui/button-group. Published exports: ButtonGroup, ButtonGroupProps.

`ButtonGroupProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by ButtonGroup.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by ButtonGroup.
`id`	`string`	No	Inherited id attribute accepted by ButtonGroup.
`role`	`string`	No	Inherited role attribute accepted by ButtonGroup.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by ButtonGroup.
`title`	`string`	No	Inherited title attribute accepted by ButtonGroup.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by ButtonGroup.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by ButtonGroup.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by ButtonGroup.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by ButtonGroup.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by ButtonGroup.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by ButtonGroup.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by ButtonGroup.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by ButtonGroup.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by ButtonGroup.
`orientation`	`"horizontal" \| "vertical"`	No	Configures orientation for this component.
`fullWidth`	`boolean`	No	Configures fullWidth for this component.
`tone`	`"danger" \| "neutral" \| "primary" \| "secondary"`	No	Configures tone for this component.
`variant`	`"solid" \| "soft" \| "outline" \| "ghost" \| "text"`	No	Configures variant for this component.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	Native input attributes target the owned form control; wrapper-specific props stay on the documented component root.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid ButtonGroup when wrapping controls without labels or accessible names.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Form components pass through native attributes and should be paired with visible labels or accessible names.

Use Field, FormLabel, FormControlLabel, or aria-label for labeling.
Preserve native input semantics whenever possible.
Expose validation with error text and aria-invalid where relevant.

Component status

Contract	Current value
Maturity	stable
Category	forms
Component import	`@tavojs/ui/button-group`
Explicit CSS import	`@tavojs/ui/css/button-group`
Preview	Interactive preview available on this page