Skip to content

Interface: PlayRouterProviderBaseProps<TRouter, TActor>

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

Defined in: packages/play-solid-router/src/create-play-router-provider.tsx:36

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, SolidRouterHooks in @xmachines/play-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.packages/play-solid-router/src/create-play-router-provider.tsx:38
renderer(actor, router) => anyThe renderer callback receives the same concrete actor type as the prop.packages/play-solid-router/src/create-play-router-provider.tsx:44
routeMapRouteMapThe route map of both directions, for the lookup between a state ID and a URL path.packages/play-solid-router/src/create-play-router-provider.tsx:42
routerTRouterThe router that the bridge keeps in step with the actor.packages/play-solid-router/src/create-play-router-provider.tsx:40