For AI agents: the complete documentation index is available at https://rickyshin93.github.io/tao-ui/llms.txt, the full documentation bundle is available at https://rickyshin93.github.io/tao-ui/llms-full.txt, and this page is available as Markdown at https://rickyshin93.github.io/tao-ui/components/tour.md.
v0.0.57
  • English
  • Tour

    Feedback@rockshin/tao-ui

    Guided steps with target positioning, spotlight masks, custom actions and keyboard navigation.

    Each example can be copied and run independently. Use the device control on framed previews to switch between desktop and phone widths.

    Masked centered steps and steps with disabledInteraction contain keyboard focus. Steps that allow target interaction are nonmodal and keep the target focusable. Closing restores focus to the launch control.

    Examples

    Guide users between targets

    Targets are read from refs when the tour opens. Next moves to the following target.

    390 × 640
    TSX

    Controlled current step

    Keep current and open in state. Reset the step before starting the tour again.

    390 × 640
    TSX

    A centered introduction

    Omit target for an introduction centered in the viewport.

    390 × 640
    TSX

    Primary emphasis and a cover

    type="primary" changes the panel emphasis. A step can include a cover image or other React content.

    390 × 640
    TSX

    Mask, gap and interaction

    gap controls the highlighted rectangle. disabledInteraction prevents clicks on the highlighted target.

    390 × 640
    TSX

    Custom indicators and actions

    Keep the default actions and add a Skip action. Per-step button props customize labels and handlers.

    390 × 640
    TSX

    Non-modal guidance

    mask:false leaves the page unobscured. keyboard:false disables step navigation and Escape handling; Done still closes this example.

    390 × 640
    TSX

    Guide a narrow layout

    The panel flips and shifts around its target to stay inside the phone viewport.

    390 × 640
    TSX

    API

    Tour

    PropertyDescriptionTypeDefault Value