Slideout.js — 触摸滑出式 Web App 导航菜单


( 类似手机QQ左触摸滑动,出现个人设置等信息。)


简介

Slideout.js 是为您的移动 Web 应用开发的触摸滑出式的导航菜单。它没有依赖,自由搭配简单的标记,支持原生的滚动,您可以轻松地定制它。它支持不同的 CSS3 转换和过渡。最重要的是,它只是4KB 。


兼容


  • Chrome(iOS、Android、PC)

  • Firefox(Android、PC)

  • Safari(iOS、Android、PC)

  • Opera(PC)

  • IE 10+(PC)



使用方法

1、引入文件

<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

2、如何使用

1
2
3
4
5
6
7
8
9
10
11
<nav id="menu">
   <header>
     <h2>Menu</h2>
   </header>
</nav>
 
<main id="panel">
   <header>
     <h2>Panel</h2>
   </header>
</main>

然后在你的 .css 文件中为 Slideout 添加样式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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 并创建一个实例

1
2
3
4
5
6
7
8
9
<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>

完整示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<!doctype html]
<html]
   <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]?[/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]

参数


  • Slideout(options)

    创建一个新的 Slideout 实例所要用到的选项

    • options (对象) - 一个使用自定义选项的 Slideout 实例。

    • options.panel (HTML 元素) - 程序中包含 .slideout-panel 的 DOM 元素。

    • options.menu (HTML 元素) - 程序中包含 .slideout-menu 的 DOM 元素。

    • [options.duration] (数字) - 打开/关闭 slideout 的时间(毫秒)。默认:300

    • [options.fx] (字符串) - 开启和关闭 slideout 时的 CSS 动画效果。默认:ease

    • [options.padding] (数字) - 默认:256

    • [options.tolerance] (数字) - 默认:70

    • [options.touch] (布尔值) - 设置此项为 false 可以禁用 Slideout 的触摸事件。默认:true

    • [options.side] (字符串) - 设置 slideout 从左侧或右侧打开 (left 或 right)。默认:left

    1
    2
    3
    4
    5
    6
    var slideout = new Slideout({
    'panel': document.getElementById('main'),
    'menu': document.getElementById('menu'),
    'padding': 256,
    'tolerance': 70
    });

    Slideout.open();
    打开 slideout 菜单。触发 beforeopen 和 open 事件。

    1
    slideout.open();

    Slideout.close();
    关闭 slideout 菜单。触发 beforeclose 和 close 事件。

    1
    slideout.close();

    Slideout.toggle();
    打开/关闭 slideout 菜单。

    1
    slideout.toggle();

    Slideout.isOpen();
    当 slideout 处于打开状态时返回 true,当处于关闭状态时返回 false。

    1
    slideout.isOpen(); // true or false

    Slideout.destroy();
    清理其他的 slideout 实例使其可以在同一区域再次创建。

    1
    slideout.destroy();

    Slideout.enableTouch();
    开启通过触摸事件打开 slideout。

    1
    slideout.enableTouch();

    Slideout.disableTouch();
    禁止通过触摸事件打开 slideout。

    1
    slideout.disableTouch();

    Slideout.on(event, listener);

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

    Slideout.once(event, listener);

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

    Slideout.off(event, listener);

    1
    slideout.off('open', listener);

    Slideout.emit(event, ...data);

    1
    slideout.emit('open');

    事件

    一个 Slideout 实例可以触发以下事件:

    • beforeclose

    • close

    • beforeopen

    • open

    • translate

    只有当通过触摸事件将它打开/关闭时,slideout 会触发 translate 事件。

    1
    2
    3
    slideout.on('translate', function(translated) {
         console.log(translated); // 120 in px
    });

    FAQ

    如何添加一个切换按钮

    1
    2
    3
    4
    5
    6
    7
    8
    // vanilla js
    document.querySelector('.toggle-button').addEventListener('click', function() {
         slideout.toggle();
    });
    // jQuery
    $('.toggle-button').on('click', function() {
         slideout.toggle();
    });

    如何从右侧打开 slideout

    你应该为 .slideout-menu 类设置 left: auto。

    1
    2
    3
    .slideout-menu {
         left: auto;
    }

    然后,设置 side 选项的值为 right。

    1
    2
    3
    4
    5
    var slideout = new Slideout({
         'panel': document.getElementById('content'),
         'menu': document.getElementById('menu'),
         'side': 'right'
    });


  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值