Routes
DashboardRouteDefinition
Defines a custom route for the dashboard with optional navigation menu integration.
interface DashboardRouteDefinition {
component: (route: AnyRoute) => React.ReactNode;
path: string;
navMenuItem?: Partial<NavMenuItem> & { sectionId: string };
loader?: RouteOptions['loader'];
validateSearch?: RouteOptions['validateSearch'];
authenticated?: boolean;
}
component
(route: AnyRoute) => React.ReactNodeThe React component that will be rendered for this route.
path
stringThe URL path for this route, e.g. '/my-custom-page'.
navMenuItem
Partial<NavMenuItem> & { sectionId: string }Optional navigation menu item configuration to add this route to the nav menu on the left side of the dashboard.
The sectionId specifies which nav menu section (e.g. "catalog", "customers")
this item should appear in. It can also point to custom nav menu sections that
have been defined using the navSections extension property.
loader
RouteOptions['loader']Optional loader function to fetch data before the route renders. The value is a Tanstack Router loader function
validateSearch
RouteOptions['validateSearch']Optional search parameter validation function. The value is a Tanstack Router validateSearch function
authenticated
booleantrueDefine if the route should be under the authentication context, i.e have the authenticated route as a parent.