Skip to content

Interface: PlayRouterProviderProps<TActor>

API / @xmachines/play-tanstack-solid-router / PlayRouterProviderProps

Defined in: play-tanstack-solid-router/src/play-router-provider.tsx:30

The props of the PlayRouterProvider of TanStack Solid Router.

router is the TanStack Router instance that createRouter returns.

Extends

Type Parameters

Type ParameterDefault type
TActor extends PlayActorPlayActor

Properties

PropertyTypeDescriptionInherited fromDefined in
actorTActorThe actor to keep in step with the router.PlayRouterProviderBaseProps.actorplay-tanstack-solid-router/src/create-play-router-provider.tsx:47
renderer(actor, router) => anyThe renderer callback receives the same concrete actor type as the prop.PlayRouterProviderBaseProps.rendererplay-tanstack-solid-router/src/create-play-router-provider.tsx:53
routeMapRouteMapThe route map of both directions, for the lookup between a state ID and a URL path.PlayRouterProviderBaseProps.routeMapplay-tanstack-solid-router/src/create-play-router-provider.tsx:51
routerTanStackRouterLikeThe router that the bridge keeps in step with the actor.PlayRouterProviderBaseProps.routerplay-tanstack-solid-router/src/create-play-router-provider.tsx:49