Interface NavRenderContext

public interface NavRenderContext

Everything a NavRenderer needs to build or update its content for the current nav state.

Method Summary

Modifier and Type	Method	Description
String	currentPath()	The path of the currently active navigation, with any leading / stripped.
NavGrouper	navGrouper()	The current nav grouping strategy; call NavGrouper.nodeFor(MenuEntry) for each entry from com.vaadin.flow.server.menu.MenuConfiguration#getMenuEntries() that also passes navItemFilter().
Predicate<com.vaadin.flow.server.menu.MenuEntry>	navItemFilter()	The configured AppNavLayout.setNavItemFilter(Predicate) predicate (default: every entry included) — true if a given MenuEntry should appear in the nav tree at all, false to exclude it.
BiPredicate<String,String>	navPathMatcher()	The configured AppNavLayout.setNavPathMatcher(BiPredicate) predicate for active-item matching (default String::equals).
NavSlots	slots()	The full set of named locations available to render into.

Method Details

navGrouper

NavGrouper navGrouper()

The current nav grouping strategy; call NavGrouper.nodeFor(MenuEntry) for each entry from com.vaadin.flow.server.menu.MenuConfiguration#getMenuEntries() that also passes navItemFilter().

currentPath

String currentPath()

The path of the currently active navigation, with any leading / stripped.

slots

NavSlots slots()

The full set of named locations available to render into.

navPathMatcher

BiPredicate<String,String> navPathMatcher()

The configured AppNavLayout.setNavPathMatcher(BiPredicate) predicate for active-item matching (default String::equals). A NavRenderer that highlights an active item by comparing paths itself — rather than delegating to something that already respects it, like Vaadin's own router matching — should test against this rather than hardcoding its own comparison, or setNavPathMatcher silently won't affect it.

navItemFilter

Predicate<com.vaadin.flow.server.menu.MenuEntry> navItemFilter()

The configured AppNavLayout.setNavItemFilter(Predicate) predicate (default: every entry included) — true if a given MenuEntry should appear in the nav tree at all, false to exclude it. Filter MenuConfiguration.getMenuEntries() against this before ever calling navGrouper()'s own nodeFor on an entry: a group node only ever exists because a real entry underneath it was processed, so an excluded entry that still reaches nodeFor would keep an otherwise-empty group alive.