Documentation
Feedback
Guides
Storefront Development

Storefront Development
Storefront development
Tag

Interactive badges.

The Tag component is an interactive Badge. By default, its have a close button.
Example
Code
Tag
Warning Tag
Danger Tag
Neutral & Big

Usage

Import the component


_10
import { Tag } from '@faststore/ui'

Import styles

To apply styles, include the following in your stylesheet:

_10
@import '@faststore/ui/src/components/molecules/Tag/styles.scss';


Design tokens

Local tokenDefault value/Global token linked
--fs-tag-text-color
var(--fs-color-text)
--fs-tag-icon-sizevar(--fs-spacing-4)
--fs-tag-icon-stroke-widthvar(--fs-spacing-4)

Data attributes

You can target and override Tag styles using the following data attributes:
data-fs-tag
data-fs-tag-label
data-fs-tag-icon-button
This component inherits Badge CSS selectors and styles.

Props

NameTypeDescriptionDefault
testIdstringID to find this component in testing tools (e.g.: cypress, testing library, and jest).fs-tag
label*stringThe text displayed inside the tag.
iconstring | number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortalA React component that will be rendered as an icon.
iconButtonLabelstringFor accessibility purposes, provide an ARIA label to the Icon button
onClose*() => voidFunction called when Icon button is clicked.
size"small" | "big"Specifies the size variant.
variant"info" | "highlighted" | "success" | "neutral" | "warning" | "danger"Specifies the component variant.
counterfalse | trueEnables counter badge.
aria-labelstringFor accessibility purposes, adds an ARIA label to the element when `counter` is set to `true`.

Best Practices

✅ Do's

  • Be cautious about the tag's positioning, writing, shape, and color to avoid any confusion with components similar in appearance.

❌ Don'ts

  • Don't use long texts in tags.
  • Don't use color alone to convey information. If color is needed to convey meaning, ensure there is a text alternative for that meaning as well.

Accessibility

  • Text elements must have sufficient color contrast against the background.
Contributors
3
Photo of the contributor
Photo of the contributor
Photo of the contributor
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
3
Photo of the contributor
Photo of the contributor
Photo of the contributor
On this page