iptools-jquery-offcanvas
Simple CSS3 animated offcanvas.
Features
- Display content inside offcanvas from the top, right, bottom or left.
- CSS3 transitions and animations.
Options
See inline comments in Example. All options are optional.
Events
Namespace | Event | Element | Description |
---|---|---|---|
iptOffCanvas | initialized | this.$element | Emitted after initialisation took place. |
iptOffCanvas | opened | this.$element | Emitted when the canvas opens. |
iptOffCanvas | closed | this.$element | Emitted when the canvas closes. |
Requirements
- jQuery 2.1.4 or greater
Example
<!-- deprecated since 0.1.0
<button class="offcanvas__trigger--open" data-rel="custom">open</button>
<button class="offcanvas__trigger--close" data-rel="custom">close</button>
<section id="custom" class="offcanvas">
<p>offcanvas content</p>
<button class="offcanvas__trigger--close" data-rel="custom">X</button>
</section> -->
<button data-offcanvas-open="custom">open</button>
<button data-offcanvas-close="custom">close</button>
<section id="custom" class="offcanvas">
<p>offcanvas content</p>
<button data-offcanvas-close="custom">X</button>
</section>
<link rel="stylesheet" href="dist/iptools-jquery-offcanvas.css" type="text/css">
<script src="dist/iptools-jquery-offcanvas.min.js"></script>
<script type="text/javascript">
$(document).ready(function() {
// bind
$('#custom').iptOffCanvas({
baseClass: 'offcanvas',
type: 'left' // top, right, bottom, left.
single: true // close other instances when one opens
});
// example event listener
$('#custom').on('iptOffCanvas.opened', function() {
console.log('canvas opened');
});
});
</script>
Contributions
Bug reports, suggestions
- File all your issues, feature requests here
- If filing a bug report, follow the convention of Steps to reproduce / What happens? / What should happen?
- If you're a developer, write a failing test instead of a bug report and send a Pull Request
Code
- Fork it ( https://github.com/[my-github-username]/iptools-jquery-offcanvas/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Develop your feature by concepts of TDD, see Tips
- Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Tips
Following tasks are there to help with development:
-
grunt watch
listens to source, live reloads browser -
grunt qa
run QA task that includes tests and JSHint -
grunt build
minify source to dist/
Licence
Copyright © 2015 Interactive Pioneers GmbH. Licenced under GPLv3.