structyl

Backdrop

stable

A full-screen scrim for modal states.

Basic usage

Examples

Inline demonstration

Force mount the backdrop and override positioning when documenting or testing it inline.

Modal loading state

Use Backdrop behind blocking async work or low-level modal surfaces.

Loading

Invisible mode

Invisible backdrops keep blocking behavior while removing the scrim color.

Features

  • Open/closed mounting.
  • Theme-aware overlay.

Installation

bash
pnpm dlx structyl add backdrop

API Reference

Backdrop

Blocking scrim.

PropTypeDefault
openboolean

Open state.

false
forceMountboolean

Keep mounted when closed.

false
invisibleboolean

Remove visible scrim color.

false
classNamestring

Additional Tailwind classes merged with the component defaults.

Backdrop | structyl