API Documentation

Overlay

Themable, WAI-ARIA accessible javascript overlay. For examples, check out Overlay demo page.

Properties

Key Type Required Description
autoOpen boolean No Defaults to false
draggable boolean No Defaults to false
footer boolean No Defaults to true
header boolean No Defaults to true
height numeric No Defaults to 240
maximized boolean No Defaults to false
maxHeight numeric No Defaults to false
maxWidth numeric No Defaults to false
minHeight numeric No Defaults to 150
minimized boolean No Defaults to false
minWidth numeric No Defaults to 150
modal boolean No Defaults to false
resizable boolean No Defaults to false
toolbar object No Defaults to {minimize : true, maximize : true, close : true}
width numeric No Defaults to 320
buttons object No Defaults to TODO
beforeOpen function No Defaults to null
beforeClose function No Defaults to null

Methods

Method Arguments Description
close .zinoOverlay("close") Closes the overlay.
maximize .zinoOverlay("maximize") Maximize the overlay size to fit the window size.
minimize .zinoOverlay("minimize") Minimize the overlay size.
open .zinoOverlay("open") Opens the overlay.
restore .zinoOverlay("restore") Restore the overlay to it's previous state.

Events

Event Arguments Description
close event, ui Triggered when the window/dialog attempts to close.
drag event, ui Triggered while the user drag the overlay/dialog.
dragend event, ui Triggered when the user stops dragging the overlay/dialog.
dragstart event, ui Triggered when the user starts dragging the overlay/dialog.
maximize event, ui Triggered when the dialog attempts to maximize it's size.
minimize event, ui Triggered when the dialog attempts to minimize it's size.
open event, ui Triggered when the dialog attempts to open.
resize event, ui Triggered while the user resize the overlay/dialog.
resizeend event, ui Triggered when the user stops resizing the overlay/dialog.
resizestart event, ui Triggered when the user starts resizing the overlay/dialog.
restore event, ui Triggered when the dialog attempts to restore to it's previous state.