⚠️ After March 18, 2024, the FastStore documentation will be migrated to the Developer Portal. For more information, access the official release note.

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 into your FastStore project

To apply the styles of this component in your FastStore project, import the following into your stylesheet:

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

Follow the instructions in the Importing FastStore UI component styles tutorial.


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