Skip to content

Function: createDriverPlugin() ​

ts
function createDriverPlugin(options?): Plugin<[DriverPluginOptions?]>;

Installs driver-vue: provides the config defaults and a lazily created shared driver (used by <DriverTour> without a driver prop and by useDriver() with { shared: true }), and optionally registers the components globally.

ts
app.use(DriverPlugin, { defaults: { animate: true }, components: true })

Parameters ​

ParameterType
optionsDriverPluginOptions

Returns ​

Plugin<[DriverPluginOptions?]>

Released under the MIT License.