Spectrum Components API

Schema version: 6.0.0

Tag field

A tag field is an input field that allows users to enter and manage tags.

PropertyValuesDefault valueRequired
size
s / m / l
m
state
default / hover / focus + hover / focus + not hover / keyboard focus
default
style
keyword / icon / thumbnail / avatar
keyword
is disabled
yes / no
no
hide label
yes / no
no
{
  "slug": "tag-field",
  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/tag-field.json",
  "title": "Tag field",
  "description": "A tag field is an input field that allows users to enter and manage tags.",
  "meta": {
    "category": "inputs",
    "documentationUrl": "https://spectrum.adobe.com/page/tag-field/"
  },
  "type": "object",
  "properties": {
    "size": {
      "type": "string",
      "enum": [
        "s",
        "m",
        "l"
      ],
      "default": "m"
    },
    "state": {
      "type": "string",
      "enum": [
        "default",
        "hover",
        "focus + hover",
        "focus + not hover",
        "keyboard focus"
      ],
      "default": "default"
    },
    "style": {
      "type": "string",
      "enum": [
        "keyword",
        "icon",
        "thumbnail",
        "avatar"
      ],
      "default": "keyword"
    },
    "isDisabled": {
      "type": "boolean",
      "default": false
    },
    "hideLabel": {
      "type": "boolean",
      "default": false
    }
  }
}
← Back to home