Interface: PlayRouterProviderProps<TActor>
API / @xmachines/play-react-router / PlayRouterProviderProps
Defined in: play-react-router/src/play-router-provider.tsx:9
Type Parameters
| Type Parameter | Default type |
|---|---|
TActor extends PlayActor | PlayActor |
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
actor | TActor | The actor to sync with React Router. Must be a stable reference — pass the same actor instance across renders. Creating the actor inline or re-creating it on every render will cause the bridge to disconnect and reconnect each time. | play-react-router/src/play-router-provider.tsx:15 |
renderer | (actor, router) => ReactNode | Renderer callback receives the same concrete actor type that was passed in. | play-react-router/src/play-router-provider.tsx:32 |
routeMap | RouteMap | Bidirectional route map for state ID ↔ URL path lookups. Must be a stable reference. The bridge is rebuilt whenever routeMap changes identity. If constructed inline (e.g. createRouteMapFromTree(routeTree) in JSX), a new object is produced on every render and the bridge reconnects every render. Memoize with useMemo: const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]); | play-react-router/src/play-router-provider.tsx:30 |
router | Router | The React Router instance returned by createBrowserRouter. | play-react-router/src/play-router-provider.tsx:17 |