[//]: # 'AUTO INSERT HEADER PREPUBLISH'
# Overlay System - Configuration
```js script
import { html } from 'lit-html';
import '../docs/demo-overlay-system.js';
import '../docs/applyDemoOverlayStyles.js';
export default {
title: 'Overlays/System/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 `global-overlays` container at the bottom of the ``.
Local:
```js preview-story
export const placementLocal = () => html`
`;
```
## isTooltip (placementMode: 'local')
As specified in the [overlay rationale](/?path=/docs/overlays-system-rationale--page) 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.
```js preview-story
export const isTooltip = () => {
function showTooltip() {
const tooltip = document.querySelector('#tooltip');
tooltip.opened = true;
}
function hideTooltip() {
const tooltip = document.querySelector('#tooltip');
tooltip.opened = false;
}
return html`
Hello!
`;
};
```
## 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.
```js preview-story
export const trapsKeyboardFocus = () => html`
`;
```
## hidesOnEsc
Boolean property. Will allow closing the overlay on ESC key when enabled.
> On MacOS with touchbar, it only works if you view the canvas demo and click "Open canvas in new tab".
```js preview-story
export const hidesOnEsc = () => html`
Hello! You can close this notification here:
`;
```
## hidesOnOutsideClick
Boolean property. Will allow closing the overlay by clicking outside the `contentNode`.
```js preview-story
export const hidesOnOutsideClick = () => html`
Hello! You can close this notification here:
`;
```
## 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`.
```js preview-story
export const elementToFocusAfterHide = () => html`
Hello! You can close this notification here:
`;
```
## 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 `.global-overlays .global-overlays__backdrop` css selector.
The backdrop animation can be configured by targeting the
`.global-overlays .global-overlays__backdrop--fade-in` and
`.global-overlays .global-overlays__backdrop--fade-out` css selector.
This currently only supports CSS Animations, because it relies on the `animationend` event to add/remove classes.
```js preview-story
export const hasBackdrop = () => html`
Hello! You can close this notification here:
`;
```
## isBlocking
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 `.global-overlays .global-overlays__backdrop` css selector.
The backdrop animation can be configured by targeting the
`.global-overlays .global-overlays__backdrop--fade-in` and
`.global-overlays .global-overlays__backdrop--fade-out` css selector.
This currently only supports CSS Animations, because it relies on the `animationend` event to add/remove classes.
```js preview-story
export const isBlocking = () => html`
Hello! You can close this notification here:
Hello! You can close this notification here:
`;
```
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`.
```js preview-story
export const preventsScroll = () => html`
Hello! You can close this notification here:
`;
```
## 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'
```js preview-story
export const viewportConfig = () => html`
Hello! You can close this notification here:
`;
```
## popperConfig for local overlays (placementMode: 'local')
For locally DOM positioned overlays that position themselves relative to their invoker, we use [Popper.js](https://popper.js.org/) 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 x-placement attribute for this.
> An example implementation can be found in [lion-tooltip](?path=/docs/overlays-tooltip--main#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:
```js preview-story
export const popperConfig = () => html`
-margin for the secondary axis */
padding: 32,
},
/* Use to adjust flipping behavior or constrain directions */
flip: {
boundariesElement: 'viewport',
/* -margin for flipping on primary axis */
padding: 16,
},
/* When enabled, adds an offset to either primary or secondary axis */
offset: {
enabled: true,
/* margin between content node and invoker node */
offset: `0, 16px`,
},
},
},
}}
>