Using QOverlay

QOverlay provides a lightweight way to block interaction while a task is running. It can cover the whole viewport or wrap a single component so the rest of the page remains usable.

API

Loading QOverlay API...

Fullscreen Overlay

Use fullscreen mode when a task should temporarily block the entire page. Leave the default slot empty and place visible content in the body slot.

The live docs preview scopes the overlay to a contained app surface so it does not block the docs page itself.

Fullscreen Overlay


Component Overlay

Wrap a card, form, table, or panel with QOverlay when only that surface should be blocked.

Component Overlay


Background Color

Tune the visual weight with background-color and opacity.

Background Color


Button With Menu

QOverlay also works well as a short-lived transition while remote data loads before revealing follow-up UI.

Button With Menu


Add a separate backdrop overlay while a menu is open, without moving the QMenu away from its trigger button.

Menu Backdrop