Package com.vaadin.flow.router

Annotation Interface RoutePrefix

@Retention(RUNTIME) @Target(TYPE) @Inherited @Documented public @interface RoutePrefix
Defines the route prefix that a Parent layout adds to a route when used in the active view chain.
Since:
1.0

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Sets the route prefix defined for class.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    absolute
    Have the route chain break on defined class and not take into notice any more parent layout route prefixes.

  • Element Details

    • value

      String value
      Sets the route prefix defined for class.

      This value accepts also parameter template segments which can be defined using following format: :parameterName[?|*][(regex)].

      Returns:
      route prefix to add

    • absolute

      boolean absolute
      Have the route chain break on defined class and not take into notice any more parent layout route prefixes.
      Returns:
      route up to here should be absolute
      Default:
      false