node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

bootstrap-dropdown-hover

Bootstrap Dropdown Hover Build Status

Bootstrap Dropdown Hover is a simple plugin which opens Bootstrap dropdown menus on mouse hover, the proper way.

Check the official website for a demo.

Usage

  1. Download the latest tag from the releases page or get it via bower:
$ bower install bootstrap-dropdown-hover
  1. Include jQuery and Bootstrap:
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
  1. Include plugin's code:
<script src="dist/jquery.bootstrap-dropdown-hover.min.js"></script>
  1. Call the plugin:

Initiate on all dropdowns/dropups method 1

$.fn.bootstrapDropdownHover({
  // see next for specifications 
});

Initiate on all dropdowns/dropups method 1

$('[data-toggle="dropdown"]').bootstrapDropdownHover({
  // see next for specifications 
});

Initiate on navbar menu only

$('.navbar [data-toggle="dropdown"]').bootstrapDropdownHover({
  // see next for specifications 
});

Specifications

Initialization parameters object

When calling bootstrapDropdownHover() you can pass a parameters object with zero or more of the following:

  • clickBehavior, 'sticky'|'default'|'disable', defaults to sticky, which means that if we click on an opened dropdown then it will not hide on mouseleave but on a second click only. Can be default, which means that means that the dropdown toggles on hover and on click too, or disable, which disables dropdown toggling with clicking when mouse is detected (so it will open on hover only)
  • hideTimeout, integer, defaults to 200, how much time the hovered dropdown hides after mouseleave (in milliseconds).

Methods

You can modify the behavior of the plugin by calling its methods, all of which accept a value.

To call methods on any dropdown hover instance, use the following syntax:

$(selector).bootstrapDropdownHover(methodName, parameter);

Here are the available methods:

  • setClickBehavior(value) to change the clickBehavior parameter.
  • setHideTimeout(value) to change the hideTimeout parameter.

Furthermore, you can call:

  • destroy() to restore the original behavior.

Structure

The basic structure of the project is given in the following way:

├── dist/
│   ├── jquery.bootstrap-dropdown-hover.js
│   └── jquery.bootstrap-dropdown-hover.min.js
├── src/
│   └── jquery.bootstrap-dropdown-hover.js
├── .editorconfig
├── .gitignore
├── .jshintrc
├── .travis.yml
├── bootstrap-dropdown-hover.jquery.json
├── bower.json
├── Gruntfile.js
├── index.html
└── package.json

dist/

This is where the generated files are stored once Grunt runs.

src/

Contains the source file.

.editorconfig

This file is for unifying the coding style for different editors and IDEs.

Check editorconfig.org if you haven't heard about this project yet.

.gitignore

List of files that we don't want Git to track.

Check this Git Ignoring Files Guide for more details.

.jshintrc

List of rules used by JSHint to detect errors and potential problems in JavaScript.

Check jshint.com if you haven't heard about this project yet.

.travis.yml

Definitions for continous integration using Travis.

Check travis-ci.org if you haven't heard about this project yet.

bootstrap-dropdown-hover.jquery.json

Package manifest file used to publish plugins in jQuery Plugin Registry.

Check this Package Manifest Guide for more details.

Gruntfile.js

Contains all automated tasks using Grunt.

Check gruntjs.com if you haven't heard about this project yet.

package.json

Specify all dependencies loaded via Node.JS.

Check NPM for more details.

Building

To build and test the plugin, you need:

  • NodeJS with npm
  • bower (install it with npm install bower --g)
  • grunt-cli (install it with npm install grunt-cli --g)

Then, cd to the project directory and install the required dependencies:

$ npm install
$ bower install

To run jshint on the plugin code, call:

$ grunt jshint

To build the output js and css files, with the related minified ones, run:

$ grunt

Issues and Contributions

You can report any issue you may encounter on the GitHub Issue Tracker.

To contribute, please follow the contribution guidelines.

History

Check Release list.

License

  Copyright 2015 István Ujj-Mészáros
 
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.