veams-component-overlay

5.1.0 • Public • Published

npm version Gitter Chat

Overlay

Description

It represents an overlay module. This module is responsible to create an overlay without predefining any inner overlay template.

It should be used by other modules to display their content in an overlay.


Requirements

  • Veams >= v5.0.0 - Veams Framework.

Installation

Installation with Veams

veams install vc overlay


JavaScript Options

The module gives you the possibility to override default options:

  • closeBtn {String} ['[data-js-item="overlay-close"]'] - Define the element for close button.
  • overlay {String} ['[data-js-item="overlay"]'] - Define the element for overlay.
  • regionContent {String} ['[data-js-item="overlay-content"]'] - Define the element for region content.
  • template {Function} [Template['OVERLAY']] - Template function used to render overlay data.

Readme

Keywords

Package Sidebar

Install

npm i veams-component-overlay

Weekly Downloads

0

Version

5.1.0

License

MIT

Last publish

Collaborators

  • andy-gutsche
  • sebastian-fitzner