Slideout.js 侧边栏滑动菜单插件 - 文章教程

Slideout.js 侧边栏滑动菜单插件

发布于 2020-06-02 字数 12944 浏览 1357 评论 0

Slideout.js 是一个侧边栏滑动菜单插件,为您的移动网络应用程序而生,在手机上有很好的效果,而且兼容性极佳,没有依赖轻量级侧滑插件。

Slideout.js 侧边栏滑动菜单插件

安装 Slideout.js

Slideout.js 滑出在 cdnjs 上是可用的。

<script src="https://cdnjs.cloudflare.com/ajax/libs/slideout/1.0.1/slideout.min.js"></script>

此外您还可以使用许多包管理器之一。

$ npm install slideout

$ spm install slideout

$ bower install slideout.js

$ component install mango/slideout

使用方法

在项目中实现 Slideout.js 很容易。

首先,您需要创建标记。你应该有菜单 #menu 和主要内容 #panel

<nav id="menu">
  <header>
    <h2>Menu</h2>
  </header>
</nav>

<main id="panel">
  <header>
    <h2>Panel</h2>
  </header>
</main>

在 Web 应用程序中添加 Slideout.js 样式(index.css)。

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

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

.slideout-menu-left {
  left: 0;
}

.slideout-menu-right {
  right: 0;
}

.slideout-panel {
  position: relative;
  z-index: 1;
  will-change: transform;
  background-color: #FFF; /* A background-color is required */
  min-height: 100vh;
}

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

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

然后,只需引入 Slideout.js,创建一个带有一些选项的新实例,并调用 toggle() 方法:

<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>

完整示例

<!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: 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;
      }
    </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,桌面)
  • Firefox(Android,桌面)
  • Safari(iOS、Android、桌面)
  • OPERA(桌面)
  • IE 10+(桌面和移动)

API

滑出(选项)

创建一个新的实例。Slideout.

  • options(object)-自定义Slideout的新实例的选项。
  • options.panel(HTMLElement)-包含所有应用程序内容的DOM元素(.slideout-panel).
  • options.menu(HTMLElement)-包含菜单应用程序的DOM元素(.slideout-menu).
  • [options.duration](number)-打开/关闭滑块的时间(毫秒)。默认:300.
  • [options.easing](String)-当动画化幻灯片的开始和关闭时要使用的CSS效果。默认:ease。可能的值:
    • ease
    • linear
    • ease-in
    • ease-out
    • ease-in-out
    • step-start
    • step-end
    • cubic-bezier
  • [options.padding](number)-默认:256.
  • [options.tolerance](number)-px所需的菜单可以完全打开,否则它关闭。默认:70.
  • [options.touch](Boolean)-将此选项设置为false,以禁用Slideout触摸事件。默认:true.
  • [options.side](string)-打开滑块的一侧(leftright)。默认:left.
var slideout = new Slideout({
  'panel': document.getElementById('main'),
  'menu': document.getElementById('menu'),
  'padding': 256,
  'tolerance': 70,
  'easing': 'cubic-bezier(.32,2,.55,.27)'
});

Slideout.open();

打开滑出菜单。它发出 beforeopenopen 事件。

slideout.open();

Slideout.lose();

关闭滑出菜单。它发出 beforecloseclose 事件。

slideout.close();

Slideout.toggle();

切换(打开/关闭)滑出菜单。

slideout.toggle();

Slideout.isOpen();

返回 true 如果滑块当前处于打开状态,并且 false 如果它关闭了。

slideout.isOpen(); // true or false

Slideout.destroy();

清理实例,以便在同一区域创建另一个滑块。

slideout.destroy();

Slideout.enableTouch();

允许通过触摸事件打开滑块。

slideout.enableTouch();

Slideout.disableTouch();

禁止通过触摸事件打开滑块。

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');

事件

Slideout 的一个实例会发出以下事件:

  • beforeclose
  • close
  • beforeopen
  • open
  • translatestart
  • translate
  • translateend

滑出 translatestart, translatetranslateend事件只有在通过触摸事件打开/关闭时才发生。

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'

data-slideout-ignore 属性

您可以使用特殊的HTML属性data-slideout-ignore若要禁用某些元素的拖动,请执行以下操作。例如,如果你必须防止slideout当触摸到旋转木马、地图、假象等时会打开。

<main id="panel">
  <header>
    <h2>Panel</h2>
  </header>
  <div id="carousel" data-slideout-ignore>
    <h2>Carousel</h2>
    ...
  </div>
</main>

NPM 脚本

$ 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();
});

如何从右侧打开滑块。

您应该使用side值的选项right.

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

如何仅在移动设备上启用幻灯片。

你应该用mediaqueries:

@media screen and (min-width: 780px) {
  .slideout-panel {
    margin-left: 256px;
  }

  .slideout-menu {
    display: block;
  }

  .btn-hamburger {
    display: none;
  }
}

演示:http://codepen.io/pazguille/pen/mEdQvX

如何使用带固定标题的滑块。

首先,您应该为固定的标题定义样式:

.fixed-header {
  position: fixed;
  width: 100%;
  height: 50px;
  backface-visibility: hidden;
  z-index: 2;
  background-color: red;
}

然后,使用SLEDEOT的事件,您应该转换固定的标题:

var fixed = document.querySelector('.fixed-header');

slideout.on('translate', function(translated) {
  fixed.style.transform = 'translateX(' + translated + 'px)';
});

slideout.on('beforeopen', function () {
  fixed.style.transition = 'transform 300ms ease';
  fixed.style.transform = 'translateX(256px)';
});

slideout.on('beforeclose', function () {
  fixed.style.transition = 'transform 300ms ease';
  fixed.style.transform = 'translateX(0px)';
});

slideout.on('open', function () {
  fixed.style.transition = '';
});

slideout.on('close', function () {
  fixed.style.transition = '';
});

演示:http://codepen.io/pazguille/pen/ZBxdgw

如何禁用某些元素的拖动。

您可以使用该属性data-slideout-ignore若要禁用某些元素的拖动,请执行以下操作:

<nav id="menu">
  <header>
    <h2>Menu</h2>
  </header>
</nav>

<main id="panel">
  <header>
    <h2>Panel</h2>
  </header>
  <div id="carousel" data-slideout-ignore>
    <h2>Carousel</h2>
    ...
  </div>
</main>

如何在单击时添加覆盖以关闭菜单。

你可以用强大的力量slideoutAPI和一些额外的CSS:

.panel:before {
  content: '';
  display: block;
  background-color: rgba(0,0,0,0);
  transition: background-color 0.5s ease-in-out;
}

.panel-open:before {
  position: absolute;
  top: 0;
  bottom: 0;
  width: 100%;
  background-color: rgba(0,0,0,.5);
  z-index: 99;
}
function close(eve) {
  eve.preventDefault();
  slideout.close();
}

slideout
  .on('beforeopen', function() {
    this.panel.classList.add('panel-open');
  })
  .on('open', function() {
    this.panel.addEventListener('click', close);
  })
  .on('beforeclose', function() {
    this.panel.classList.remove('panel-open');
    this.panel.removeEventListener('click', close);
  });

演示:http://codepen.io/pazguille/pen/BQYRYK

相关链接

如果你对这篇文章有疑问,欢迎到本站 社区 发帖提问或使用手Q扫描下方二维码加群参与讨论,获取更多帮助。

扫码加入群聊

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

目前还没有任何评论,快来抢沙发吧!

关于作者

JSmiles

生命进入颠沛而奔忙的本质状态,并将以不断告别和相遇的陈旧方式继续下去。

2583 文章
29 评论
84935 人气
更多

推荐作者

佚名

文章 0 评论 0

cs163v

文章 0 评论 0

Mr Rock

文章 0 评论 0