brahma.overlay

Plugin for Brahma to create overlay (popup modal window)


License
MIT
Install
bower install brahma.overlay

Documentation

Brahma.overlay

Plugin for Brahma library which allows you to create modal windows

Usage

Brahma('selector').component('overlay', {
	//options
});

Selector is not the content of the layer! Selector is a container inside which creates a layer. In the classic model, the selector must be "body". But you have choice another container.

Options

  • content : Html text of overlay content
  • panel :
    • style : Css directives (like .css in jQuery) for styling popup panel
  • overlay :
    • style : Css directives (like .css in jQuery) for styling overlayer
  • effect :
    • type : name of showing/hiding effect
    • direction : direction of show (only when type is slide)
    • duration : duration of effect
    • easing : easing
  • class : classname of main wrapper
  • freezeDocument : freeze main document
  • verticalMargin : popup panel will have got strict top/bottom margin (make high content's overlays more beauty)
  • autoshow : show after create
  • zIndex : manual z-index
  • outsideClose : close modal by click at outside
  • escapeClose : close modal by press ESC
  • autobinds : find and bind content's elements with trigger [overlay-trigger=close]

Effects

  • slide : slide modal window on any direction
  • hang : little from top and fading
  • false : fading

Depends

Brahma, jQuery, jQqery.tie

Authors

Vladimir Morulus

License

MIT