awesome-menu v1.0.5
awesome-menu
Description
Here is a simple demo.
Good Compalibility.
It supports unlimited level.
It supports customized style. You can customize different style for each level.
It supports customized submenu expansion style. All what you should do is passing a kind of expansion event, or a kind of fold event.
It supports customized selected event. That means any event type can be the one of triggering selected. It depends on which you pass.
It is easy to use. The configuration for each level can be inherited. More specifically, submenu inherits its parent menu's configuration (exclude menu data).
Here are some simple instances:
Install
# use npm
$ npm install awesome-menu
# use bower
$ bower install awesome-menuUsage
var Menu = require('awesome-menu');
var menu = new Menu({
'menuId': 'menu',
'menuClass': 'menu',
'defaultSelected': {
'id': '1',
'level': '1'
},
'levelConfig': {
'1': {
'listClass': '',
'wrapClass': '',
'itemClass': '',
'selectedClass': '',
'hoverClass': '',
'selectEvent': '',
'childExpandEvent': '',
'childFoldEvent': '',
'position': '',
'hideAfterSelected': ''
},
'3': {
...
}
},
'list': [{
'id': '1',
'name': 'xxx',
'content': 'xxx',
'list': [{...}, {...}]
}, {...}]
});
$('xxx').append(menu.render());Options
menuId (string)
description:
The most outside container's id.
menuClass (string)
description:
The most outside container's class.
defaultSelected (object)
description:
Set the default selected item when the menu is initilized. It contains two attributes: id and 'level'.
onlyOneExpansion (boolean)
description:
Determine whether there is only one expanded list in the same level all the time. Default is true.
selectedFunc (function)
description:
Customized callback when one item is selected. and the callback function will get a parameter data. The data parameter records current selected item's releative information. And this is binded to the callback.
list (array)
description:
It is a nested data structure which contains the menu's data.
levelConfig (object)
description:
It is the configuraiton for each level. Attribute '1' represents the configuration for the first level and so on. Each level inherit its parent level by default if the level is not configured.
And it has many optional configuration parameters:
| attribute | value | description |
|---|---|---|
| listClass | text | the class of each sublist's outside container |
| wrapClass | text | the class of each item's outside container |
| itemClass | text | the class of each item |
| hoverClass | text | the class of each item when triggering hover event |
| selectedClass | text | the class of each item when it is selected |
| selectEvent | event type | the event type which can trigger item's selection |
| childExpansion | boolean | whether sublist is expanded by default |
| childExpandEvent | event type | the event type which can trigger sublist's expansion |
| childFoldEvent | event type | the event type which can trigger sublist's fold |
| position | 'right', 'left', 'top', 'bottom' | the position relative to its parent list |
| hideAfterSelected | boolean | whether hide when it is selected |
Methods
render()
return the generated menu
reset(options)
reset the whole menu according to the passed parameter
updateContent(option, content)
update specific item's content
License
The MIT License (MIT) Copyright (c)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.