Interface: PlayRouterProviderProps<TActor>
API / @xmachines/play-solid-router / PlayRouterProviderProps
Defined in: packages/play-solid-router/src/play-router-provider.tsx:50
The props of the PlayRouterProvider of Solid Router.
router holds the three results of the Solid Router hooks that drive the work in
both directions. Take them from useNavigate(), from useLocation(), and from
useParams() in the parent component. Call each hook inside a router context.
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
TActor extends PlayActor | PlayActor |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
actor | TActor | The actor to keep in step with the router. | PlayRouterProviderBaseProps.actor | packages/play-solid-router/src/create-play-router-provider.tsx:38 |
renderer | (actor, router) => any | The renderer callback receives the same concrete actor type as the prop. | PlayRouterProviderBaseProps.renderer | packages/play-solid-router/src/create-play-router-provider.tsx:44 |
routeMap | RouteMap | The route map of both directions, for the lookup between a state ID and a URL path. | PlayRouterProviderBaseProps.routeMap | packages/play-solid-router/src/create-play-router-provider.tsx:42 |
router | SolidRouterHooks | The router that the bridge keeps in step with the actor. | PlayRouterProviderBaseProps.router | packages/play-solid-router/src/create-play-router-provider.tsx:40 |