Function: connectRouter()

API / @xmachines/play-dom-router / connectRouter

function connectRouter(options): () => void;

Defined in: play-dom-router/src/connect-router.ts:52

Connects the vanilla router to an actor. This is a pure browser integration.

The function returns a cleanup function. That function calls bridge.disconnect() to stop the synchronization.

Parameters

Parameter	Type
options	ConnectRouterOptions

Returns

() => void

Example

import {
  createBrowserHistory,
  createRouter,
  connectRouter,
  createRouteMap,
} from "@xmachines/play-dom-router";
import { extractMachineRoutes } from "@xmachines/play-router";

const routeTree = extractMachineRoutes(machine);
const routeMap = createRouteMap(machine);
const history = createBrowserHistory({ window });
const router = createRouter({ routeTree, history });
const disconnect = connectRouter({ actor, router, routeMap });
// Later:
disconnect();