-
Notifications
You must be signed in to change notification settings - Fork 187
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
docs: document MenuConfiguration #3770
Open
tltv
wants to merge
2
commits into
latest
Choose a base branch
from
docs/menu-configuration
base: latest
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+49
−103
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
title: Menu Configuration | ||
description: Collecting menu annotated routes for menu generation. | ||
order: 115 | ||
--- | ||
|
||
|
||
= Menu Configuration | ||
|
||
To generate a custom menu there's the [classname]`MenuConfiguration` for collecting defined server and client routes. Client routes are collected from the FileSystem routes definition. Server routes are collected for routes annotated with [annotationname]`@Menu`. | ||
|
||
The collected menu items are filtered by access control from the [classname]`UI` ([classname]`NavigationAccessControl` and [classname]`ViewAccessChecker`). If the application has login and route defined `Roles`, the returned list is filtered for only available routes. | ||
|
||
|
||
== Creating Routes Menu | ||
|
||
For a Flow application, any route annotated with [annotationname]`@Menu` is eligible for automatic collection. | ||
|
||
To get the available menu routes, call the static method `MenuConfiguration.getMenuEntries()`. This returns a [classname]`List<MenuEntry>`. It would make creating a simple menu using [classname]`Anchor` look like this: | ||
|
||
[source,java] | ||
---- | ||
List<MenuEntry> menuEntries = MenuConfiguration.getMenuEntries(); | ||
menuEntries.forEach(entry -> layout.add(new Anchor(entry.path(), entry.title()))); | ||
---- | ||
|
||
== Data Returned for Menu Entries | ||
|
||
The [classname]`MenuEntry` for the route contains information on the route. Using this data, it's possible to populate a menu, automatically. | ||
|
||
The data contained is as follows: | ||
|
||
`path`:: | ||
Route path that should be used for navigation. | ||
|
||
`title`:: | ||
Title set in the [annotationname]`@Menu` annotation or the [annotationname]`@PageTitle` if defined; else the class simple name. For the client, title is populated from the FS router data. | ||
|
||
`order`:: | ||
Order number for the menu entry if defined. | ||
|
||
`icon`:: | ||
Icon to use in the menu. The value can be entered inside a `<vaadin-icon>` element's `icon` attribute. This accepts icon group and a name like `vaadin:file`. Or the value can be given in `<vaadin-icon>` element's `src` attribute, which takes the path to the icon (e.g., `line-awesome/svg/lock-open-solid.svg`). | ||
|
||
`menuClass`:: | ||
Source class of the [annotationname]`@Menu` annotation. Always null for client routes. | ||
|
||
[discussion-id]`647922A8-D542-4FA7-AAF6-44D40FC6A33B` |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should/could perhaps mention that the returned list is ordered by order+alphabetically.