npm package: @regru/jquery-menu-aim
Description: jQuery plugin to fire events when user's cursor aims at particular dropdown menu items.
Author: Ben Kamens
Latest version: 1.0.0

jQuery-menu-aim
===============

menu-aim is a jQuery plugin for dropdown menus that can differentiate
between a user trying hover over a dropdown item vs trying to navigate into
a submenu's contents.

[Try a demo.](https://rawgithub.com/kamens/jQuery-menu-aim/master/example/example.html)

![Amazon screenshot](https://raw.github.com/kamens/jQuery-menu-aim/master/amazon.png)

This problem is normally solved using timeouts and delays. menu-aim tries to
solve this by detecting the direction of the user's mouse movement. This can
make for quicker transitions when navigating up and down the menu. The
experience is hopefully similar to amazon.com/'s "Shop by Department"
dropdown.

## Use like so:

     $("#menu").menuAim({
         activate: $.noop,  // fired on row activation
         deactivate: $.noop  // fired on row deactivation
     });

...to receive events when a menu's row has been purposefully (de)activated.

The following options can be passed to menuAim. All functions execute with
the relevant row's HTML element as the execution context ('this'):

     .menuAim({
         // Function to call when a row is purposefully activated. Use this
         // to show a submenu's content for the activated row.
         activate: function() {},

         // Function to call when a row is deactivated.
         deactivate: function() {},

         // Function to call when mouse enters a menu row. Entering a row
         // does not mean the row has been activated, as the user may be
         // mousing over to a submenu.
         enter: function() {},

         // Function to call when mouse exits a menu row.
         exit: function() {},

         // Function to call when mouse exits the entire menu. If this returns
         // true, the current row's deactivation event and callback function
         // will be fired. Otherwise, if this isn't supplied or it returns
         // false, the currently activated row will stay activated when the
         // mouse leaves the menu entirely.
         exitMenu: function() {},

         // Selector for identifying which elements in the menu are rows
         // that can trigger the above events. Defaults to "> li".
         rowSelector: "> li",

         // You may have some menu rows that aren't submenus and therefore
         // shouldn't ever need to "activate." If so, filter submenu rows w/
         // this selector. Defaults to "*" (all elements).
         submenuSelector: "*",

         // Direction the submenu opens relative to the main menu. This
         // controls which direction is "forgiving" as the user moves their
         // cursor from the main menu into the submenu. Can be one of "right",
         // "left", "above", or "below". Defaults to "right".
         submenuDirection: "right"
     });

menu-aim assumes that you are using a menu with submenus that expand
to the menu's right. It will fire events when the user's mouse enters a new
dropdown item *and* when that item is being intentionally hovered over.

## Want an example to learn from?

Check out example/example.html -- it has [a working dropdown for you to play with](https://rawgithub.com/kamens/jQuery-menu-aim/master/example/example.html):

![Example screenshot](https://raw.github.com/kamens/jQuery-menu-aim/master/example.png)<br>
_Play with the above example full of fun monkey pictures by opening example/example.html after downloading the repo._

## FAQ

1. What's the license? [MIT](http://en.wikipedia.org/wiki/MIT_License).
2. Does it support horizontal menus or submenus that open to the left? Yup. Check out the submenuDirection option above.
3. I work at a big company that requires a version number on this third party code before I can use it. Do you have a version number? Sure, current version: 1.1
4. I'm not nearly bored enough. Got anything else? [Read about this plugin's creation](http://bjk5.com/post/44698559168/breaking-down-amazons-mega-dropdown).