touch-menu-la
v0.5.0
Published
A touch menu like Navigation Drawer of Android.
Downloads
4
Maintainers
Readme
Touch Menu Like Android
hammer.js to touch events.
A touch menu like Navigation Drawer of Android.
Use with cordova project, ionic.
Demo
Browser Support
Browser | Support --- | --- I.E | 10+ Chrome | ✔ Firefox | 3.5+ ✔ Opera | 23+ ✔ Safari | ✔ Android Browser | 2.3+ ✔ iOS Safari | 5.1+ ✔
Usage
Include plugin's css
<link rel="stylesheet" href="src/css/touch-menu-la.min.css">
Include a div with class 'touch-menu-la'
<div id="menu" class="touch-menu-la"></div>
Include hammer.js and plugin's js
<script src="https://cdnjs.cloudflare.com/ajax/libs/hammer.js/2.0.6/hammer.min.js"></script>
<script src="src/js/touch-menu-la.min.js"></script>
Call the plugin with required option 'target'
TouchMenuLA({
target: document.getElementById('menu')
});
Options
list of avaliable settings:
Attribute | Type | Default | Description
--- | --- | --- | ---
target
| DOM Element | | Required - The target element for the plugin to create the menu
width
| Integer | 280
| Width of menu
zIndex
| Integer | 99999
| Style z-index of menu and mask
disableSlide
| Boolean | false
| Disable slide of menu
handleSize
| Integer | 20
| Size of handle to slide
disableMask
| Boolean | false
| Disable the mask
maxMaskOpacity
| Double | 0.5
| Max opacity of mask (when menu is opened). Numbers between 0 and 1.
onOpen
| Function | | Function called when menu is opened. (the scope is this menu instance, try to use 'this')
onClose
| Function | | Function called when menu is closed. (the scope is this menu instance, try to use 'this')
Propertie and Methods
You can use this propertie and methods after call the plugin.
Propertie
isVisible - Return a Boolean
of state of menu
Methods
open(); - Open the menu
close(); - close the menu
toggle(); - open or close menu
See this example:
var TouchMenu = TouchMenuLA({
target: document.getElementById('menu'),
onOpen: function(){
console.log(this.isVisible);
}
});
document.getElementByID('any-element').addEventListener('click', function(){
TouchMenu.open();
});
License
The MIT License (MIT)
Copyright (c) 2016 Erick R. Alves Aguiar
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.