iptools-jquery-offcanvas
Simple CSS3 animated offcanvas.
Related
legacy
- 0.0.2 documentation
Features
- Displays content inside an offcanvas from the top, right, bottom or left.
- Multiple instances at once.
- Static, instance is open on page load.
- CSS3 transitions and animations.
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 pattern: {eventName}.{elementId}@iptOffCanvas
Event | Element | Description |
---|---|---|
initialized.custom@iptOffCanvas |
this.$element | Emitted when canvas is ready to use. |
opened.custom@iptOffCanvas |
this.$element | Emitted when the canvas opens. |
closed.custom@iptOffCanvas |
this.$element | Emitted when the canvas closes. |
Requirements
- jQuery >=1.11.3 <4
Example
openclosetoggle content X
Licence
Copyright © 2015 Interactive Pioneers GmbH. Licenced under GPLv3.