Page overlay component
Clone or download
Pull request Compare This branch is 10 commits ahead of component:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.gitignore
.jshintrc
History.md
Makefile
Readme.md
index.js
overlay.css
package.json

Readme.md

Overlay

Page overlay component.

Installation

$ component install component/overlay

API

overlay([options|element])

Returns a new Overlay.

Options:

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

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