lion/packages/overlays/docs/GlobalOverlayController.md

GlobalOverlayController

This is a base class for different global overlays (e.g. a dialog, see Overlay System: Scope - the ones positioned relatively to the viewport).

You should not use this controller directly unless you want to create a unique type of global overlays which is not supported out of the box. But for implementation details check out Overlay System: Implementation.

All supported types of global overlays are described below.

How to use

Installation

npm i --save @lion/overlays

Example

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

const myCtrl = overlays.add(
  new GlobalOverlayController({
    /* options */
  }),
);

BottomSheetController

A specific extension of GlobalOverlayController configured to create accessible dialogs at the bottom of the screen.

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

ModalDialogController

A specific extension of GlobalOverlayController configured to create accessible modal dialogs placed in the center of the screen.

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