Skip to content

Function: createPlayRouterProvider()

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

function createPlayRouterProvider<TRouter, TActorBase>(BridgeCtor): <TActor>(props) => any;

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

Builds a PlayRouterProvider for one Solid bridge class.

Type Parameters

Type ParameterDefault type
TRouter-
TActorBase extends RoutableActorRoutableActor

Parameters

ParameterTypeDescription
BridgeCtorPlayRouterBridgeConstructor<TRouter, TActorBase>The bridge class, built as new BridgeCtor(router, actor, routeMap, options).

Returns

A PlayRouterProvider component, generic over the actor type, so the renderer callback receives the same concrete actor type as the prop.

<TActor>(props) => any

Example

export const PlayRouterProvider = createPlayRouterProvider(TanStackSolidRouterBridge);