Spectrum Components API

Schema version: 6.0.0

Button group

A button group is a grouping of buttons whose actions are related to each other.

PropertyValuesDefault valueRequired
orientation
horizontal / vertical
horizontal
size
s / m / l / xl
m
overflow mode
wrap / collapse
wrap
is disabled
yes / no
no
{
  "slug": "button-group",
  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/button-group.json",
  "title": "Button group",
  "description": "A button group is a grouping of buttons whose actions are related to each other.",
  "meta": {
    "category": "actions",
    "documentationUrl": "https://spectrum.adobe.com/page/button-group/"
  },
  "type": "object",
  "properties": {
    "orientation": {
      "type": "string",
      "default": "horizontal",
      "enum": [
        "horizontal",
        "vertical"
      ]
    },
    "size": {
      "type": "string",
      "pattern": "^(x?s|m|x{0,3}l)$",
      "enum": [
        "s",
        "m",
        "l",
        "xl"
      ],
      "default": "m"
    },
    "overflowMode": {
      "type": "string",
      "enum": [
        "wrap",
        "collapse"
      ],
      "default": "wrap"
    },
    "isDisabled": {
      "type": "boolean",
      "default": false
    }
  }
}
← Back to home