Class: VueRouterBridge

API / @xmachines/play-vue-router / VueRouterBridge

Defined in: play-vue-router/src/vue-router-bridge.ts:35

@xmachines/play-vue-router - Vue Router 4.x adapter for XMachines Play

It integrates Vue Router with an XMachines state machine, in both directions.

Extends

RouterBridgeBase

Constructors

Constructor

new VueRouterBridge(
   vueRouter,
   actor,
   routeMap): VueRouterBridge;

Defined in: play-vue-router/src/vue-router-bridge.ts:44

Parameters

Parameter	Type
`vueRouter`	`RouterClassic`
`actor`	`RoutableActor`
`routeMap`	`RouteMap`

Returns

VueRouterBridge

Overrides

RouterBridgeBase.constructor

Methods

connect()

connect(): void;

Defined in: play-router/src/router-bridge-base.ts:158

Connects the router bridge to the Actor.

The method installs the TC39 Signal watcher of the direction from the actor to the router. It then starts the watch of the router changes, which each framework does in its own way.

The order of these steps is part of the contract of the bridge:

The constructor seeds lastSyncedPath from actor.currentRoute
The method installs the actor watcher before the router subscriptions of the adapter
The first synchronization then separates a deep link from a restore, with actor.initialRoute

An adapter that needs a different behavior of the first synchronization overrides getInitialRouterPath(). It does not change the order of the steps of connect().