Giter VIP home page Giter VIP logo

jquery.responsivenavigation's Introduction

Responsive Navigation Build Status

Easy to use, semantic approach to responsive navigation.

Getting Started

Download the production version or the development version.

In your web page:

<script src="jquery.js"></script>
<script src="dist/jquery.ResponsiveNavigation.min.js"></script>
<script>
    jQuery(function($) {
        $("header").responsiveNavigation();
    });
</script>

Documentation

You may pass a settings object when calling the plugin.

Available Options

search : A selector used to find individual navigation elements. (Default: "nav")

nested : Place nested navs into their own group. (Default: true)

wrap : Whether to wrap the select element or not. (Default: true)

wrapper : The type of element to wrap the select element in. (Default: "nav")

wrapperClass : The class applied the to the wrapper element. (Default: "responsive-nav-wrapper")

wrapperId : The id given the to the wrapper element. (Default: "")

selectClass : The class applied the to the select element. (Default: "responsive-nav")

selectId : The id given the to the select element. (Default: "")

defaultText : The label given to the default option in the select element. (Default: "Navigation")

group : Whether to group the options based on their navigation. (Default: true if more than 1 nav, false otherwise)

groupLabel : The data attribute specified on the navigation used to label the group. (Default: "label")

groupOrder : The data attribute specified on the navigation used to sort the group. (Default: "order")

Examples

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Also, please don't edit files in the "dist" subdirectory as they are generated via grunt. You'll find source code in the "src" subdirectory!

Release History

v1.0.0

  • Initial release

License

Copyright (c) 2012 Jeremy Worboys Licensed under the โ˜บ Licence.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.