Kombase
Components

Tour

A flexible step-by-step product tour component to guide users through your application

Components Layout

Examples

Control

API

Tour

The root provider component that coordinates the entire tour state.

Prop

Type

TourPortal

Portals the tour steps and spotlights into the body or custom container.

Prop

Type

TourSpotlight

Renders a backdrop overlay with a clipped spotlight shape to highlight the target element of the active step.

Prop

Type

TourSpotlightRing

Renders an animated border ring around the spotlight-highlighted target element to draw attention.

Prop

Type

TourStep

The popover container that holds the content of the current step, positioned relative to the target element.

Prop

Type

TourClose

A button component to close/dismiss the tour.

Prop

Type

TourHeader

A layout container for the step header. Inherits from HTML div element.

TourTitle

A text component for the step's title. Inherits from HTML div element.

TourDescription

A text component for the step's description. Inherits from HTML div element.

TourFooter

A layout container for the step footer. Inherits from HTML div element.

TourStepCounter

Renders the current step counter (e.g. Step 1 of 5).

Prop

Type

TourPrev

A button component to navigate to the previous step. Inherits from HTML button element.

TourNext

A button component to navigate to the next step. Inherits from HTML button element.

TourSkip

A button component to skip the remaining steps and exit the tour. Inherits from HTML button element.

TourArrow

An optional arrow pointer attached to the step popover card pointing towards the target element.

Prop

Type

How is this guide?

On this page