Skip to content
This repository was archived by the owner on Jan 22, 2018. It is now read-only.

Commit 299a14b

Browse files
author
Kamil Kisiela
committed
demo: add documentation of Menu
1 parent 535c9db commit 299a14b

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

demo/client/data/menu.js

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ class Menu {
1717
this.addHeading('advanced');
1818
}
1919

20+
/**
21+
* Add new menu item
22+
* @param {String} name Link's label
23+
* @param {String} type Can be heading, toggle or link
24+
* @param {String|undefined} id Used in /demo/:id
25+
*/
2026
add(name, type, id) {
2127
if (typeof name !== 'string' || name.length === 0) {
2228
throw new Error(`[Menu] name has to be a string`);
@@ -33,18 +39,37 @@ class Menu {
3339
});
3440
}
3541

42+
/**
43+
* Shorthand method to add menu-link
44+
* @param {String} name
45+
* @param {String} id
46+
*/
3647
addLink(name, id) {
3748
this.add(name, 'link', id || name);
3849
}
3950

51+
/**
52+
* Shorthand method to add menu-heading
53+
* @param {String} name
54+
*/
4055
addHeading(name) {
4156
this.add(name, 'heading');
4257
}
4358

59+
/**
60+
* Shorthand method to add menu-toggle
61+
* @param {String} name
62+
*/
4463
addToggle(name) {
4564
this.add(name, 'toggle');
4665
}
4766

67+
/**
68+
* Add a child to menu-toggle
69+
* @param {String} parent Parent menu item id
70+
* @param {String} name item's label
71+
* @param {String} id item's identifier used as value of id parameter
72+
*/
4873
addChild(parent, name, id) {
4974
const found = _.find(this.menu, (item) => item.name === parent);
5075

@@ -64,10 +89,10 @@ class Menu {
6489
});
6590
}
6691

67-
find(id) {
68-
69-
}
70-
92+
/**
93+
* Get menu
94+
* @return {Object}
95+
*/
7196
get() {
7297
return {
7398
sections: this.menu

0 commit comments

Comments
 (0)