Overlay

Screen overlay and scrim primitive for modal content.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Overlay } from "@tavojs/ui/overlay";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/overlay.

When to use

Use it when

Use `Overlay` for centered overlay content and scrims

Choose something else when

Avoid Overlay when using feedback components as primary page layout.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Overlay example

TSXCreate: src/components/examples/OverlayExample1.tsx

tsximport { Overlay } from "@tavojs/ui/overlay";
import { Spinner } from "@tavojs/ui";

export function OverlayExample1() {
  return (
    <>
      <Overlay open><Spinner /></Overlay>
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`open`	`boolean`	—	Configures open for this component.
`scrim`	`"soft" \| "strong" \| "none"`	—	Configures scrim for this component.
`center`	`boolean`	—	Configures center for this component.

Complete TypeScript API

Import from @tavojs/ui/overlay. Published exports: Overlay, OverlayProps.

`OverlayProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Overlay.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Overlay.
`id`	`string`	No	Inherited id attribute accepted by Overlay.
`role`	`string`	No	Inherited role attribute accepted by Overlay.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Overlay.
`title`	`string`	No	Inherited title attribute accepted by Overlay.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Overlay.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Overlay.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Overlay.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Overlay.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Overlay.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Overlay.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Overlay.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Overlay.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Overlay.
`open`	`boolean`	No	Configures open for this component.
`scrim`	`"none" \| "strong" \| "soft"`	No	Configures scrim for this component.
`center`	`boolean`	No	Configures center for this component.

State ownership and DOM target

Concern	Contract
State	Use open to supply rendered state. Update it through the documented callback or native event handler.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Overlay when using feedback components as primary page layout.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Feedback components should announce status changes and manage focus only when the component owns that behavior.

Use Dialog, Sheet, or FocusTrap for modal workflows.
Use Toast or native live-region semantics for dynamic announcements.
Make dismiss and escape behavior clear for overlays.

Component status

Contract	Current value
Maturity	stable
Category	feedback
Component import	`@tavojs/ui/overlay`
Explicit CSS import	`@tavojs/ui/css/overlay`
Preview	Interactive preview available on this page