Type Alias RouteItem<Attrs, Comp, RouteArgs>

Type Declaration

• path: `/${string}`

  The path for your route.

  This might be a specific URL path (e.g.,/myPage), or it might contain a variable used by a resolver (e.g., /myPage/:id).

  See

  https://docs.flarum.org/extend/frontend-pages.html#route-resolvers-advanced

• {
      component: NewComponent<Comp> | AsyncNewComponent<Comp>;
      resolverClass?: new (
          component: NewComponent<Comp> | AsyncNewComponent<Comp>,
          routeName: string,
      ) => DefaultResolver<Attrs, Comp, RouteArgs>;
  }

  • component: NewComponent<Comp> | AsyncNewComponent<Comp>

    The component to render when this route matches.

  • OptionalresolverClass?: new (
        component: NewComponent<Comp> | AsyncNewComponent<Comp>,
        routeName: string,
    ) => DefaultResolver<Attrs, Comp, RouteArgs>

    A custom resolver class.

    This should be the class itself, and not an instance of the class.

• { resolver: RouteResolver<Attrs, Comp, RouteArgs> }

  • resolver: RouteResolver<Attrs, Comp, RouteArgs>

    An instance of a route resolver.