Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lgraubner/jquery-offcanvas
An easy to use jQuery offcanvas plugin.
https://github.com/lgraubner/jquery-offcanvas
jquery jquery-offcanvas jquery-plugin navigation offcanvas
Last synced: about 4 hours ago
JSON representation
An easy to use jQuery offcanvas plugin.
- Host: GitHub
- URL: https://github.com/lgraubner/jquery-offcanvas
- Owner: lgraubner
- License: mit
- Created: 2015-04-15T10:38:15.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-10-07T08:34:43.000Z (over 8 years ago)
- Last Synced: 2025-01-22T03:11:18.776Z (15 days ago)
- Topics: jquery, jquery-offcanvas, jquery-plugin, navigation, offcanvas
- Language: JavaScript
- Homepage: http://lgraubner.github.io/jquery-offcanvas
- Size: 145 KB
- Stars: 21
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jQuery.offcanvas
[](https://travis-ci.org/lgraubner/jquery-offcanvas) [](https://david-dm.org/lgraubner/jquery-offcanvas#info=devDependencies) [](https://www.npmjs.com/package/jquery-offcanvas)
> An easy to use jQuery offcanvas plugin.
This plugin provides an easy way to put content outside of the canvas and reveal it with a click on a button or any desired element. This is a useful pattern for mobile navigations and more.
[Demo](http://lgraubner.github.io/jquery-offcanvas/demo/) | [Download](https://github.com/lgraubner/jquery-offcanvas/releases/latest)
## Dependencies
As this is a jQuery plugin it depends on the [jQuery library](http://jquery.com/) v1.7+. For smooth animations [Velocity.js](https://github.com/julianshapiro/velocity) is used. Both dependencies are required.
## Usage
You can install this module either with npm or download it manually. Include jQuery, Velocity.js and the plugin before the closing `body` tag:
```HTML
```
Include the CSS file:
```HTML
```
If you are not using npm just adjust the paths to match the file locations.
It's not required to have any specific markup. The plugin handles any positioning itself. The only requirement is a wrapping element around the offcanvas contents.
### Initialization
```JavaScript
var $el = $("#element").offcanvas();
$(".offcanvas-trigger").on("click", function() {
$el.offcanvas("toggle");
});
```
Clicks on the trigger element will toggle the offcanvas element.
**Do not try to initialize more than one instance of jQuery.offcanvas on one page!**
## Options
Options can be set on initialization:
```JavaScript
$("#element").offcanvas({
origin: "right",
duration: 400
});
```
You can also set options via data-Attributes, which will overwrite the default value and the value specified on initialization:
```HTML
...
```
### classes
Type: `object`
Default:
```JavaScript
{
container: "offcanvas",
element: "offcanvas-element",
inner: "offcanvas-inner",
open: "offcanvas-open",
outer: "offcanvas-outer",
overlay: "offcanvas-overlay"
}
```
Classes which will be applied to the elements.
**If you change class names make sure to update them in the CSS file accordingly.**
### container
Type: `String`
Default: `body`
Page container, which will be animated. Expects a jQuery selector.
### coverage
Type: `String`
Default: `220px`
Width of the offcanvas element which will be revealed.
**Tip:** For better performance avoid using % values.
### duration
Type: `number`
Default: `300`
Duration of the animation.
### easing
Type: `String`
Default: `ease-in-out`
Easing type for show and hide animations. You can use:
- [jQuery UI's easings](http://easings.net/de)
- CSS3's named easings: `ease`, `ease-in`, `ease-out`, and `ease-in-out`
For more easing options check the [Velocity.js documentation](http://julian.com/research/velocity/#easing).
### effect
Type: `String`
Default: `push`
Effect used to transition the offcanvas element into the viewport. Possible values are `push` and `slide-in-over`. Check the [demos](http://lgraubner.github.io/jquery-offcanvas/demo/) for an impression of the effects.
### origin
Type: `String`
Default: `left`
Direction the offcanvas element is revealed from. Possible values are `left` and `right`.
### overlay
Type: `boolean`
Default: `false`
Adds an overlay to cover the content of the page. A click anywhere on the overlay will hide the offcanvas.
### overlayColor
Type: `String`
Default: `rgba(0, 0, 0, 0.7)`
Color of the overlay element. Best suited are `rgba` values to add a decent looking transparency. You can use `rgba(0, 0, 0, 0.7)` as starting point to play around. The overlay will be smoothly transitioned into the view.
## API
The offcanvas API offers a couple of methods to control the offcanvas element. The methods are called like this:
```JavaScript
$("#element").offcanvas("show");
```
### show
Shows the offcanvas element.
### hide
Hides the offcanvas element.
### toggle
Toggles the offcanvas element.
### destroy
Destroys the jQuery.offcanvas instance and reverts all DOM changes.
## Events
jQuery.offcanvas fires several events. Simply listen for them with the `jQuery.on` function. All events are namespaced with `offcanvas`.
```JavaScript
$("#element").on("shown.offcanvas", function() {
// do stuff when offcanvas is revealed and animation is finished
});
```
### init
Fired once the Plugin is initialized.
### show
Fired when the `show` method is called.
### shown
Fired when the `show` animation finished.
### hide
Fired when the `hide` method is called.
### toggle
Fired when the offcanvas gets toggled. Gets fired on both, `show` and `hide` methods. The second function argument contains the offcanvas state as `boolean`.
```JavaScript
$("#element").on("toggle.offcanvas", function(event, visible) {
console.log(visible) // outputs offcanvas state (true or false)
});
```
### hidden
Fired when the `hide` animation finished.