Package com.vaadin.flow.router

Annotation Interface RouteParent

@Target(TYPE) @Retention(RUNTIME) @Documented public @interface RouteParent
Declares the conceptual parent route of a @Route-annotated navigation target.

This annotation expresses a route-hierarchy relationship: "the conceptual parent of this route is that route". It is consumed by navigation components (e.g. breadcrumbs, back-navigation helpers, sitemap renderers) that need to walk ancestor routes for a given view. It does not affect how the view is rendered — visual nesting is configured via Route.layout() and ParentLayout.

When this annotation is present on a route class, hierarchy-walking consumers use value() as the parent. When it is absent, those consumers typically fall back to URL-prefix walking. The parent class should itself be annotated with @Route; if it is not, consumers fall back to URL-prefix walking for that step.

See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<? extends Component>
    value
    The view class that is the conceptual parent of the annotated @Route class.

  • Element Details

    • value

      Class<? extends Component> value
      The view class that is the conceptual parent of the annotated @Route class.
      Returns:
      the conceptual parent route class