Détail du package

sidr

artberri2.7kMIT2.2.1

jQuery plugin for creating side menus and the easiest way for doing your menu responsive

menu, responsive, navigation, jquery-plugin

readme

Sidr

Build Status Code Climate Test Coverage Dependency Status npm version bower version License

Sidr is a jQuery plugin for creating side menus and the easiest way for doing your menu responsive. It uses CSS3 transitions in modern browsers and fallbacks into jQuery.animate when they are not supported.

For a further description, documentation and others visit: http://www.berriart.com/sidr

Development

Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change you make.

Licensing

Released under the MIT License http://opensource.org/licenses/MIT

Copyright © 2013-2016 Alberto Varela (http://www.berriart.com)

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.

changelog

Changelog

2.2.1 2016-02-17

Bug fixes:

  • Removed the preinstall script that was generating problems when installing from npm

2.2.0 2016-02-16

New features:

  • Added bind option that can be used to change the button event that will trigger the menu toggle
  • Added the status method to get the Sidr status object

From this version the bundling is done with rollup instead of browserify.

2.1.0 2016-01-20

New features:

  • Now it works with CSS3 transitions by default and fallbacks to jQuery.animate when not supported
  • Added timing option that can be used to indicate the transition timing function for the CSS3 transitions
  • Added method option to change the default behaviour of the button (that is currently the toggle method)
  • Added onOpenEnd option to add a callback that will be fired when the menu ends opening
  • Added onCloseEnd option to add a callback that will be fired when the menu ends closing

Bug fixes:

  • Launch callback when a menu open is delayed until another one is closed
  • Fixes bug introduced in 2.0.0 that added a method called 'undefined' in addition to the methods close, open, toggle

This version has a complete code refactor for code quality improvements:

  • ES2015 syntax supported
  • jquery.sidr.js file split
  • Start Unit testing

2.0.0 2016-01-10

Breaking changes that require major version incrementation:

  • Removing position:absolute fallback that added support for very old mobile browsers
  • Removing toogle method that was a typo, use toggle instead

Bug fixes:

  • Fixing tap event on touchscreen devices
  • Removing unnecessary compass mixins
  • Fixes reinitalization
  • Adding example
  • Fixing bower structure
  • Adding continous integration
  • Fixing adding body classes when no displacing
  • Removing only the needed styles from html and body tag

1.2.1 2013-11-06

  • Fixing tap event on touch devices

1.2.0 2013-11-05

  • Adding bind to tap event if exists instead of click (faster)
  • Fixed reopening menu bug in some browsers and jQuery versions
  • Add a body class when the sidr menu is open and when animating
  • Fixing the toogle/toggle typo
  • Adds an option to allow choosing between displace or not the content (displace)
  • Added callbacks for onOpen and onClose

1.1.1 2013-03-13

  • Fix bug when closing sidr programatically

1.1.0 - 2013-03-11

  • Added the body option

1.0.0 - 2013-02-20

  • First public version