🎉 We are thrilled to introduce FastStore v2. If you are looking for documentation of the previous version of FastStore, please refer to FastStore v1.

Overlay

Overlays provide contextual information on top of the current layer of the interface. They can be interruptive like modals or augmenting like popovers and tooltips.

Overview


Import

Import the component from @faststore/ui

import { Overlay } from '@faststore/ui'

Import Styles

import '@faststore/ui/src/components/atoms/Overlay/styles.scss'

Usage

A content outside me

<div>
  A content outside me
  <Overlay />
</div>

Props

NameTypeDescriptionDefault
testIdstringID to find this component in testing tools (e.g.: cypress, testing library, and jest).fs-overlay

Design Tokens

Local tokenDefault value/Global token linked
--fs-overlay-bkg-color
rgb(0 0 0 / 20%)

Customization

For further customization, you can use the following data attributes:

data-fs-overlay