Type alias RouteItem<Attrs, Comp, RouteArgs>

RouteItem<Attrs, Comp, RouteArgs>: {
    path: `/${string}`;
} & ({
    component: NewComponent<Comp> | AsyncNewComponent<Comp>;
    resolverClass?: (new (component, routeName) => DefaultResolver<Attrs, Comp, RouteArgs>);
} | {
    resolver: RouteResolver<Attrs, Comp, RouteArgs>;
})

A valid route definition.

Type Parameters

Attrs extends ComponentAttrs
Comp extends Component<Attrs & {
routeName: string;
}>
RouteArgs extends Record<string, unknown> = {}

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

Generated using TypeDoc v0.24.8