Elements

Components

Tour

Tour, dressed in the paper-and-ink system: a dimmed page where the spotlight alone keeps the focus halo, and the anchored card rides the shared popup vessel. The parts — Root, Backdrop, Spotlight, Positioner, Content, Arrow, ArrowTip, Title, Description, ProgressText, Control, Actions, ActionTrigger, CloseTrigger, plus useTour.

#Basic usage

tour/basic Vue React
Anchor element

#Props

#ActionTrigger

PropTypeDefaultDescription
actionStepAction—

#Actions

A styled part — no props of its own; it takes the anatomy's shared styling.

#ArrowTip

A styled part — no props of its own; it takes the anatomy's shared styling.

#Arrow

A styled part — no props of its own; it takes the anatomy's shared styling.

#Backdrop

A styled part — no props of its own; it takes the anatomy's shared styling.

#CloseTrigger

A styled part — no props of its own; it takes the anatomy's shared styling.

#Content

A styled part — no props of its own; it takes the anatomy's shared styling.

#Control

A styled part — no props of its own; it takes the anatomy's shared styling.

#Description

A styled part — no props of its own; it takes the anatomy's shared styling.

#Positioner

A styled part — no props of its own; it takes the anatomy's shared styling.

#ProgressText

A styled part — no props of its own; it takes the anatomy's shared styling.

#Root

PropTypeDefaultDescription
tourUnwrapRef<UseTourReturn>—

#Spotlight

A styled part — no props of its own; it takes the anatomy's shared styling.

#Title

A styled part — no props of its own; it takes the anatomy's shared styling.