Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JoanClaret/slide-and-swipe-menu
:zap: A sliding swipe menu that works with touchSwipe library.
https://github.com/JoanClaret/slide-and-swipe-menu
css-animations html jquery jquery-plugin slide swipe-menu touchswipe
Last synced: about 1 month ago
JSON representation
:zap: A sliding swipe menu that works with touchSwipe library.
- Host: GitHub
- URL: https://github.com/JoanClaret/slide-and-swipe-menu
- Owner: JoanClaret
- Created: 2015-07-02T08:48:09.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-02-22T15:30:43.000Z (almost 7 years ago)
- Last Synced: 2024-11-15T04:05:03.043Z (about 1 month ago)
- Topics: css-animations, html, jquery, jquery-plugin, slide, swipe-menu, touchswipe
- Language: JavaScript
- Homepage: http://joanclaret.github.io/slide-and-swipe-menu
- Size: 1.24 MB
- Stars: 139
- Watchers: 11
- Forks: 47
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-javascript - slide-and-swipe-menu - A sliding swipe menu that works with touchSwipe library. - ★ 108 (Menu)
README
Slide and swipe menu
========================================
A sliding menu that works with [touchSwipe](http://labs.rampinteractive.co.uk/touchSwipe/) library.
[](https://badge.fury.io/js/slide-and-swipe-menu)
Online demo
-----------
Visit [plugin site](http://joanclaret.github.io/slide-and-swipe-menu).
[Appszoom](http://www.appszoom.com) also uses it! So cool!
What's the difference with other sliders?
-----------
This plugin uses CSS3 transform property to move the navigation. That's why it works smoothly. Because [performance matters](http://perf.rocks/).
* Only 1 js file (+ jQuery + touchSwipe)
* 1Kb minified
Installation
-----------
### 1. Grab a copy of the plugin
Using bower
```bash
bower install slide-and-swipe-menu --save-dev
```
Using npm
```bash
npm install slide-and-swipe-menu --save-dev
```
or [download the plugin](https://github.com/JoanClaret/slide-and-swipe-menu/archive/master.zip) from GitHub
### 2. Load the required files
Load them in the html
```html
```
or use Browserify
```javascript
require('slide-and-swipe-menu');
```
### 3. Create the HTML markup
```html
[...]
[...]
Open / close
```
### 4. Initialize the plugin
Default initialization
```javascript
$(document).ready(function() {
$('nav').slideAndSwipe();
});
```
### 5. Add some CSS
```css
/* navigation */
nav {
height: 100%;
width: 280px;
background-color: #0a4a3c;
left: 0;
top: 0;
z-index: 2;
position: fixed;
overflow-y: auto;
overflow-x: visible;
transform: translate(-280px,0);
}
/* overlay layer */
.ssm-overlay {
position: fixed;
top: 0;
right: 0;
bottom: 0;
left: 0;
background-color: rgba(0,0,0,0.2);
display: none;
z-index: 1;
}
/* prevent scroll when nav is open */
.is-navOpen{
overflow: hidden;
}
```
### Follow the repository
★ Star and watch [this repo](https://github.com/JoanClaret/slide-and-swipe-menu) in order to stay updated with news about this plugin
License
--------
The MIT License (MIT)
Copyright (c) 2015 Joan Claret
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Other useful plugins
---------------------
* [Maximum Characters limit warning](https://github.com/JoanClaret/max-char-limit-warning): Get a warning when the max char limit has been exceeded with a jQuery plugin
* [jcSlider](http://joanclaret.github.io/jcSlider): A responsive slider jQuery plugin with CSS animations
* [html5 canvas animation](http://joanclaret.github.io/html5-canvas-animation): 3D lines animation with three.js
* [jquery dynamic max height](http://joanclaret.github.io/jquery-dynamic-max-height) : Dynamic max height plugin for jQuery with CSS animation