A touch slideout navigation menu for your mobile web apps.
- Dependency-free.
- Simple markup.
- Native scrolling.
- Easy customization.
- CSS transforms & transitions.
- Just 2 Kb! (min & gzip)
Check out the demo to see it in action (on your mobile or emulate touches on your browser).
$ npm install slideout
$ spm install slideout
$ bower install slideout.js
$ component install mango/slideout
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.
<nav id="menu">
<header>
<h2>Menu</h2>
</header>
</nav>
<main id="panel">
<header>
<h2>Panel</h2>
</header>
</main>Add the Slideout.js styles (index.css) in your web application.
body {
width: 100%;
height: 100%;
}
.slideout-menu {
position: fixed;
left: 0;
top: 0;
bottom: 0;
right: 0;
z-index: 0;
width: 256px;
overflow-y: auto;
-webkit-overflow-scrolling: touch;
display: none;
}
.slideout-panel {
position:relative;
z-index: 1;
}
.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:
<script src="dist/slideout.min.js"></script>
<script>
var slideout = new Slideout({
'panel': document.getElementById('panel'),
'menu': document.getElementById('menu'),
'padding': 256,
'tolerance': 70
});
</script><!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Slideout Demo</title>
<meta http-equiv="cleartype" content="on">
<meta name="MobileOptimized" content="320">
<meta name="HandheldFriendly" content="True">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
<style>
body {
width: 100%;
height: 100%;
}
.slideout-menu {
position: fixed;
left: 0;
top: 0;
bottom: 0;
right: 0;
z-index: 0;
width: 256px;
overflow-y: auto;
-webkit-overflow-scrolling: touch;
display: none;
}
.slideout-panel {
position:relative;
z-index: 1;
}
.slideout-open,
.slideout-open body,
.slideout-open .slideout-panel {
overflow: hidden;
}
.slideout-open .slideout-menu {
display: block;
}
</style>
</head>
<body>
<nav id="menu">
<h2>Menu</h2>
</nav>
<main id="panel">
<header>
<button class="toggle-button">☰</button>
<h2>Panel</h2>
</header>
</main>
<script src="dist/slideout.min.js"></script>
<script>
var slideout = new Slideout({
'panel': document.getElementById('panel'),
'menu': document.getElementById('menu'),
'padding': 256,
'tolerance': 70
});
// Toggle button
document.querySelector('.toggle-button').addEventListener('click', function() {
slideout.toggle();
});
</script>
</body>
</html>- Chrome (IOS, Android, desktop)
- Firefox (Android, desktop)
- Safari (IOS, Android, desktop)
- Opera (desktop)
- IE 10+ (desktop)
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.[options.padding](Number) - Default:256.[options.tolerance](Number) - 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 (leftorright). Default:left.
var slideout = new Slideout({
'panel': document.getElementById('main'),
'menu': document.getElementById('menu'),
'padding': 256,
'tolerance': 70
});Opens the slideout menu. It emits beforeopen and open events.
slideout.open();Closes the slideout menu. It emits beforeclose and close events.
slideout.close();Toggles (open/close) the slideout menu.
slideout.toggle();Returns true if the slideout is currently open, and false if it is closed.
slideout.isOpen(); // true or falseslideout.on('open', function() { ... });slideout.once('open', function() { ... });slideout.off('open', listener);slideout.emit('open');An instance of Slideout emits the following events:
beforecloseclosebeforeopenopentranslate
The slideout emits translate event only when it is opening/closing via touch events.
slideout.on('translate', function(translated) {
console.log(translated); // 120 in px
});$ npm run build
$ npm run dist
$ npm test
$ npm run hint
// vanilla js
document.querySelector('.toggle-button').addEventListener('click', function() {
slideout.toggle();
});
// jQuery
$('.toggle-button').on('click', function() {
slideout.toggle();
});- Guille Paz (Front-end developer | Web standards lover)
- E-mail: [email protected]
- Twitter: @pazguille
- Web: http://pazguille.me
MIT license. Copyright © 2015 Mango.