Tag group - Spectrum CSS

Theme

Scale

Direction

Vars Version

Component status	Contribution
Current version	@spectrum-css/taggroup@5.1.3
Released	September 13, 2024
S2-foundations	@spectrum-css/taggroup@6.0.0-s2-foundations.15
Released	October 4, 2024

Usage notes

A group of tags. Tags allow users to categorize content. They can represent keywords or people, and are grouped to describe an item or a search request. When horizontal space is limited in a tag group, the individual tags wrap to form another line.

Variants

Standard
Contribution

Show markup

<div class="spectrum-TagGroup" role="list" aria-label="list">
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item" role="listitem" tabindex="0">
    <span class="spectrum-Tag-itemLabel">Tag 1</span>
  </div>
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item is-disabled" role="listitem">
    <span class="spectrum-Tag-itemLabel">Tag 2</span>
  </div>
</div>

<br><br>

<div class= "spectrum-TagGroup" role="list" aria-label="Tags">
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item" role="listitem" tabindex="0">
    <div class="spectrum-Avatar spectrum-Avatar--size50">
      <img class="spectrum-Avatar-image" src="img/example-ava.jpg" alt="Avatar">
    </div>
    <span class="spectrum-Tag-itemLabel">Shantanu</span>
  </div>
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item is-disabled" role="listitem">
    <div class="spectrum-Avatar spectrum-Avatar--size50">
      <img class="spectrum-Avatar-image" src="img/example-ava.jpg" alt="Avatar">
    </div>
    <span class="spectrum-Tag-itemLabel">Shantanu</span>
  </div>
</div>

<br><br>

<div class= "spectrum-TagGroup" role="list" aria-label="Tags">
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item" role="listitem" tabindex="0">
    <svg class="spectrum-Icon spectrum-Icon--sizeS spectrum-Tag-itemIcon" focusable="false" aria-hidden="true" aria-label="Tag">
      <use xlink:href="#spectrum-icon-18-CheckmarkCircle" />
    </svg>
    <span class="spectrum-Tag-itemLabel">Shantanu</span>
  </div>
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item is-invalid" role="listitem" tabindex="0">
      <svg class="spectrum-Icon spectrum-Icon--sizeS spectrum-Tag-itemIcon" focusable="false" aria-hidden="true" aria-label="Tag">
        <use xlink:href="#spectrum-icon-24-Alert" />
      </svg>
    <span class="spectrum-Tag-itemLabel">Shantanu</span>
  </div>
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item is-disabled" role="listitem">
    <svg class="spectrum-Icon spectrum-Icon--sizeS spectrum-Tag-itemIcon" focusable="false" aria-hidden="true" aria-label="Tag">
      <use xlink:href="#spectrum-icon-18-CheckmarkCircle" />
    </svg>
    <span class="spectrum-Tag-itemLabel">Shantanu</span>
  </div>
</div>

Removable
Contribution

An editable taglist.

Show markup

<div class= "spectrum-TagGroup" role="list" aria-label="Tags">
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item spectrum-Tag--removable" tabindex="0" role="listitem">
    <span class="spectrum-Tag-itemLabel">Tag 1</span>
    <button type="button" class="spectrum-ClearButton spectrum-ClearButton--sizeS spectrum-Tag-clearButton" aria-label="Remove tag 1" tabindex="-1">
      <div class="spectrum-ClearButton-fill">
       <svg class="spectrum-ClearButton-icon spectrum-Icon spectrum-UIIcon-Cross75" focusable="false" aria-hidden="true">
          <use xlink:href="#spectrum-css-icon-Cross75" />
        </svg>
      </div>
    </button>
  </div>
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item spectrum-Tag--removable is-disabled" role="listitem">
    <span class="spectrum-Tag-itemLabel">Tag 2</span>
    <button type="button" class="spectrum-ClearButton spectrum-ClearButton--sizeS spectrum-Tag-clearButton" aria-label="Remove tag 3" tabindex="-1" disabled>
      <div class="spectrum-ClearButton-fill">
        <svg class="spectrum-ClearButton-icon spectrum-Icon spectrum-UIIcon-Cross75" focusable="false" aria-hidden="true">
          <use xlink:href="#spectrum-css-icon-Cross75" />
        </svg>
      </div>
    </button>
  </div>
</div>

<br><br>

<div class= "spectrum-TagGroup" role="list" aria-label="Tags">
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item spectrum-Tag--removable" role="listitem" tabindex="0">
    <div class="spectrum-Avatar spectrum-Avatar--size50">
      <img class="spectrum-Avatar-image" src="img/example-ava.jpg" alt="Avatar">
    </div>
    <span class="spectrum-Tag-itemLabel">Shantanu</span>
    <button type="button" class="spectrum-ClearButton spectrum-ClearButton--sizeS spectrum-Tag-clearButton" aria-label="Remove tag 2" tabindex="-1">
      <div class="spectrum-ClearButton-fill">
        <svg class="spectrum-ClearButton-icon spectrum-Icon spectrum-UIIcon-Cross75" focusable="false" aria-hidden="true">
          <use xlink:href="#spectrum-css-icon-Cross75" />
        </svg>
      </div>
    </button>
  </div>
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item spectrum-Tag--removable is-disabled" role="listitem">
    <div class="spectrum-Avatar spectrum-Avatar--size50">
      <img class="spectrum-Avatar-image" src="img/example-ava.jpg" alt="Avatar">
    </div>
    <span class="spectrum-Tag-itemLabel">Shantanu</span>
    <button type="button" class="spectrum-ClearButton spectrum-ClearButton--sizeS spectrum-Tag-clearButton" aria-label="Remove tag 3" tabindex="-1" disabled>
      <div class="spectrum-ClearButton-fill">
        <svg class="spectrum-ClearButton-icon spectrum-Icon spectrum-UIIcon-Cross75" focusable="false" aria-hidden="true">
          <use xlink:href="#spectrum-css-icon-Cross75" />
        </svg>
      </div>
    </button>
  </div>
</div>

<br><br>

<div class= "spectrum-TagGroup" role="list" aria-label="Tags">
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item spectrum-Tag--removable" role="listitem" tabindex="0">
    <svg class="spectrum-Icon spectrum-Icon--sizeS spectrum-Tag-itemIcon" focusable="false" aria-hidden="true" aria-label="Tag">
      <use xlink:href="#spectrum-icon-18-CheckmarkCircle" />
    </svg>
    <span class="spectrum-Tag-itemLabel">Shantanu</span>
    <button type="button" class="spectrum-ClearButton spectrum-ClearButton--sizeS spectrum-Tag-clearButton" aria-label="Remove tag Shantanu" tabindex="-1">
      <div class="spectrum-ClearButton-fill">
        <svg class="spectrum-ClearButton-icon spectrum-Icon spectrum-UIIcon-Cross75" focusable="false" aria-hidden="true">
          <use xlink:href="#spectrum-css-icon-Cross75" />
        </svg>
      </div>
    </button>
  </div>
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item spectrum-Tag--removable is-invalid" role="listitem" tabindex="0">
    <svg class="spectrum-Icon spectrum-Icon--sizeS spectrum-Tag-itemIcon" focusable="false" aria-hidden="true" aria-label="Tag">
      <use xlink:href="#spectrum-icon-24-Alert" />
    </svg>
    <span class="spectrum-Tag-itemLabel">Shantanu</span>
    <button type="button" class="spectrum-ClearButton spectrum-ClearButton--sizeS spectrum-Tag-clearButton" aria-label="Remove tag Shantanu" tabindex="-1">
      <div class="spectrum-ClearButton-fill">
        <svg class="spectrum-ClearButton-icon spectrum-Icon spectrum-UIIcon-Cross75" focusable="false" aria-hidden="true">
          <use xlink:href="#spectrum-css-icon-Cross75" />
        </svg>
      </div>
    </button>
  </div>
  <div class="spectrum-Tag spectrum-Tag--sizeS spectrum-TagGroup-item spectrum-Tag--removable is-disabled" role="listitem">
    <svg class="spectrum-Icon spectrum-Icon--sizeS spectrum-Tag-itemIcon" focusable="false" aria-hidden="true" aria-label="Tag">
      <use xlink:href="#spectrum-icon-18-CheckmarkCircle" />
    </svg>
    <span class="spectrum-Tag-itemLabel">Shantanu</span>
    <button type="button" class="spectrum-ClearButton spectrum-ClearButton--sizeS spectrum-Tag-clearButton" aria-label="Remove tag Shantanu" tabindex="-1" disabled>
      <div class="spectrum-ClearButton-fill">
        <svg class="spectrum-ClearButton-icon spectrum-Icon spectrum-UIIcon-Cross75" focusable="false" aria-hidden="true">
          <use xlink:href="#spectrum-css-icon-Cross75" />
        </svg>
      </div>
    </button>
  </div>
</div>

Custom Properties API

This component can be modified via its --mod-* prefixed custom properties. A list of those prefixed custom properties can be found here.

Migration Guide

Updated tag classes

The examples now use the latest markup from the tag component. This includes additional classes:

spectrum-Tag-itemLabel
spectrum-Tag-itemIcon
spectrum-Tag-clearButton

A div wrapper is required for avatar

<div class="spectrum-Avatar spectrum-Avatar--size50">
  <img class="spectrum-Avatar-image" src="img/example-ava.jpg" alt="Avatar">
</div>

Icon size changed to small

If you use an icon (spectrum-Tag-itemIcon) along with a tag, please replace .spectrum-Icon--sizeXS with .spectrum-Icon--sizeS.

Spectrum CSS

StandardContribution

RemovableContribution

Standard
Contribution

Removable
Contribution