Function createRoute

createRoute<Params extends Dict = {}, Data = void, Context = any>(
options?: RouteOptions<Params, Data, Context>,
): Route<null, Params, Data, Context>
Creates a route that is rendered in an Outlet of a Router.
Type Parameters
- Params extends Dict = {}
  Route params.
- Data = void
  Data loaded by a route.
- Context = any
  A router context.
Parameters
- Optionaloptions: RouteOptions<Params, Data, Context>
  Route options.
Returns Route<null, Params, Data, Context>
Example
```
const fooRoute = createRoute({ pathname: '/foo' });
```
createRoute<
    ParentRoute extends Route<any, any, any, any>,
    Params extends Dict = {},
    Data = void,
>(
    parentRoute: ParentRoute,
    options?: RouteOptions<Params, Data, InferContext<ParentRoute>>,
): Route<ParentRoute, Params, Data, InferContext<ParentRoute>>
Creates a route that is rendered in an Outlet of a parent route.
Type Parameters
- ParentRoute extends Route<any, any, any, any>
  A parent route.
- Params extends Dict = {}
  Route params.
- Data = void
  Data loaded by a route.
Parameters
- parentRoute: ParentRoute
  A parent route.
- Optionaloptions: RouteOptions<Params, Data, InferContext<ParentRoute>>
  Route options.
Returns Route<ParentRoute, Params, Data, InferContext<ParentRoute>>
Example
```
const fooRoute = createRoute({ pathname: '/foo' });
const barRoute = createRoute(fooRoute, { pathname: '/bar' });
```
createRoute<Params extends Dict = {}>(
pathname: string,
component?: ComponentType,
): Route<null, Params, void>
Creates a route that is rendered in an Outlet of a Router.
Type Parameters
- Params extends Dict = {}
  Route params.
Parameters
- pathname: string
  A pathname pattern.
- Optionalcomponent: ComponentType
  A component that is rendered by a route.
Returns Route<null, Params, void>
Example
```
function Foo() {
  return 'Hello';
}

const fooRoute = createRoute('/foo', Foo);
```
createRoute<
    ParentRoute extends Route<any, any, any, any>,
    Params extends Dict = {},
>(
    parentRoute: ParentRoute,
    pathname: string,
    component?: ComponentType,
): Route<ParentRoute, Params, void, InferContext<ParentRoute>>
Creates a route that is rendered in an Outlet of a parent route.
Type Parameters
- ParentRoute extends Route<any, any, any, any>
  A parent route.
- Params extends Dict = {}
  Route params.
Parameters
- parentRoute: ParentRoute
  A parent route.
- pathname: string
  A pathname pattern.
- Optionalcomponent: ComponentType
  A component that is rendered by a route.
Returns Route<ParentRoute, Params, void, InferContext<ParentRoute>>
Example
```
function Bar() {
  return 'Hello';
}

const fooRoute = createRoute('/foo');
const barRoute = createRoute(fooRoute, '/bar', Bar);
```

Function createRoute

Type Parameters

Parameters

Returns Route<null, Params, Data, Context>

Example

Type Parameters

Parameters

Returns Route<ParentRoute, Params, Data, InferContext<ParentRoute>>

Example

Type Parameters

Parameters

Returns Route<null, Params, void>

Example

Type Parameters

Parameters

Returns Route<ParentRoute, Params, void, InferContext<ParentRoute>>

Example

Settings