Spectrum Components API

Schema version: 6.0.0

Tag

Tags allow users to categorize content. They can represent keywords or people, and are grouped to describe an item or a search request.

PropertyValuesDefault valueRequired
label
text
-
has avatar
yes / no
no
is removable
yes / no
no
is error
yes / no
no
is disabled
yes / no
no
is read only
yes / no
no
state
default / hover / down / keyboard focus
default
{
  "slug": "tag",
  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/tag.json",
  "title": "Tag",
  "description": "Tags allow users to categorize content. They can represent keywords or people, and are grouped to describe an item or a search request.",
  "meta": {
    "category": "navigation",
    "documentationUrl": "https://spectrum.adobe.com/page/tag/"
  },
  "type": "object",
  "properties": {
    "label": {
      "type": "string"
    },
    "hasAvatar": {
      "type": "boolean",
      "default": false
    },
    "isRemovable": {
      "type": "boolean",
      "default": false
    },
    "isError": {
      "type": "boolean",
      "default": false
    },
    "isDisabled": {
      "type": "boolean",
      "default": false
    },
    "isReadOnly": {
      "type": "boolean",
      "default": false
    },
    "state": {
      "type": "string",
      "enum": [
        "default",
        "hover",
        "down",
        "keyboard focus"
      ],
      "default": "default"
    }
  }
}
← Back to home