Skip to content

Interface: PlayRouterProviderBaseProps<TRouter, TActor>

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

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

The props that every Solid PlayRouterProvider of the factory shares.

An adapter package re-exports a concrete alias, with TRouter bound to the type of its router. For example, TanStackRouterInstance in @xmachines/play-tanstack-solid-router.

Extended by

Type Parameters

Type ParameterDefault type
TRouter-
TActor extends PlayActorPlayActor

Properties

PropertyTypeDescriptionDefined in
actorTActorThe actor to keep in step with the router.play-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.play-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.play-tanstack-solid-router/src/create-play-router-provider.tsx:51
routerTRouterThe router that the bridge keeps in step with the actor.play-tanstack-solid-router/src/create-play-router-provider.tsx:49