Documentation
Feedback
Guides
Storefront Development

Storefront Development
Storefront development
Alert

Displays short messages related to the behavior of a system, feature, or page.

Example
Code

Dismissible Alert message

With Link

Alert message

With Link

Icon with Alert message

Alert message


Usage

Import the component


_10
import { Alert } from "@faststore/ui";

Import styles

To apply styles, include the following in your stylesheet:

_10
@import "@faststore/ui/src/components/atoms/Alert/styles.scss";


Examples

Dismissible

Example
Code

Get 10% off today: NEW10

Example
Code

Get 10% off today: NEW10

Buy now

With Icon

Example
Code

Get 10% off today: NEW10

Plain

Example
Code

Get 10% off today: NEW10


Design tokens

Local tokenDefault value/Global token linked
--fs-alert-heightvar(--fs-spacing-7)
--fs-alert-padding-leftvar(--fs-spacing-3)
--fs-alert-padding-rightvar(--fs-alert-padding-left)
--fs-alert-bkg-color
var(--fs-color-highlighted-bkg)
--fs-alert-text-color
var(--fs-color-highlighted-text)
--fs-alert-text-sizevar(--fs-text-size-1)

Desing tokens: Icon

Local tokenDefault value/Global token linked
--fs-alert-icon-widthvar(--fs-spacing-4)
--fs-alert-icon-heightvar(--fs-alert-icon-width)
--fs-alert-icon-margin-rightvar(--fs-spacing-1)
--fs-alert-icon-color
var(--fs-alert-text-color)
Local tokenDefault value/Global token linked
--fs-alert-link-color
var(--fs-alert-text-color)
--fs-alert-link-color-visited
var(--fs-alert-text-color)

Design tokens: Dismissible

Local tokenDefault value/Global token linked
--fs-alert-button-text-color
var(--fs-alert-text-color)
--fs-alert-button-bkg-color
var(--fs-alert-bkg-color)
--fs-alert-button-border-radiusvar(--fs-border-radius)

Data attributes

You can target and override Alert styles using the following data attributes:
data-fs-alert
data-fs-alert-content
data-fs-alert-link
data-fs-alert-button
data-fs-alert-dismissible="true"

Props

NameTypeDescriptionDefault
testIdstringID to find this component in testing tools (e.g.: cypress, testing-library, and jest).fs-alert
iconstring | number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortalIcon component for additional customization.
dismissiblefalse | trueEnables dismissible feature.
linkLinkProps<"a">Extends all Link Props.
onClose(event: MouseEvent<HTMLElement, MouseEvent>) => voidFunction called when dismiss button is clicked.

Best Practices

✅ Do's

  • Write short messages to inform about the behavior of a system, feature, or page. Consider using 30 to 40 characters max.

❌ Don'ts

  • Don't use long texts. Important information can be lost.
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