A small colored label for categories or filters.
Live example
These are real Tag blocks rendering on this page right now. Tab to them and try them in both color schemes.
WCAG 2.2 AA
Open source
Region: us-east
Dark mode you don’t have to build
Every block supports dark mode. Use the light/dark toggle in the header and the live example above switches with it.
Parameters
Everything the Tag block accepts. Setting is the label you see in the block’s settings panel. Parameter is what the same value is called in code. Accepts is what you can put in it.
| Setting | Parameter | Type | Default | Accepts | What it does |
|---|---|---|---|---|---|
| Typed on the block | text | string | “Tag” | Any text | The visible text. |
| Color | type | string | “gray” | red, magenta, purple, blue, cyan, teal, green, gray, cool-gray, warm-gray, high-contrast, outline | The tag’s color, from Carbon’s tag palette. Every pairing meets contrast requirements. |
| Size | size | string | “md” | sm, md, lg | The control height. |
| Filter (dismissible) | filter | boolean | false | true or false | Adds a dismiss button that removes the tag, for removable filter tags. The button names the tag it removes. |
| URL (makes the tag a link) | href | string | empty | A URL | Makes the tag a link. |
| Target | target | string | empty | empty, _blank | Where the link opens, for example _blank for a new tab. A link that opens a new tab tells screen reader users so. |
| Link relationship | rel | string | empty | Any text | The link’s rel attribute, for example nofollow. Set it only when you need to control it yourself. |
Accessibility parameters, on this and every AWT block
Every AWT block has an Accessibility panel in its settings. Each control in it becomes a real HTML attribute on the block’s outer element:
| Setting | Parameter | What it does |
|---|---|---|
| Accessible name (aria-label) | ariaLabel | Becomes aria-label on the block’s outer element. Replaces the accessible name screen readers announce. Set it only when the visible label is not enough. |
| Described by (aria-describedby) | ariaDescribedby | Becomes aria-describedby. Point it at the ID of another element on the page whose text adds a longer description. |
| Labelled by (aria-labelledby) | ariaLabelledby | Becomes aria-labelledby. Point it at the ID of another element whose text should become this block’s accessible name. |
| Role | awtRole | Becomes the role attribute. Overrides the element’s ARIA role. The list offers only roles that suit the element. |
| Language (lang) | awtLang | Becomes the lang attribute. Set it when this block’s content is in a different language from the page, as a BCP-47 code like “fr”. |