Spectrum Components API

Schema version: 6.0.0

Radio Group

A radio group is a grouping of radio buttons that are related to each other.

PropertyValuesDefault valueRequired
label
text
-
label position
top / side
top
orientation
horizontal / vertical
vertical
size
s / m / l / xl
m
is emphasized
yes / no
no
necessity indicator
text / icon
icon
is required
yes / no
no
is error
yes / no
no
is disabled
yes / no
no
error message
text
-
description
text
-
{
  "slug": "radio-group",
  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/radio-group.json",
  "title": "Radio Group",
  "description": "A radio group is a grouping of radio buttons that are related to each other.",
  "meta": {
    "category": "inputs",
    "documentationUrl": "https://spectrum.adobe.com/page/radio-group/"
  },
  "type": "object",
  "properties": {
    "label": {
      "type": "string"
    },
    "labelPosition": {
      "type": "string",
      "enum": [
        "top",
        "side"
      ],
      "default": "top"
    },
    "orientation": {
      "type": "string",
      "enum": [
        "horizontal",
        "vertical"
      ],
      "default": "vertical"
    },
    "size": {
      "type": "string",
      "enum": [
        "s",
        "m",
        "l",
        "xl"
      ],
      "default": "m"
    },
    "isEmphasized": {
      "type": "boolean",
      "default": false
    },
    "necessityIndicator": {
      "type": "string",
      "enum": [
        "text",
        "icon"
      ],
      "default": "icon"
    },
    "isRequired": {
      "type": "boolean",
      "default": false
    },
    "isError": {
      "type": "boolean",
      "default": false
    },
    "isDisabled": {
      "type": "boolean",
      "default": false
    },
    "errorMessage": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  }
}
← Back to home