Checkbox group

A checkbox group is a grouping of checkboxes that are related to each other.

Property	Values	Default value
label	text	-
label position	top / side	top
necessity indicator	text / icon	icon
is required	yes / no	no
orientation	horizontal / vertical	vertical
is error	yes / no	no
is disabled	yes / no	no
description	text	-
error message	text	-

{
  "slug": "checkbox-group",
  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/checkbox-group.json",
  "title": "Checkbox group",
  "description": "A checkbox group is a grouping of checkboxes that are related to each other.",
  "meta": {
    "category": "inputs",
    "documentationUrl": "https://spectrum.adobe.com/page/checkbox-group/"
  },
  "type": "object",
  "properties": {
    "label": {
      "type": "string"
    },
    "labelPosition": {
      "type": "string",
      "enum": [
        "top",
        "side"
      ],
      "default": "top"
    },
    "necessityIndicator": {
      "type": "string",
      "enum": [
        "text",
        "icon"
      ],
      "default": "icon"
    },
    "isRequired": {
      "type": "boolean",
      "default": false
    },
    "orientation": {
      "type": "string",
      "enum": [
        "horizontal",
        "vertical"
      ],
      "default": "vertical"
    },
    "isError": {
      "type": "boolean",
      "default": false
    },
    "isDisabled": {
      "type": "boolean",
      "default": false
    },
    "description": {
      "type": "string"
    },
    "errorMessage": {
      "type": "string"
    }
  }
}