Examples API

Attributes and Properties #

Property Attribute Type Default Description open open boolean false

Events #

Name Type Description close Event When the underlay is "clicked" and the consuming pattern should chose whether to close based on that interaction

Description #

An <sp-underlay> is used primarily in concert with elements similar to <sp-dialog> that lay over the rest of your page to deliver a blocking layer between those two contexts. See this element in action as part of the <sp-dialog-wrapper> element.

Usage #

See it on NPM! How big is this package in your project?

yarn add @spectrum-web-components/underlay

Import the side effectful registration of <sp-underlay> via:

import '@spectrum-web-components/underlay/sp-underlay.js';

When looking to leverage the Underlay base class as a type and/or for extension purposes, do so via:

import { Underlay } from '@spectrum-web-components/underlay';

Example #

When leveraging an <sp-underlay> in conjunction with overlay content, place it as a sibling prior to your overlay content.

    sp-underlay:not([open]) + sp-dialog {
        display: none;
    sp-underlay + sp-dialog {
        position: fixed;
        top: 50%;
        left: 50%;
        transform: translate(-50%, -50%);
        z-index: 1;
        background: var(--spectrum-gray-100);

        this.nextElementSibling.open = true;
    Open dialog with underlay element

<sp-dialog size="s">
    <h1 slot="heading">Hello, I'm an overlay!</h1>
    <p>Enjoy your day...</p>
            this.parentElement.previousElementSibling.open = false;