Interface: PlayRouterProviderProps<TActor>
API / @xmachines/play-solid-router / PlayRouterProviderProps
Defined in: packages/play-solid-router/src/play-router-provider.tsx:50
Props for the Solid Router PlayRouterProvider.
router bundles the three Solid Router hook results that drive bidirectional
sync. Obtain these from useNavigate(), useLocation(), and useParams()
in the parent component (they must be called 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 sync with the router. | PlayRouterProviderBaseProps.actor | packages/play-solid-router/src/create-play-router-provider.tsx:39 |
renderer | (actor, router) => any | Renderer callback receives the same concrete actor type that was passed in. | PlayRouterProviderBaseProps.renderer | packages/play-solid-router/src/create-play-router-provider.tsx:45 |
routeMap | RouteMap | Bidirectional route map for state ID ↔ URL path lookups. | PlayRouterProviderBaseProps.routeMap | packages/play-solid-router/src/create-play-router-provider.tsx:43 |
router | SolidRouterHooks | The router the bridge synchronizes with. | PlayRouterProviderBaseProps.router | packages/play-solid-router/src/create-play-router-provider.tsx:41 |