https://github.com/soulcutter/togglemenu

A jQuery plugin for toggle style menus
https://github.com/soulcutter/togglemenu

Last synced: 22 days ago
JSON representation

A jQuery plugin for toggle style menus

• Host: GitHub
• URL: https://github.com/soulcutter/togglemenu
• Owner: soulcutter
• License: mit
• Created: 2011-08-17T05:18:57.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2011-08-31T05:04:29.000Z (about 13 years ago)
• Last Synced: 2024-10-06T03:17:15.466Z (about 1 month ago)
• Language: JavaScript
• Homepage: http://soulcutter.github.com/ToggleMenu
• Size: 133 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
toggleMenu plugin for jQuery

============================

toggleMenu is a simple menu system which uses [jQuery][0]'s

[toggle()](http://api.jquery.com/toggle/) or [jQuery UI][1]'s

[toggle()][2] methods to open and close the

menu. Default behavior is that clicking outside of the menu results in the menu

closing, and only one menu can be open at a time.

Installation

------------

Simply download jquery.togglemenu.js and add it to your javascript includes

after [jQuery][0] and, if applicable, after [jQuery UI][1].

Available Options

-----------------

toggleMenu may take a hash argument to supply the following options:

  * `opener` (***recommended***): A jQuery element intended to be clicked on

    in order to display the menu.

  * `transition` (*default:* `'linear'`): A string,

    [the name of an effect][2].

  * `duration` (*default:* `'fast'`): A string `'fast'` or `'slow'`, or a number

    of milliseconds. This defines how long the transition will take.

  * `onClick` (*default:* no-op function): A function to define the behavior of

    clicking on an element within the menu.

  * `onClickFilter` (*default:* none): A jQuery selector string to use so that

    only matching elements trigger an onClick event.

Homepage and Demo

-----------------

[http://soulcutter.github.com/ToggleMenu/](http://soulcutter.github.com/ToggleMenu/)

[0]: http://jquery.com/

[1]: http://jqueryui.com/

[2]: http://jqueryui.com/demos/toggle/