Package com.vaadin.flow.router

Annotation Interface Layout

@Retention(RUNTIME) @Target(TYPE) @Inherited @Documented public @interface Layout
Defines a RouterLayout as eligible for use as automatic layout for Flow and Hilla views.

Eligibility is checked by the value as path match.

Opting out from automatic layouting for a Route or RouteAlias can be done with the Route.autoLayout() or RouteAlias.autoLayout() method.
Since:
24.5
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    Sets the layout identifier value to link client view to server layout component.

  • Element Details

    • value

      String value
      Sets the layout identifier value to link client view to server layout component. Default is "/".

      Layout is linked by path so that anything matching the whole start match the rest. so "" or "/" matches all paths, but "/view" matches all paths starting with view path part so "/view/**".

      Note! context path is not taken into account.

      Returns:
      the set layout identifier value
      Default:
      "/"