A tag represents a label, category, keyword, or filter, and can be used for various groupings. If you need multiple tags, consider using the TagGroup component.
A Tag uses the following components:
If you need multiple tags to describe an element, consider using the TagGroup component.
A tag can vary in size.
A tag can be disabled using the isDisabled prop.
A tag can vary in style using the variant prop.
A tag can be set as invalid using the isInvalid prop.
A tag can have a loading state using the isLoading prop.
A tag can contain an avatar.
A tag can contain an icon or an icon list.
A tag can contain a count using the Badge component.
A tag can be a link by using the href prop on the Tag component. Tags with an href are not selectable.
A tag can be rendered as a react router link when using the href prop and setting the navigate prop on the HopperProvider.
Whether the tag is invalid or not.
Whether the tag is loading or not.
The size of the tag.
The visual style of the Tag.
The props of the ClearButton.
The props of the Spinner.
The inline style for the element. A function may be provided to compute the style based on component state.
A unique id for the tag.
A string representation of the tags's contents, used for accessibility. Required if children is not a plain text string.
Whether the tag is disabled.
The children of the component. A function may be provided to alter the children based on component state.
The CSS className for the element. A function may be provided to compute the class based on component state.
A URL to link to. See MDN.
Hints at the human language of the linked URL. SeeMDN.
The target window for the link. See MDN.
The relationship between the linked resource and the current page. See MDN.
Causes the browser to download the linked URL. A string may be provided to suggest a file name. See MDN.
A space-separated list of URLs to ping when the link is followed. See MDN.
How much of the referrer to send when following the link. See MDN.
Options for the configured client side router.
Sets the background-color property.
If you want to use a token value from the SCALE, use the backgroundColor property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the background-color property when active.
If you want to use a token value from the SCALE, use the backgroundColorActive property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the background-color property when focused.
If you want to use a token value from the SCALE, use the backgroundColorFocus property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the background-color property when hovered.
If you want to use a token value from the SCALE, use the backgroundColorHover property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border property.
If you want to use a token value from the SCALE, use the border property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border property when active.
If you want to use a token value from the SCALE, use the borderActive property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-bottom property.
If you want to use a token value from the SCALE, use the borderBottom property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-bottom property when active.
If you want to use a token value from the SCALE, use the borderBottomActive property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-bottom property when focused.
If you want to use a token value from the SCALE, use the borderBottomFocus property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-bottom property when hovered.
If you want to use a token value from the SCALE, use the borderBottomHover property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-bottom-left-radius property.
If you want to use a token value from the SCALE, use the borderBottomLeftRadius property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-bottom-right-radius property.
If you want to use a token value from the SCALE, use the borderBottomRightRadius property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border property when focused.
If you want to use a token value from the SCALE, use the borderFocus property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border property when hovered.
If you want to use a token value from the SCALE, use the borderHover property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-left property.
If you want to use a token value from the SCALE, use the borderLeft property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-left property when active.
If you want to use a token value from the SCALE, use the borderLeftActive property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-left property when focused.
If you want to use a token value from the SCALE, use the borderLeftFocus property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-left property when hovered.
If you want to use a token value from the SCALE, use the borderLeftHover property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-radius property.
If you want to use a token value from the SCALE, use the borderRadius property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-right property.
If you want to use a token value from the SCALE, use the borderRight property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-right property when active.
If you want to use a token value from the SCALE, use the borderRightActive property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-right property when focused.
If you want to use a token value from the SCALE, use the borderRightFocus property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-right property when hovered.
If you want to use a token value from the SCALE, use the borderRightHover property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-top property.
If you want to use a token value from the SCALE, use the borderTop property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-top property when active.
If you want to use a token value from the SCALE, use the borderTopActive property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-top property when focused.
If you want to use a token value from the SCALE, use the borderTopFocus property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-top property when hovered.
If you want to use a token value from the SCALE, use the borderTopHover property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-top-left-radius property.
If you want to use a token value from the SCALE, use the borderTopLeftRadius property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the border-top-right-radius property.
If you want to use a token value from the SCALE, use the borderTopRightRadius property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the box-shadow property.
If you want to use a token value from the SCALE, use the boxShadow property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the box-shadow property when active.
If you want to use a token value from the SCALE, use the boxShadowActive property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the box-shadow property when focused.
If you want to use a token value from the SCALE, use the boxShadowFocus property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the box-shadow property when hovered.
If you want to use a token value from the SCALE, use the boxShadowHover property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the color property.
If you want to use a token value from the SCALE, use the color property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the color property when active.
If you want to use a token value from the SCALE, use the colorActive property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the color property when focused.
If you want to use a token value from the SCALE, use the colorFocus property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the color property when hovered.
If you want to use a token value from the SCALE, use the colorHover property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the column-gap property.
If you want to use a token value from the SCALE, use the columnGap property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the fill property.
If you want to use a token value from the SCALE, use the fill property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the fill property when focused.
If you want to use a token value from the SCALE, use the fillFocus property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the fill property when hovered.
If you want to use a token value from the SCALE, use the fillHover property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the font-family property.
If you want to use a token value from the SCALE, use the fontFamily property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the font-size property.
If you want to use a token value from the SCALE, use the fontSize property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the font-weight property.
If you want to use a token value from the SCALE, use the fontWeight property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the gap property.
If you want to use a token value from the SCALE, use the gap property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the grid-auto-columns property.
If you want to use a token value from the SCALE, use the gridAutoColumns property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the grid-auto-rows property.
If you want to use a token value from the SCALE, use the gridAutoRows property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the grid-column-span property.
If you want to use a token value from the SCALE, use the gridColumnSpan property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the grid-row-span property.
If you want to use a token value from the SCALE, use the gridRowSpan property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the grid-template-columns property.
If you want to use a token value from the SCALE, use the gridTemplateColumns property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the grid-template-rows property.
If you want to use a token value from the SCALE, use the gridTemplateRows property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the height property.
If you want to use a token value from the SCALE, use the height property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the line-height property.
If you want to use a token value from the SCALE, use the lineHeight property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the margin property.
If you want to use a token value from the SCALE, use the margin property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the margin-bottom property.
If you want to use a token value from the SCALE, use the marginBottom property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the margin-left property.
If you want to use a token value from the SCALE, use the marginLeft property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the margin-right property.
If you want to use a token value from the SCALE, use the marginRight property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the margin-top property.
If you want to use a token value from the SCALE, use the marginTop property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the horizontal margin (margin-left and margin-right) property.
If you want to use a token value from the SCALE, use the marginX property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the vertical margin (margin-top and margin-bottom) property.
If you want to use a token value from the SCALE, use the marginY property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the max-height property.
If you want to use a token value from the SCALE, use the maxHeight property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the max-width property.
If you want to use a token value from the SCALE, use the maxWidth property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the min-height property.
If you want to use a token value from the SCALE, use the minHeight property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the min-width property.
If you want to use a token value from the SCALE, use the minWidth property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the padding property.
If you want to use a token value from the SCALE, use the padding property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the padding-bottom property.
If you want to use a token value from the SCALE, use the paddingBottom property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the padding-left property.
If you want to use a token value from the SCALE, use the paddingLeft property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the padding-right property.
If you want to use a token value from the SCALE, use the paddingRight property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the padding-top property.
If you want to use a token value from the SCALE, use the paddingTop property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the horizontal padding (padding-left and padding-right) property.
If you want to use a token value from the SCALE, use the paddingX property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the vertical padding (padding-top and padding-bottom) property.
If you want to use a token value from the SCALE, use the paddingY property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the row-gap property.
If you want to use a token value from the SCALE, use the rowGap property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the stroke property.
If you want to use a token value from the SCALE, use the stroke property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Sets the width property.
If you want to use a token value from the SCALE, use the width property instead.
This property is marked as UNSAFE because you're opting out of the intended values of the design system.
Handler that is called when a hover interaction starts.
Handler that is called when a hover interaction ends.
Handler that is called when the hover state changes.
Coming from Orbiter, you should be aware of the following changes:
fluid is not supported.variant values are now neutral | subdued | progress | positive | caution | negative | option1 | option2 | option3 | option4 | option5 | option6 and not solid | outline.validationState is not supported. Use isInvalid instead.