Overlays: Configuration

The OverlayController has many configuration options. Using different combinations of those properties, different components like a tooltip, popover, dialog etc. can be made. The OverlayMixin exposes these options via .config.

placementMode

Either 'local' or 'global'. This determines the DOM position of the contentNode, either next to the invokerNode, or in the overlays container at the bottom of the <body>.

Local

export const placementLocal = () => {
  const placementModeLocalConfig = { ...withDropdownConfig() };
  return html`
    <style>
      .demo-overlay {
        background-color: white;
        border: 1px solid black;
      }
    </style>
    <demo-el-using-overlaymixin .config="${placementModeLocalConfig}">
      <button slot="invoker">Click me to open the local overlay!</button>
      <div slot="content" class="demo-overlay">
        Hello! You can close this notification here:
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

Global

export const placementGlobal = () => {
  const placementModeGlobalConfig = { placementMode: 'global' };
  return html`
    <demo-el-using-overlaymixin .config="${placementModeGlobalConfig}">
      <button slot="invoker">Click me to open the global overlay!</button>
      <div slot="content" class="demo-overlay">
        Hello! You can close this notification here:
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

isTooltip (placementMode: 'local')

As specified in the overlay rationale there are only two official types of overlays: dialogs and tooltips. And their main differences are:

Dialogs have a modal option, tooltips don’t
Dialogs have interactive content, tooltips don’t
Dialogs are opened via regular buttons (click/space/enter), tooltips act on focus/mouseover

Since most overlays have interactive content the default is set to dialogs. To get a tooltip, you can add isTooltip to the config object. This only works for local placement and it also needs to have handlesAccessibility activated to work.

export const usingTooltipConfig = () => {
  const tooltipConfig = { ...withTooltipConfig() };

  return html`
    <demo-el-using-overlaymixin id="tooltip" .config="${tooltipConfig}">
      <button slot="invoker">Hover me to open the tooltip!</button>
      <div slot="content" class="demo-overlay">Hello!</div>
    </demo-el-using-overlaymixin>
  `;
};

trapsKeyboardFocus

Boolean property. When true, the focus will rotate through the focusable elements inside the contentNode.

For Modal Dialogs this is an important feature, since these are considered "their own page", so especially from an accessibility point of view, trapping the focus inside the dialog is crucial.

You use the feature on any type of overlay.

export const trapsKeyboardFocus = () => {
  const trapsKeyboardFocusConfig = { ...withDropdownConfig(), trapsKeyboardFocus: true };
  return html`
    <demo-el-using-overlaymixin .config="${trapsKeyboardFocusConfig}">
      <button slot="invoker">Click me to open the overlay!</button>
      <div slot="content" class="demo-overlay">
        <div><a href="#">A focusable anchor</a></div>
        <div><a href="#">Another focusable anchor</a></div>
        Hello! You can close this notification here:
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

hidesOnEsc

Boolean property. Will allow closing the overlay on ESC key when enabled.

export const hidesOnEsc = () => {
  const hidesOnEscConfig = { ...withDropdownConfig(), hidesOnEsc: true };
  return html`
    <demo-el-using-overlaymixin .config="${hidesOnEscConfig}">
      <button slot="invoker">Click me to open the overlay!</button>
      <div slot="content" class="demo-overlay">
        Hello! You can close this notification here:
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

And how it works if hidesOnEsc is disabled. In most cases hidesOnOutsideEsc needs also to be set to false.

export const hidesOnEscFalse = () => {
  const hidesOnEscConfig = {
    ...withModalDialogConfig(),
    hidesOnEsc: false,
    hidesOnOutsideEsc: false,
  };
  return html`
    <demo-el-using-overlaymixin .config="${hidesOnEscConfig}">
      <button slot="invoker">Click me to open the overlay!</button>
      <div slot="content" class="demo-overlay">
        Hello! You can close this notification here:
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

hidesOnOutsideEsc

Boolean property. When enabled allows closing the overlay on ESC key, even when contentNode has no focus.

export const hidesOnOutsideEsc = () => {
  const hidesOnEscConfig = { ...withDropdownConfig(), hidesOnOutsideEsc: true };
  return html`
    <demo-el-using-overlaymixin .config="${hidesOnEscConfig}">
      <button slot="invoker">Click me to open the overlay!</button>
      <div slot="content" class="demo-overlay">
        Hello! You can close this notification here:
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

hidesOnOutsideClick

Boolean property. Will allow closing the overlay by clicking outside the contentNode.

export const hidesOnOutsideClick = () => {
  const hidesOnOutsideClickConfig = { ...withDropdownConfig(), hidesOnOutsideClick: true };
  return html`
    <demo-el-using-overlaymixin .config="${hidesOnOutsideClickConfig}">
      <button slot="invoker">Click me to open the overlay!</button>
      <div slot="content" class="demo-overlay">
        <label for="myInput">Clicking this label should not trigger close</label>
        <input id="myInput" />
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

elementToFocusAfterHide

HTMLElement. Will .focus() the HTMLElement passed to this property. By default, this is the invokerNode.

In the example, we focus the body instead of the invokerNode.

export const elementToFocusAfterHide = () => {
  const btn = document.createElement('button');
  btn.innerText = 'I should get focus';

  const elementToFocusAfterHideConfig = { ...withDropdownConfig(), elementToFocusAfterHide: btn };
  return html`
    <demo-el-using-overlaymixin .config="${elementToFocusAfterHideConfig}">
      <button slot="invoker">Click me to open the overlay!</button>
      <div slot="content" class="demo-overlay">
        Hello! You can close this notification here:
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
    ${btn}
  `;
};

hasBackdrop

Boolean property. When true, will add a backdrop when the overlay is opened.

Backdrops will overlay each other if you open nested overlays with enabled backdrops. If this is not what you intend, you can make the overlays not nested, where opening one, closes the other. Fortunately, we also have a configuration option that simulates that behavior in the next section isBlocking.

The backdrop styling can be configured by targeting the .overlays .overlays__backdrop css selector.

The backdrop animation can be configured by targeting the .overlays .overlays__backdrop--animation-in and .overlays .overlays__backdrop--animation-out css selector. This currently only supports CSS Animations, because it relies on the animationend event to add/remove classes.

export const hasBackdrop = () => {
  const hasBackdropConfig = { ...withDropdownConfig(), hasBackdrop: true };
  return html`
    <demo-el-using-overlaymixin .config="${hasBackdropConfig}">
      <button slot="invoker">Click me to open the overlay!</button>
      <div slot="content" class="demo-overlay">
        Hello! You can close this notification here:
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

isBlocking

Boolean property. When true, will block other overlays.

export const isBlocking = () => {
  const isBlockingConfig = { ...withDropdownConfig(), hasBackdrop: true, isBlocking: true };
  return html`
    <demo-el-using-overlaymixin>
      <button slot="invoker">Overlay A: open first</button>
      <div slot="content" class="demo-overlay" style="width:200px;">
        This overlay gets closed when overlay B gets opened
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
    <demo-el-using-overlaymixin .config="${isBlockingConfig}">
      <button slot="invoker">Overlay B: open second</button>
      <div slot="content" class="demo-overlay demo-overlay--blocking">
        Overlay A is hidden... now close me and see overlay A again.
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

This example shows nested overlays, but they don't have to be. For example, they could be siblings, or completely unrelated. When an overlay with isBlocking is opened, all other overlays are hidden by the OverlaysManager, which, as a global registry, is aware of all active overlays on the page.

preventsScroll

Boolean property. When true, prevents scrolling content that is outside of the contentNode.

export const preventsScroll = () => {
  const preventsScrollConfig = { preventsScroll: true };
  return html`
    <demo-el-using-overlaymixin .config="${preventsScrollConfig}">
      <button slot="invoker">Click me to open the overlay!</button>
      <div slot="content" class="demo-overlay">
        Hello! You can close this notification here:
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

viewportConfig

Determines where the overlay is placed relative to the viewport. This can only be used in combination with a 'global' placementMode.

Options:

'top-left'
'top'
'top-right'
'right'
'bottom-left'
'bottom'
'bottom-right'
'left'
'center'

export const viewportConfig = () => {
  const viewportConfig = {
    placementMode: 'global',
    viewportConfig: { placement: 'bottom-left' },
  };
  return html`
    <demo-el-using-overlaymixin .config="${viewportConfig}">
      <button slot="invoker">Click me to open the overlay in the bottom left corner!</button>
      <div slot="content" class="demo-overlay">
        Hello! You can close this notification here:
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

popperConfig for local overlays (placementMode: 'local')

For locally DOM positioned overlays that position themselves relative to their invoker, we use Popper.js for positioning.

In Popper, contentNode is often referred to as popperElement, and invokerNode is often referred to as the referenceElement.

Features:

Everything Popper features!
Currently eagerly loads popper if mode is local, in the constructor. Loading during idle time / using prefetch would be better, this is still WIP. PRs are welcome!

Popper strictly is scoped on positioning. It does not change the dimensions of the content node nor the invoker node. This also means that if you use the arrow feature, you are in charge of styling it properly, use the data-popper-placement attribute for this. An example implementation can be found in lion-tooltip, where an arrow is set by default.

To override the default options we set for local mode, you add a popperConfig object to the config passed to the OverlayController. Here's a succinct overview of some often used popper properties:

export const popperConfig = () => {
  const popperConfig = {
    placementMode: 'local',
    popperConfig: {
      /* Placement of content node, relative to invoker node */
      placement: 'bottom-start',
      positionFixed: true,
      modifiers: [
        /* When enabled, adds shifting/sliding behavior on secondary axis */
        {
          name: 'preventOverflow',
          enabled: false,
          options: {
            boundariesElement: 'viewport',
            /* When enabled, this is the <boundariesElement>-margin for the secondary axis */
            padding: 32,
          },
        },
        /* Use to adjust flipping behavior or constrain directions */
        {
          name: 'flip',
          options: {
            boundariesElement: 'viewport',
            /* <boundariesElement>-margin for flipping on primary axis */
            padding: 16,
          },
        },
        /* When enabled, adds an offset to either primary or secondary axis */
        {
          name: 'offset',
          options: {
            /* margin between content node and invoker node */
            offset: [0, 16],
          },
        },
      ],
    },
  };
  return html`
    <style>
      .demo-overlay {
        background-color: white;
        border: 1px solid black;
      }
    </style>
    <demo-el-using-overlaymixin .config="${popperConfig}">
      <button slot="invoker">Click me to open the overlay!</button>
      <div slot="content" class="demo-overlay">
        Hello! You can close this notification here:
        <button
          class="close-button"
          @click="${e => e.target.dispatchEvent(new Event('close-overlay', { bubbles: true }))}"
        >
          ⨯
        </button>
      </div>
    </demo-el-using-overlaymixin>
  `;
};

Note: popperConfig reflects Popper API

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub!