Skip to content

Variable: PlayRouterProvider

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

const PlayRouterProvider: <TActor>(props) => any;

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

Connects a PlayerActor to TanStack Solid Router. It keeps the actor state and the browser URL in step, in both directions.

The component creates the bridge one time for each of its instances, during its own evaluation. It disconnects the bridge in onCleanup, when Solid disposes of the component. React is different: the stability of a prop is no concern here, because the props accessor of Solid is reactive already.

Type Parameters

Type Parameter
TActor extends PlayActor

Parameters

ParameterType
propsPlayRouterProviderBaseProps<TanStackRouterLike, TActor>

Returns

any