https://github.com/freaktechnik/minimal-overlay

A minimalistic js-based overlay with accessibility in mind
https://github.com/freaktechnik/minimal-overlay

Last synced: over 1 year ago
JSON representation

A minimalistic js-based overlay with accessibility in mind

• Host: GitHub
• URL: https://github.com/freaktechnik/minimal-overlay
• Owner: freaktechnik
• License: mpl-2.0
• Created: 2015-04-20T16:05:59.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-04-23T13:28:45.000Z (over 11 years ago)
• Last Synced: 2025-03-14T21:05:55.667Z (over 1 year ago)
• Language: JavaScript
• Size: 148 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
minimal-overlay

==============

Simple overlay is a minimal script (plus styles) to create an accessible overlay.

The only implemented control is closing the overlay by pressing `Esc` on the

keyboard.

License

-------

See the [LICENSE](LICENSE) file.

Installation

-----------

You can install this package using `bower install minimal-overlay --save`.

Usage

-----

The script creates a global `Overlay` constructor with the following interface:

 - `isShowing`: Attribute indicating, whether the overlay is currently visible

 - `show()`: method to display the overlay

 - `hide()`: method to hide the overlay

 - `show` Event: fired on the overlay whenever it is shown

 - `hide` Event: fired on the overlay whenever it is hidden

Example

-------

See the [index.html](index.html) for a practical example.