Overlay
Overlays provide contextual information on top of the current layer of the interface.
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
Example
Code
A content outside me
Import
Import the component from @faststore/ui
_10import { 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:
_10@import '@faststore/ui/src/components/atoms/Overlay/styles.scss';
Follow the instructions in the Importing FastStore UI component styles tutorial.
Usage
A content outside me
_10<div>_10 A content outside me_10 <Overlay/>_10</div>
Props
| Name | Type | Description | Default |
|---|---|---|---|
| testId | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-overlay |
Design Tokens
| Local token | Default 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