overlay-component

    0.3.5 • Public • Published

    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

    Keywords

    Install

    npm i overlay-component

    DownloadsWeekly Downloads

    12

    Version

    0.3.5

    License

    none

    Last publish

    Collaborators

    • defunctzombie
    • dfcreative
    • tjholowaychuk
    • jongleberry
    • dominicbarnes
    • tootallnate
    • rauchg
    • retrofox
    • coreh
    • forbeslindesay
    • kelonye
    • mattmueller
    • yields
    • anthonyshort
    • ianstormtaylor
    • cristiandouce
    • swatinem
    • stagas
    • amasad
    • juliangruber
    • calvinfo
    • blakeembrey
    • timoxley
    • jonathanong
    • queckezz
    • nami-doc
    • clintwood
    • thehydroimpulse
    • stephenmathieson
    • trevorgerhardt
    • timaschew
    • hughsk