Giter VIP home page Giter VIP logo

auto-collapse's Introduction

Auto Collapse

jQuery plugin to automatically collapse menus.


Installation

Auto Collapse depends on jQuery. To use it, include this in your page :

<script src="jquery.js" type="text/javascript"></script>
<script src="auto-collapse.js" type="text/javascript"></script>

Usage

When you call the plugin for the first time, it will check if the class normalClass, which is by default 'navbar-normal', is present on the element to determine if the menu is collapsed or not.

Each time the window is resized, the plugin will check if the menu can fit on one line. If not it will apply the responsiveClass, which is by default 'navbar-responsive'. It will also search for links matching the dropdownLinkSelector, which is by default '.dropdown > a', and make them dropdown menus.

Here is how you can call the plugin:

$(function() {
  $('.navbar').autoCollapse();
});

Options

normalClass {string}

Class to apply when the menu is not collapsed.

responsiveClass {string}

Class to apply when the menu is collapsed.

dropdownLinkSelector {string}

Selector to use to find dropdown links in the menu.

shouldCollapseDelegate {function}

Delegate to determine if the menu should be collapsed.

updateOnResize {boolean}

Set to false if you want to handle yourself when to check if the menu should be collapsed.


Author

Nicolas Badia


Copyright and license

Copyright 2012-2018 GestiXi under The MIT License (MIT).

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.