Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Node category documentation #623

Merged
merged 28 commits into from
Jul 9, 2019
Merged
Changes from 12 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
c172f62
Merge remote-tracking branch 'upstream/master'
maxmarkus May 15, 2019
c09690a
Merge remote-tracking branch 'upstream/master'
maxmarkus May 16, 2019
76fa8db
Merge remote-tracking branch 'upstream/master'
maxmarkus May 20, 2019
9c86254
Merge remote-tracking branch 'upstream/master'
maxmarkus May 23, 2019
640e287
Merge remote-tracking branch 'upstream/master'
maxmarkus May 23, 2019
2397ede
Merge remote-tracking branch 'upstream/master'
maxmarkus Jun 3, 2019
c052644
Merge remote-tracking branch 'upstream/master'
maxmarkus Jun 13, 2019
37b1b60
Merge remote-tracking branch 'upstream/master'
maxmarkus Jun 18, 2019
89e98c2
Merge remote-tracking branch 'upstream/master'
maxmarkus Jun 25, 2019
49ff5ee
Merge remote-tracking branch 'upstream/master'
maxmarkus Jun 27, 2019
7ca660b
category docu
maxmarkus Jul 1, 2019
9240ad5
category docu fix
maxmarkus Jul 1, 2019
24a4cda
Merge branch 'master' into 615-docu-category-node
jesusreal Jul 2, 2019
04a219f
Merge branch '615-docu-category-node' of github.com:maxmarkus/luigi i…
maxmarkus Jul 2, 2019
3b939c7
docu update
maxmarkus Jul 2, 2019
03ff448
Update docs/navigation-parameters-reference.md
maxmarkus Jul 3, 2019
991658a
Merge branch '615-docu-category-node' of github.com:maxmarkus/luigi i…
maxmarkus Jul 3, 2019
ce1fe72
updated icon info
maxmarkus Jul 3, 2019
7cdc611
Merge branch 'master' into 615-docu-category-node
maxmarkus Jul 3, 2019
f7dfb09
Apply suggestions from code review
maxmarkus Jul 4, 2019
92f90c6
Merge branch 'master' into 615-docu-category-node
maxmarkus Jul 4, 2019
6f492bf
Update docs/navigation-parameters-reference.md
maxmarkus Jul 4, 2019
1e6ba78
Merge branch 'master' into 615-docu-category-node
maxmarkus Jul 5, 2019
0f528fb
Merge branch '615-docu-category-node' of github.com:maxmarkus/luigi i…
maxmarkus Jul 5, 2019
ea0d422
added collapsible docu
maxmarkus Jul 5, 2019
79fd898
Update docs/navigation-parameters-reference.md
maxmarkus Jul 5, 2019
c84930b
Merge branch 'master' into 615-docu-category-node
maxmarkus Jul 8, 2019
e97ef12
Merge branch 'master' into 615-docu-category-node
maxmarkus Jul 9, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/navigation-parameters-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,12 @@ Luigi.setConfig({
children: [node, node, node],
hideFromNav: false,
isolateView: false,
icon: 'settings'
icon: 'settings',
category: {
label: 'General',
icon: 'general'
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a comment with an 'or'?

category: {
  label: 'General',
  icon: 'general'
},//OR 
category: 'General'

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, also thought about this, but we didn't have such case until now. Will add one

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

category: 'General'
},
// DYNAMIC navigation node
{
Expand Down Expand Up @@ -116,6 +121,9 @@ The node parameters are as follows:
- **viewGroup** defines a group of views in the same domain sharing a common security context. This improves performance through reusing the frame. Use **viewGroup** only for the views that use path routing internally.
- **icon** is the name of an icon from the [OpenUI](https://openui5.hana.ondemand.com/1.40.10/iconExplorer.html) or a custom link (relative or absolute) to an image displayed next to the Node label in the side navigation or instead of the label in the top navigation.
- **hideSideNav** if set to `true`, the left navigation disappears when you click the affected node. It is set to `false` by default.
- **category** defines a group of views that is separated with a headline and icon. At least one of the nodes of a group should be defined as an Object with `label` and `icon` properties. For all other nodes it is valid to set **category** as string with the `label` value.
- **label** is a string that represents the title of the category
- **icon** is the name of an icon from the [OpenUI](https://openui5.hana.ondemand.com/1.40.10/iconExplorer.html) or a custom link (relative or absolute) to an image displayed next to the Node label in the side navigation or instead of the label in the top navigation.

## Context switcher

Expand Down