Slideout.js 是一個(gè) Web 上的可觸控的導(dǎo)航欄菜單狮斗。
查看 Demo（在你的移動設(shè)備上或在你的瀏覽器上模擬觸摸）
安裝
可以直接引入 cdnjs 上的 .js 文件：
<script src="https://cdnjs.cloudflare.com/ajax/libs/slideout/0.1.9/slideout.min.js"></script>
也可以使用包管理器安裝：
$ npm install slideout
$ spm install slideout
$ bower install slideout.js
$ component install mango/slideout
如何使用
首先，你的菜單中需要有一個(gè)菜單（#menu）和主界面（#panel）
<nav id="menu">
<header>
<h2>Menu</h2>
</header>
</nav>
<main id="panel">
<header>
<h2>Panel</h2>
</header>
</main>
然后在你的 .css 文件中為 Slideout 添加樣式
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;
}
然后引入 Slideout.js 并創(chuàng)建一個(gè)實(shí)例
<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侨把、PC）
- Firefox（Android犀变、PC）
- Safari（iOS、Android秋柄、PC）
- Opera（PC）
- IE 10+（PC）
API
Slideout(options)
創(chuàng)建一個(gè)新的 Slideout 實(shí)例所要用到的選項(xiàng)
-
options(對象) - 一個(gè)使用自定義選項(xiàng)的 Slideout 實(shí)例获枝。 -
options.panel(HTML 元素) - 程序中包含.slideout-panel的 DOM 元素。 -
options.menu(HTML 元素) - 程序中包含.slideout-menu的 DOM 元素华匾。 -
[options.duration](數(shù)字) - 打開/關(guān)閉 slideout 的時(shí)間（毫秒）。默認(rèn)：300 -
[options.fx](字符串) - 開啟和關(guān)閉 slideout 時(shí)的 CSS 動畫效果机隙。默認(rèn)：ease -
[options.padding](數(shù)字) - 默認(rèn)：256 -
[options.tolerance](數(shù)字) - 默認(rèn)：70 -
[options.touch](布爾值) - 設(shè)置此項(xiàng)為 false 可以禁用 Slideout 的觸摸事件蜘拉。默認(rèn)：true -
[options.side](字符串) - 設(shè)置 slideout 從左側(cè)或右側(cè)打開 (left或right)。默認(rèn)：left
var slideout = new Slideout({
'panel': document.getElementById('main'),
'menu': document.getElementById('menu'),
'padding': 256,
'tolerance': 70
});
Slideout.open();
打開 slideout 菜單有鹿。觸發(fā) beforeopen 和 open 事件旭旭。
slideout.open();
Slideout.close();
關(guān)閉 slideout 菜單。觸發(fā) beforeclose 和 close 事件葱跋。
slideout.close();
Slideout.toggle();
打開/關(guān)閉 slideout 菜單持寄。
slideout.toggle();
Slideout.isOpen();
當(dāng) slideout 處于打開狀態(tài)時(shí)返回 true，當(dāng)處于關(guān)閉狀態(tài)時(shí)返回 false娱俺。
slideout.isOpen(); // true or false
Slideout.destroy();
清理其他的 slideout 實(shí)例使其可以在同一區(qū)域再次創(chuàng)建稍味。
slideout.destroy();
Slideout.enableTouch();
開啟通過觸摸事件打開 slideout。
slideout.enableTouch();
Slideout.disableTouch();
禁止通過觸摸事件打開 slideout荠卷。
slideout.disableTouch();
Slideout.on(event, listener);
slideout.on('open', function() { ... });
Slideout.once(event, listener);
slideout.once('open', function() { ... });
Slideout.off(event, listener);
slideout.off('open', listener);
Slideout.emit(event, ...data);
slideout.emit('open');
事件
一個(gè) Slideout 實(shí)例可以觸發(fā)以下事件：
beforecloseclosebeforeopenopentranslate
只有當(dāng)通過觸摸事件將它打開/關(guān)閉時(shí)模庐，slideout 會觸發(fā) translate 事件。
slideout.on('translate', function(translated) {
console.log(translated); // 120 in px
});
FAQ
如何添加一個(gè)切換按鈕
// vanilla js
document.querySelector('.toggle-button').addEventListener('click', function() {
slideout.toggle();
});
// jQuery
$('.toggle-button').on('click', function() {
slideout.toggle();
});
如何從右側(cè)打開 slideout
你應(yīng)該為 .slideout-menu 類設(shè)置 left: auto油宜。
.slideout-menu {
left: auto;
}
然后掂碱，設(shè)置 side 選項(xiàng)的值為 right怜姿。
var slideout = new Slideout({
'panel': document.getElementById('content'),
'menu': document.getElementById('menu'),
'side': 'right'
});
