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

Automatic main menu documentation #3410

Open
platosha opened this issue May 6, 2024 · 1 comment
Open

Automatic main menu documentation #3410

platosha opened this issue May 6, 2024 · 1 comment

Comments

@platosha
Copy link
Contributor

platosha commented May 6, 2024

We should have an article explaining how the automatic main menu works. The aspects to mention:

  • How the menu entries are collected:
    • In Flow, using the @Menu annotation,
    • In Hilla, using the file router views metadata.
  • What kind of sorting and filtering is applied.
  • How the user authentication affects the menu with various view access control rules.
  • How to get the data for menu items and render the menu:
    • createMenuItems() function in Hilla
    • Equivalent for Flow

Update creating the main menu guide: https://vaadin.com/docs/next/flow/application/main-view#flow.application.main-view.menu

@platosha platosha added the hilla label May 6, 2024
@taefi
Copy link
Contributor

taefi commented May 6, 2024

The Creating Menu From Routes heading is partially addressing this issue. Probably, some points regarding the filtering/ordering of the menus can be covered under the same section (not to detailed though), and a separate article at the Platform level docs can cover the topic in more details also addressing the hybrid applications.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants