Skip to content

imclab/jquery-navobile

 
 

Repository files navigation

#jQuery navobile

For full documentation please see the demo page.

Build Status

###Demo

View live demo

###Usage

$('#foobar').navobile();

The css required for the plugin is here because its always better to control styling in CSS where possible.

###Params

There are a few parameters for the plugin, they are mostly optional.

  • cta - the element that will open the navigation on click (default: '#show-navigation')
  • content - the selector that wraps the content that will slide out (default: '#content')
  • easing - jQuery easing function to use in $.animate fallback (default: 'linear') for more easing options you will require jQuery.easing
  • changeDOM - Boolean, whether the plugin needs to move the navigation in the DOM structure (default: false)
  • hammerOptions - a Javascript object containing the options detailed here: https://github.com/EightMedia/hammer.js/wiki/Getting-Started#gesture-options. Only needed if you are using bindSwipe/bindDrag (default: {})

###Credits

Developed and maintained by Made.

made

Key contributions:

###License

Licensed under New BSD License