Tag
Importing
Add rh-tag to your page with this import statement:
<script type="module">
import '@rhds/elements/rh-tag/rh-tag.js';
</script>To learn more about installing RHDS elements on your site using an import map read our getting started docs.
Usage
<rh-tag>Tag</rh-tag>
<script type="module">
import '@rhds/elements/rh-tag/rh-tag.js';
</script>rh-tag
A tag is a caption added to an element for better clarity and user convenience.
| Slot Name | Summary | Description |
|---|---|---|
|
Must contain the text for the label. |
|
icon |
Contains the labels's icon, e.g. web-icon-alert-success. |
| Attribute | DOM Property | Description | Type | Default |
|---|---|---|---|---|
icon |
icon |
The icon to display in the label. |
|
|
icon-set |
iconSet |
Icon set to display in the label |
|
|
variant |
variant |
The variant of the label. |
|
|
size |
size |
The variant of the label. |
|
|
href |
href |
optional href for linked tag. |
|
|
color |
color |
The color of the label. Note: 'cyan' will also work, but is deprecated |
|
|
| Event Name | Description |
|---|---|
close |
when a removable label's close button is clicked |
| Part Name | Summary | Description |
|---|---|---|
icon |
container for the label icon |
| CSS Property | Description | Default |
|---|---|---|
--rh-tag-margin-inline-end |
4px
|
|
--rh-tag-padding-block-start |
4px
|
|
--rh-tag-padding-block-end |
4px
|
|
--rh-tag-padding-inline-start |
8px
|
|
--rh-tag-padding-inline-end |
8px
|
|
--rh-tag-padding-block-start |
0
|
|
--rh-tag-padding-inline-end |
var(--rh-space-md, 8px)
|
|
--rh-tag-padding-block-end |
0
|
|
--rh-tag-padding-inline-start |
var(--rh-space-md, 8px)
|
| Token | Copy |
|---|---|
--rh-space-xs
|
|
--rh-font-family-body-text
|
|
--rh-font-weight-body-text-regular
|
|
--rh-font-size-body-text-sm
|
|
--rh-line-height-body-text
|
|
--rh-color-surface-lighter
|
|
--rh-size-icon-01
|
|
--rh-border-radius-pill
|
|
--rh-border-width-sm
|
|
--rh-color-border-subtle
|
|
--rh-border-width-md
|
|
--rh-font-size-body-text-xs
|
|
--rh-space-md
|
|
--rh-color-red-50
|
|
--rh-color-red-70
|
|
--rh-color-red-10
|
|
--rh-color-red-20
|
|
--rh-color-red-60
|
|
--rh-color-red-30
|
|
--rh-color-red-orange-50
|
|
--rh-color-red-orange-70
|
|
--rh-color-red-orange-10
|
|
--rh-color-red-orange-20
|
|
--rh-color-red-orange-60
|
|
--rh-color-red-orange-30
|
|
--rh-color-orange-50
|
|
--rh-color-orange-70
|
|
--rh-color-orange-10
|
|
--rh-color-orange-20
|
|
--rh-color-orange-60
|
|
--rh-color-orange-30
|
|
--rh-color-yellow-50
|
|
--rh-color-yellow-70
|
|
--rh-color-yellow-10
|
|
--rh-color-yellow-20
|
|
--rh-color-yellow-60
|
|
--rh-color-yellow-30
|
|
--rh-color-green-50
|
|
--rh-color-green-70
|
|
--rh-color-green-10
|
|
--rh-color-green-20
|
|
--rh-color-green-60
|
|
--rh-color-green-30
|
|
--rh-color-teal-50
|
|
--rh-color-teal-70
|
|
--rh-color-teal-10
|
|
--rh-color-teal-20
|
|
--rh-color-teal-60
|
|
--rh-color-teal-30
|
|
--rh-color-blue-50
|
|
--rh-color-blue-70
|
|
--rh-color-blue-10
|
|
--rh-color-blue-20
|
|
--rh-color-blue-60
|
|
--rh-color-blue-30
|
|
--rh-color-purple-50
|
|
--rh-color-purple-70
|
|
--rh-color-purple-10
|
|
--rh-color-purple-20
|
|
--rh-color-purple-60
|
|
--rh-color-purple-30
|
|
--rh-color-gray-70
|
|
--rh-color-gray-10
|
|
--rh-color-gray-20
|
|
--rh-color-gray-60
|
|
--rh-color-white
|
|
--rh-color-gray-95
|
|
--rh-color-gray-30
|
|
--rh-color-gray-50
|
|
--rh-color-text-primary
|
|
Other libraries
To learn more about our other libraries, visit this page.
Feedback
To give feedback about anything on this page, contact us.
