Function: useDriver()

function useDriver(config?, options?): UseDriverReturn;

Creates a driver bound to the current component: the plugin defaults are merged under config, a reactive config is re-applied on change, the driver is provided to the component's subtree (so a <DriverTour /> there renders it), and the tour is destroyed when the component unmounts.

const { drive, isActive } = useDriver({ steps })

Parameters

Parameter	Type
config	MaybeRefOrGetter<Config>
options	UseDriverOptions

Returns

UseDriverReturn