JSPM

  • Created
  • Published
  • Downloads 1591
  • Score
    100M100P100Q110113F
  • License MIT

Overlays System using lit-html for rendering

Package Exports

  • @lion/overlays
  • @lion/overlays/src/utils/key-codes.js
  • @lion/overlays/translations/bg-BG.js
  • @lion/overlays/translations/bg.js
  • @lion/overlays/translations/cs-CZ.js
  • @lion/overlays/translations/cs.js
  • @lion/overlays/translations/de-DE.js
  • @lion/overlays/translations/de.js
  • @lion/overlays/translations/en-AU.js
  • @lion/overlays/translations/en-GB.js
  • @lion/overlays/translations/en-US.js
  • @lion/overlays/translations/en.js
  • @lion/overlays/translations/es-ES.js
  • @lion/overlays/translations/es.js
  • @lion/overlays/translations/fr-BE.js
  • @lion/overlays/translations/fr-FR.js
  • @lion/overlays/translations/fr.js
  • @lion/overlays/translations/hu-HU.js
  • @lion/overlays/translations/hu.js
  • @lion/overlays/translations/it-IT.js
  • @lion/overlays/translations/it.js
  • @lion/overlays/translations/nl-BE.js
  • @lion/overlays/translations/nl-NL.js
  • @lion/overlays/translations/nl.js
  • @lion/overlays/translations/pl-PL.js
  • @lion/overlays/translations/pl.js
  • @lion/overlays/translations/ro-RO.js
  • @lion/overlays/translations/ro.js
  • @lion/overlays/translations/ru-RU.js
  • @lion/overlays/translations/ru.js
  • @lion/overlays/translations/sk-SK.js
  • @lion/overlays/translations/sk.js
  • @lion/overlays/translations/uk-UA.js
  • @lion/overlays/translations/uk.js
  • @lion/overlays/translations/zh.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@lion/overlays) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Overlays System

๐Ÿ›  Status: Pilot Phase

Lion Web Components are still in an early alpha stage; they should not be considered production ready yet.

The goal of our pilot phase is to gather feedback from a private group of users. Therefore, during this phase, we kindly ask you to:

  • not publicly promote or link us yet: (no tweets, blog posts or other forms of communication about Lion Web Components)
  • not publicly promote or link products derived from/based on Lion Web Components

As soon as Pilot Phase ends we will let you know (feel free to subscribe to this issue https://github.com/ing-bank/lion/issues/1)

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

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

Rationals

  • No aria-controls: as support for it is not quite there yet
  • No aria-haspopup People knowing the haspop up and hear about it donโ€™t expect a dialog to open (at this moment in time) but expect a sub-menu. Until support for the dialog value has better implementation, itโ€™s probably best to not use aria-haspopup on the element that opens the modal dialog.