iptools-offcanvas
Simple lightweight (5k) native js css3 animated offcanvas.
Displays content inside an offcanvas from the top
, right
, bottom
or left
.
Distribution includes a polyfill for Object.assign.
Related
Features / Options
All options are optional.
Name | type | default value | values | description |
---|---|---|---|---|
baseClass |
string |
offcanvas |
valid css class string | base css class |
type |
string |
left |
top , right , bottom , left |
canvas position |
single |
boolean |
true |
single mode, closes all other canvases | |
closeOnClickOutside |
boolean |
false |
close canvas on click outside | |
static |
boolean |
false |
open after initialization | |
staticCloseCondition |
function |
function() { return true; } |
a function returning either true or false | close condition for static canvas |
Methods
Method | Parameter | Return | Description |
---|---|---|---|
getSettings |
object |
retrieve settings | |
isActive |
boolean |
returns if canvas is active (open) | |
toggle |
boolean |
not required. open (true), close (false) or toggle (leave empty) | |
destroy |
destroy offcanvas |
Events
Event | Description |
---|---|
initialized |
Emitted when canvas is ready to use. |
opened |
Emitted when the canvas opens. |
closed |
Emitted when the canvas closes. |
Example
openclosetoggle content X
Licence
Copyright © 2015 Interactive Pioneers GmbH. Licenced under GPLv3.