For AI agents: the complete documentation index is available at https://wallarm.github.io/design-system/llms.txt, the full documentation bundle is available at https://wallarm.github.io/design-system/llms-full.txt, and this page is available as Markdown at https://wallarm.github.io/design-system/components/overlay.md.

Overlay

The house scrim โ€” a fixed, dimmed, lightly blurred layer that mutes the page behind an elevated surface. Dialog, Drawer and Tour render it for you, so reach for those; a popover, tooltip or dropdown is non-modal and takes no scrim at all. It is presentation only: no focus trap, no click-to-dismiss, no scroll lock, and no className.

Source ยท Storybook

Usage

import { Overlay } from '@wallarm-org/design-system/Overlay';

Props

PropTypeDefaultDescription
titlestring | undefined
defaultCheckedboolean | undefined
defaultValuestring | number | readonly string[] | undefined
autoFocusboolean | undefined
idstring | undefined
tabIndexnumber | undefined
relstring | undefined
onChangeChangeEventHandler<T, Element> | undefined
data-testidstring | undefined