Skip to content

Variable: driver ​

ts
const driver: (options) => Driver = createDriver;

driver.js-compatible alias of createDriver.

Create a driver: the tour engine. It owns the config, the reactive state (driver.state) and every behaviour of driver.js; rendering is left to <DriverTour> (or your own components reading driver.state).

The instance is inert on the server: drive() and highlight() do nothing.

Parameters ​

ParameterType
optionsConfig

Returns ​

Driver

Released under the MIT License.