feat: allow matching navigation hierarchies with side nav item

[sissbruecker]

Adds a matchNested property to vaadin-side-nav-item that allows an item to match nested paths. When enabled, then an item with the path /users does not only match /users, but also /users/1, /users/1/permissions, etc.

For context, the Flow RouterLink and React Router NavLink have similar options:

• RouterLink allows setting a HighlightCondition that determines whether the link is considered active or not. The most useful default implementations are HighlightConditions.sameLocation (exact match) and HighlightConditions.locationPrefix (match prefix).
• NavLink has an end property to force exact matching, otherwise it matches by prefix.

Note that both RouterLink and NavLink use prefix matching by default, while side nav item would keep using exact matching by default. For now we keep the default behavior to avoid breaking changes. We can consider aligning the defaults in a future major.

Closes vaadin/flow-components#5227

[knoobie]

Thanks Sascha! 🙇‍♂️ Votes for 24.5 inclusion

[sissbruecker]

We are (theoretically) very close to beta, so I'm not sure. Will bring it up with the team on Monday.

[web-padawan]

We generally avoid boolean properties which default to true as it's problematic:

For a Boolean property to be configurable from markup, it must default to false. If it defaults to true, you cannot set it to false from markup, since the presence of the attribute, with or without a value, equates to true. This is the standard behavior for attributes in the web platform.

If we want to make matchExact the default behavior, then IMO we could instead have a property called noExactMatch or something else so that its default would be false.

[sissbruecker]

If we want to make matchExact the default behavior, then IMO we could instead have a property called noExactMatch or something else so that its default would be false.

Changed the property to matchNested so that it indicates that it specifically matches nested paths / routes. With that the property is now opt-in, rather than opt-out.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[vaadin-bot]

This ticket/PR has been released with Vaadin 24.5.0.alpha12 and is also targeting the upcoming stable 24.5.0 version.