docs: document MenuConfiguration #3770
Open
+49
−103
Conversation
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
Renamed menu-registry to menu-configuration. Updated content to match with new simpler public API of MenuConfiguration. MenuRegistry was changed to internal API and only new public API is documented. RelatedTo: vaadin/flow#20063
github-actions
bot
added
the
Language unchecked
caalador
reviewed
Oct 8, 2024
|
|
||
| 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: |
There was a problem hiding this comment.
This should/could perhaps mention that the returned list is ordered by order+alphabetically.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Renamed menu-registry to menu-configuration. Updated content to match with new simpler public API of MenuConfiguration. MenuRegistry was changed to internal API and only new public API is documented.
RelatedTo: vaadin/flow#20063