Methane@methane-ui/*
CSS LayoutsComponentsSkillsTheme BuilderGitHub
← All Components

<mth-fullscreen-overlay>

@methane-ui/ui~10.1 KB brotli (cold + Lit)~3.2 KB marginal

Edge-to-edge modal <dialog> overlay built with OverlayController, FocusTrapController, and MotionController.

When NOT to use: Use a lightweight @methane-ui/css layout class instead of a custom element when static CSS suffices.

Live Interactive Preview

Interactive StageLive Custom Element · <mth-fullscreen-overlay> (@methane-ui/ui)
Launch Fullscreen OverlayFullscreen Workspace View

Uses native top-layer <dialog> with focus trap and Escape dismissal.

Close Overlay
Ready · interact with <mth-fullscreen-overlay>, or toggle Theme, Direction (LTR/RTL), or props above.

Multi-Framework Playground & Snippets

<script type="module" src="@methane-ui/ui/fullscreen-overlay"></script>
<mth-fullscreen-overlay closable close-on-escape>Example</mth-fullscreen-overlay>

Properties & Attributes

PropertyAttributeTypeDefaultDescription
openopenbooleanfalseControls whether the fullscreen overlay is open.
labellabelstring""Accessible heading and dialog label.
closableclosablebooleantrueRenders the close button in the top header.
closeOnEscapeclose-on-escapebooleantrueAllows dismissing the overlay with Escape.

Events

EventDetail TypeDescription
mth-openundefinedCancelable event fired before opening the overlay.
mth-after-openundefinedFired after the overlay finishes opening.
mth-close{ reason: string }Cancelable event fired before closing the overlay.
mth-after-closeundefinedFired after the overlay closes.

APG Keyboard Matrix

KeyDirectionWhenExpected Behavior
EscapebothopenCloses the fullscreen overlay and restores focus to the trigger.

Accessibility Checklist

CategoryRequirementVerified By
ariaAll aria-* IDREFs resolve within the same DOM root (ADR-003).scanSameRootAria
focusFocus ownership matches focusModel="none".lint-plugin & spec-compiler
contrastRenders legible borders, focus outlines, and selection indicators under forced-colors: active.Playwright forced-colors matrix
keyboardImplements all 1 APG keyboard transitions across LTR/RTL.mth-fullscreen-overlay.spec.test.ts
statesExposes ElementInternals CustomStateSet flags: :state(open).Conformance suite
i18nRoutes 2 UI/ARIA strings through @methane-ui/core i18n catalog.Locale context test