Slideout.js

[![NPM version][npm-image]][npm-link] [![License][lic-image]][npm-link] [![Build status][travis-image]][travis-link] [![Coverage Status][coverage-image]][coverage-link] [![Dependency status][deps-image]][deps-link] [![devDependency status][devdeps-image]][devdeps-link] [![downloads][dt-image]][npm-link]

> A touch slideout navigation menu for your mobile web apps.

Features

- Dependency-free.
- Simple markup.
- Native scrolling.
- Easy customization.
- CSS transforms & transitions.
- Just 2 Kb! (min & gzip)

Demo

Check out the demo to see it in action (on your mobile or emulate touches on your browser).

Installation

Slideout is available on cdnjs

``html

`

Also you can use one of many package managers

$ npm install slideout

$ spm install slideout

$ bower install slideout.js

$ component install mango/slideout

Usage

Implementing Slideout.js into your project is easy.

First of all, you'll need to create your markup. You should have a menu (#menu) and a main content (#panel) into your body.

`html


Panel


`

Add the Slideout.js styles (index.css) in your web application.

`css
body {
width: 100%;
height: 100%;
}

.slideout-menu {
position: fixed;
left: 0;
top: 0;
bottom: 0;
right: 0;
z-index: 0;
width: 256px;
overflow-y: scroll;
-webkit-overflow-scrolling: touch;
display: none;
}

.slideout-panel {
position: relative;
z-index: 1;
will-change: transform;
}

.slideout-open,
.slideout-open body,
.slideout-open .slideout-panel {
overflow: hidden;
}

.slideout-open .slideout-menu {
display: block;
}
`

Then you just include Slideout.js and create a new instance with some options:

`html


`

#### Full example

`html














☰

Panel






`

Browser Support

- Chrome (IOS, Android, desktop)
- Firefox (Android, desktop)
- Safari (IOS, Android, desktop)
- Opera (desktop)
- IE 10+ (desktop)

API

$3


Create a new instance of Slideout.

- options (Object) - Options to customize a new instance of Slideout.
- options.panel (HTMLElement) - The DOM element that contains all your application content (.slideout-panel).
- options.menu (HTMLElement) - The DOM element that contains your menu application (.slideout-menu).
- [options.duration] (Number) - The time (milliseconds) to open/close the slideout. Default: 300.
- [options.fx] (String) - The CSS effect to use when animating the opening and closing of the slideout. Default: ease. Possible values:
- ease
- linear
- ease-in
- ease-out
- ease-in-out
- step-start
- step-end
- [options.padding] (Number) - Default: 256.
- [options.tolerance] (Number) - The number of px needed for the menu can be opened completely, otherwise it closes. Default: 70.
- [options.touch] (Boolean) - Set this option to false to disable Slideout touch events. Default: true.
- [options.side] (String) - The side to open the slideout (left or right). Default: left.

`js
var slideout = new Slideout({
'panel': document.getElementById('main'),
'menu': document.getElementById('menu'),
'padding': 256,
'tolerance': 70
});
`

$3


Opens the slideout menu. It emits beforeopen and open events.

`js
slideout.open();
`

$3


Closes the slideout menu. It emits beforeclose and close events.

`js
slideout.close();
`

$3

Toggles (open/close) the slideout menu.

`js
slideout.toggle();
`

$3


Returns true if the slideout is currently open, and false if it is closed.

`js
slideout.isOpen(); // true or false
`

$3

Cleans up the instance so another slideout can be created on the same area.

`js
slideout.destroy();
`

$3

Enables opening the slideout via touch events.

`js
slideout.enableTouch();
`

$3

Disables opening the slideout via touch events.

`js
slideout.disableTouch();
`

$3


`js
slideout.on('open', function() { ... });
`

$3

`js
slideout.once('open', function() { ... });
`

$3

`js
slideout.off('open', listener);
`

$3

`js
slideout.emit('open');
`

Events

An instance of Slideout emits the following events:

- beforeclose
- close
- beforeopen
- open
- translatestart
- translate
- translateend

The slideout emits translatestart, translate and translateend events only when it is opening/closing via touch events.

`js
slideout.on('translatestart', function() {
console.log('Start');
});

slideout.on('translate', function(translated) {
console.log('Translate: ' + translated); // 120 in px
});

slideout.on('translateend', function() {
console.log('End');
});

// 'Start'
// 'Translate 120'
// 'End'
`

npm-scripts


`
$ npm run build
`

`
$ npm run dist
`

`
$ npm test
`

`
$ npm run hint
`

FAQ

$3

`js
// vanilla js
document.querySelector('.toggle-button').addEventListener('click', function() {
slideout.toggle();
});

// jQuery
$('.toggle-button').on('click', function() {
slideout.toggle();
});
`

$3

You should define left: auto on the class .slideout-menu.
`css
.slideout-menu {
left: auto;
}
`

Then, use the side option with the value right.
`js
var slideout = new Slideout({
'panel': document.getElementById('content'),
'menu': document.getElementById('menu'),
'side': 'right'
});
`

$3

You should use mediaqueries:
`css
@media screen and (min-width: 780px) {
.slideout-panel {
margin-left: 256px;
}

.slideout-menu {
display: block;
}

.btn-hamburger {
display: none;
}
}
`
Demo: http://codepen.io/pazguille/pen/mEdQvX

$3

You should define a two class names: fixed and fixed-open.
`css
.fixed {
backface-visibility: hidden;
position: fixed;
z-index:2;
transition: transform 300ms ease;
}

.fixed-open {
transform: translate3d(256px, 0px, 0px);
}
`

Then, using slideout's events you should add / remove the fixed-open class name from the fixed element.
`js
slideout.on('beforeopen', function() {
document.querySelector('.fixed').classList.add('fixed-open');
});

slideout.on('beforeclose', function() {
document.querySelector('.fixed').classList.remove('fixed-open');
});
`

Demo: http://codepen.io/anon/pen/NqJGBp




$3


You can use the attribute data-slideout-ignore to disable dragging on some elements:

`html


Panel

Map


``

Demo: [TODO]

With :heart: by

- Guille Paz (Front-end developer | Web standards lover)
- E-mail: guille87paz@gmail.com
- Twitter: @pazguille
- Web: http://pazguille.me

License

MIT license. Copyright © 2015 Mango.

[npm-image]: https://img.shields.io/npm/v/slideout.svg
[lic-image]: https://img.shields.io/npm/l/slideout.svg
[npm-link]: https://npmjs.org/package/slideout
[travis-image]: https://img.shields.io/travis/Mango/slideout.svg
[travis-link]: https://travis-ci.org/Mango/slideout
[deps-image]: https://img.shields.io/david/mango/slideout.svg
[deps-link]: https://david-dm.org/mango/slideout
[devdeps-image]: https://img.shields.io/david/dev/mango/slideout.svg
[devdeps-link]: https://david-dm.org/mango/slideout#info=devDependencies
[dt-image]: https://img.shields.io/npm/dt/slideout.svg
[coverage-image]: https://img.shields.io/coveralls/Mango/slideout.svg
[coverage-link]: https://coveralls.io/github/Mango/slideout