lion/packages/overlays

Overlays System

Supports different types of overlays like dialogs, toasts, tooltips, dropdown, etc... Manages their position on the screen relative to other elements, including other overlays.

Features

• Overlays Manager, a global repository keeping track of all different types of overlays.
• Overlays Occurrences, outline of all possible occurrences of overlays. Divided into two main types:
  • Global Overlay Controller, controller for overlays relative to the viewport.
  • Local Overlay Controller, controller for overlays positioned next to invokers they are related to.

How to use

Installation

npm i --save @lion/overlays

Example

import { overlays } from '@lion/overlays';

const myCtrl = overlays.add(
  new OverlayTypeController({
    /* options */
  })
);
// name OverlayTypeController is for illustration purpose only
// please read below about existing classes for different types of overlays