Function: createPlayRouterProvider()

API / @xmachines/play-react-router / createPlayRouterProvider

function createPlayRouterProvider<TRouter, TActorBase>(
  BridgeCtor,
): <TActor>(__namedParameters) => Element;

Defined in: play-react-router/src/create-play-router-provider.tsx:52

Builds a PlayRouterProvider for one React bridge class.

Type Parameters

Type Parameter	Default type
TRouter	-
TActorBase extends RoutableActor	RoutableActor

Parameters

Parameter	Type	Description
BridgeCtor	PlayRouterBridgeConstructor<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>(__namedParameters) => Element

Example

export const PlayRouterProvider = createPlayRouterProvider(ReactRouterBridge);