@vks-dev/jquery-dropdown-menu
Version:
jQuery Dropdown Menu - A simple dropdown menu plugin for jQuery - VKS package
72 lines (51 loc) • 1.45 kB
Markdown
# @vks-dev/jquery-dropdown-menu
jQuery Dropdown Menu - A simple dropdown menu plugin for jQuery.
This is a VKS-specific package wrapping a custom dropdown menu jQuery plugin.
## Installation
```bash
npm install @vks-dev/jquery-dropdown-menu
```
## Usage
```javascript
import '@vks-dev/jquery-dropdown-menu';
import $ from 'jquery';
// Initialize dropdown menu
$('#my-menu').dropdownMenu();
```
## Features
- Simple dropdown menu functionality
- Automatic menu state management
- Click-to-open submenu support
- Mouse hover interactions
- Icon rotation on open/close (using jQuery UI icons)
- Document click to close menu
- Event bubbling control
## HTML Structure
```html
<div id="my-menu">
<ul>
<li>
<a href="#" class="submenu">
Menu Item
<span class="ui-icon ui-icon-carat-1-s"></span>
</a>
<ul>
<li><a href="#">Submenu Item 1</a></li>
<li><a href="#">Submenu Item 2</a></li>
</ul>
</li>
</ul>
</div>
```
## API
### Methods
- `dropdownMenu()` - Initialize dropdown menu on the selected element
### Behavior
- Click on `a.submenu` links to toggle submenu visibility
- Icons rotate between `ui-icon-carat-1-s` (closed) and `ui-icon-carat-1-n` (open)
- Hovering over top-level menu items closes other open submenus
- Clicking outside the menu closes all submenus
## License
MIT
## Copyright
Copyright (c) 2010-2015 Visual Knowledge Share Ltd, All rights reserved.