Skip to content

JasonSanford/overlay

 
 

Repository files navigation

Overlay

Page overlay component.

Installation

$ npm install overlay-component

API

overlay([options])

Returns a new Overlay.

Options:

  • closable: whether or not a user may click the overlay to close [false]

Overlay#show()

Show the overlay.

Overlay#hide()

Hide the overlay.

Events

  • show when the overlay is shown
  • hide when the overlay is hidden
  • close when the overlay is removed (follows hide normally)

License

MIT

About

Page overlay component

Resources

Stars

0 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors

Languages

  • JavaScript 55.6%
  • HTML 25.5%
  • CSS 11.8%
  • Makefile 7.1%