Docs
πŸ—οΈ ⏐ Components
Layers
Backdrop

Backdrop


Backdrop is a component that overlays a certain viewport to prevent users from clicking the bottom layer and draw attention to the content. This component is typically used with a Overlay component.

API

src/layers/Backdrop/Backdrop.tsx (opens in a new tab)

PropDescriptionDefault
zIndexThe z-index of the backdrop.
number
998
portalIndexThe index of the portal.
number
0
classNameAdditional class names to apply to the backdrop.
string
onClickCallback for when the backdrop is clicked.
(event: MouseEvent<Element, MouseEvent>) => void