GitHubopen_in_new

ButtonGroup

Button groups keep a related set of options visually connected while preserving single- or multi-selection behavior.

Anatomy

ElementPartSelector
<SelectionGroup>
root
[data-scope="button-group"][data-part="root"]
left_clickLMBCopy

Props

NameDescriptionDefaultControl
disabledOptional

-

boolean | undefined
false
selectionModeOptional

-

singlemultiple
"single"
nameOptional

-

string | undefined
-
-
ariaLabelOptional

-

string | undefined
-
-
typeOptional

-

standardconnected
"standard"
sizeOptional

-

smalllargeextra-smallmediumextra-large
"small"
colorOptional

-

elevatedfilledtonaloutlinedtext
"tonal"
pressShapeMorphOptional

-

boolean | undefined
true
modelValueOptional

-

SelectionGroupModelValue
-
-

Events1

NameTypeDescription
update:modelValue[value: SelectionGroupModelValue]-

Slots1

NameParametersDescription
default--

Styling61

TokenDescription
--md-button-group-between-spaceLayout
Fallbackvar(--md-button-group-standard-medium-between-space,0.5rem)

Controls between space.

--md-button-group-connected-container-shapeShape
Fallbackvar(--md-button-group-connected-medium-container-shape,var(--md-shape-action))

Controls connected container shape.

--md-button-group-connected-inner-corner-corner-sizeShape
Fallbackvar(--md-button-group-connected-medium-inner-corner-corner-size,var(--md-sys-shape-corner-value-small))

Controls connected inner corner corner size.

--md-button-group-connected-large-between-spaceLayout
Fallback0.125rem

Controls connected large between space.

--md-button-group-connected-large-container-heightLayout
Fallback6rem

Controls connected large container height.

--md-button-group-connected-large-container-shapeShape
Fallbackvar(--md-shape-action)

Controls connected large container shape.

--md-button-group-connected-large-inner-corner-corner-sizeShape
Fallbackvar(--md-sys-shape-corner-value-large)

Controls connected large inner corner corner size.

--md-button-group-connected-large-pressed-inner-corner-corner-sizeShape
Fallbackvar(--md-sys-shape-corner-value-medium)

Controls connected large pressed inner corner corner size.

--md-button-group-connected-large-selected-inner-corner-corner-sizeShape
Fallbackvar(--md-shape-action)

Controls connected large selected inner corner corner size.

--md-button-group-connected-medium-between-spaceLayout
Fallback0.125rem

Controls connected medium between space.

--md-button-group-connected-medium-container-heightLayout
Fallback3.5rem

Controls connected medium container height.

--md-button-group-connected-medium-container-shapeShape
Fallbackvar(--md-shape-action)

Controls connected medium container shape.

--md-button-group-connected-medium-inner-corner-corner-sizeShape
Fallbackvar(--md-sys-shape-corner-value-small)

Controls connected medium inner corner corner size.

--md-button-group-connected-medium-pressed-inner-corner-corner-sizeShape
Fallbackvar(--md-sys-shape-corner-value-extra-small)

Controls connected medium pressed inner corner corner size.

--md-button-group-connected-medium-selected-inner-corner-corner-sizeShape
Fallbackvar(--md-shape-action)

Controls connected medium selected inner corner corner size.

--md-button-group-connected-pressed-inner-corner-corner-sizeShape
Fallbackvar(--md-button-group-connected-medium-pressed-inner-corner-corner-size,var(--md-sys-shape-corner-value-extra-small))

Controls connected pressed inner corner corner size.

--md-button-group-connected-selected-inner-corner-corner-sizeShape
Fallbackvar(--md-button-group-connected-medium-selected-inner-corner-corner-size,var(--md-shape-action))

Controls connected selected inner corner corner size.

--md-button-group-connected-small-between-spaceLayout
Fallback0.125rem

Controls connected small between space.

--md-button-group-connected-small-container-heightLayout
Fallback2.5rem

Controls connected small container height.

--md-button-group-connected-small-container-shapeShape
Fallbackvar(--md-shape-action)

Controls connected small container shape.

--md-button-group-connected-small-inner-corner-corner-sizeShape
Fallbackvar(--md-sys-shape-corner-value-small)

Controls connected small inner corner corner size.

--md-button-group-connected-small-pressed-inner-corner-corner-sizeShape
Fallbackvar(--md-sys-shape-corner-value-extra-small)

Controls connected small pressed inner corner corner size.

--md-button-group-connected-small-selected-inner-corner-corner-sizeShape
Fallbackvar(--md-shape-action)

Controls connected small selected inner corner corner size.

--md-button-group-connected-xlarge-between-spaceLayout
Fallback0.125rem

Controls connected xlarge between space.

--md-button-group-connected-xlarge-container-heightLayout
Fallback8.5rem

Controls connected xlarge container height.

--md-button-group-connected-xlarge-container-shapeShape
Fallbackvar(--md-shape-action)

Controls connected xlarge container shape.

--md-button-group-connected-xlarge-inner-corner-corner-sizeShape
Fallbackvar(--md-sys-shape-corner-value-large-increased)

Controls connected xlarge inner corner corner size.

--md-button-group-connected-xlarge-pressed-inner-corner-corner-sizeShape
Fallbackvar(--md-sys-shape-corner-value-large)

Controls connected xlarge pressed inner corner corner size.

--md-button-group-connected-xlarge-selected-inner-corner-corner-sizeShape
Fallbackvar(--md-shape-action)

Controls connected xlarge selected inner corner corner size.

--md-button-group-connected-xsmall-between-spaceLayout
Fallback0.125rem

Controls connected xsmall between space.

--md-button-group-connected-xsmall-container-heightLayout
Fallback2rem

Controls connected xsmall container height.

--md-button-group-connected-xsmall-container-shapeShape
Fallbackvar(--md-shape-action)

Controls connected xsmall container shape.

--md-button-group-connected-xsmall-inner-corner-corner-sizeShape
Fallbackvar(--md-sys-shape-corner-value-small)

Controls connected xsmall inner corner corner size.

--md-button-group-connected-xsmall-pressed-inner-corner-corner-sizeShape
Fallbackvar(--md-sys-shape-corner-value-extra-small)

Controls connected xsmall pressed inner corner corner size.

--md-button-group-connected-xsmall-selected-inner-corner-corner-sizeShape
Fallbackvar(--md-shape-action)

Controls connected xsmall selected inner corner corner size.

--md-button-group-heightLayout
Fallbackinitial

Controls height.

--md-button-group-standard-large-between-spaceLayout
Fallback0.5rem

Controls standard large between space.

--md-button-group-standard-large-container-heightLayout
Fallback6rem

Controls standard large container height.

--md-button-group-standard-large-pressed-item-width-motion-spring-dampeningMotion
Fallbackvar(--md-sys-motion-spring-fast-spatial-damping)

Controls standard large pressed item width motion spring dampening.

--md-button-group-standard-large-pressed-item-width-motion-spring-stiffnessMotion
Fallbackvar(--md-sys-motion-spring-fast-spatial-stiffness)

Controls standard large pressed item width motion spring stiffness.

--md-button-group-standard-large-pressed-item-width-multiplierState
Fallback15%

Controls standard large pressed item width multiplier.

--md-button-group-standard-medium-between-spaceLayout
Fallback0.5rem

Controls standard medium between space.

--md-button-group-standard-medium-container-heightLayout
Fallback3.5rem

Controls standard medium container height.

--md-button-group-standard-medium-pressed-item-width-motion-spring-dampeningMotion
Fallbackvar(--md-sys-motion-spring-fast-spatial-damping)

Controls standard medium pressed item width motion spring dampening.

--md-button-group-standard-medium-pressed-item-width-motion-spring-stiffnessMotion
Fallbackvar(--md-sys-motion-spring-fast-spatial-stiffness)

Controls standard medium pressed item width motion spring stiffness.

--md-button-group-standard-medium-pressed-item-width-multiplierState
Fallback15%

Controls standard medium pressed item width multiplier.

--md-button-group-standard-small-between-spaceLayout
Fallback0.75rem

Controls standard small between space.

--md-button-group-standard-small-container-heightLayout
Fallback2.5rem

Controls standard small container height.

--md-button-group-standard-small-pressed-item-width-motion-spring-dampeningMotion
Fallbackvar(--md-sys-motion-spring-fast-spatial-damping)

Controls standard small pressed item width motion spring dampening.

--md-button-group-standard-small-pressed-item-width-motion-spring-stiffnessMotion
Fallbackvar(--md-sys-motion-spring-fast-spatial-stiffness)

Controls standard small pressed item width motion spring stiffness.

--md-button-group-standard-small-pressed-item-width-multiplierState
Fallback15%

Controls standard small pressed item width multiplier.

--md-button-group-standard-xlarge-between-spaceLayout
Fallback0.5rem

Controls standard xlarge between space.

--md-button-group-standard-xlarge-container-heightLayout
Fallback8.5rem

Controls standard xlarge container height.

--md-button-group-standard-xlarge-pressed-item-width-motion-spring-dampeningMotion
Fallbackvar(--md-sys-motion-spring-fast-spatial-damping)

Controls standard xlarge pressed item width motion spring dampening.

--md-button-group-standard-xlarge-pressed-item-width-motion-spring-stiffnessMotion
Fallbackvar(--md-sys-motion-spring-fast-spatial-stiffness)

Controls standard xlarge pressed item width motion spring stiffness.

--md-button-group-standard-xlarge-pressed-item-width-multiplierState
Fallback15%

Controls standard xlarge pressed item width multiplier.

--md-button-group-standard-xsmall-between-spaceLayout
Fallback1.125rem

Controls standard xsmall between space.

--md-button-group-standard-xsmall-container-heightLayout
Fallback2rem

Controls standard xsmall container height.

--md-button-group-standard-xsmall-pressed-item-width-motion-spring-dampeningMotion
Fallbackvar(--md-sys-motion-spring-fast-spatial-damping)

Controls standard xsmall pressed item width motion spring dampening.

--md-button-group-standard-xsmall-pressed-item-width-motion-spring-stiffnessMotion
Fallbackvar(--md-sys-motion-spring-fast-spatial-stiffness)

Controls standard xsmall pressed item width motion spring stiffness.

--md-button-group-standard-xsmall-pressed-item-width-multiplierState
Fallback15%

Controls standard xsmall pressed item width multiplier.

Examples

Default

Types

standard
connected

Sizes

extra-small
small
medium
large
extra-large

Colors

filled
tonal
outlined
text

Disabled

Multiple Selection

API

ButtonGroupItem

Props

NameDescriptionDefault
valueRequired

-

SelectionGroupValue
-
disabledOptional

-

boolean | undefined
false
ariaLabelOptional

-

string | undefined
-

Events0

No events documented.

Slots1

NameParametersDescription
default--