Skip to content
UI Kit
Accent color

Product tour

A guided walk through a product, in six layouts: steps with a changing screen, a scroll story, hotspots on a screen, a carousel, film chapters and an in-app tour with spotlight.

6 variants
Switch category

Product tour

Guided steps

Five steps that advance on their own, a line shows the time, the screen changes with each.

Scroll story

Text scrolls past a screen that stays in place and changes with the section in view.

Hotspots on a screen

Pulsing markers on one screen open short explanations, listed again below for phones.

Video chapters

A film with chapter marks on the timeline and a chapter list that jumps to each part.

In-app tour with spotlight

The screen dims around one area at a time, a card explains it with back and next.

Details

What Product tour brings along, read from the registry and the source.

Variants
6
Version
1.0.2 · since 1.0.0
File
components/ui/product-tour.tsx
Brings along
utilskiticonsection
npm packages
None
Languages
English and German, 13 texts of its own
Studio
Adjust in code
In collections
SaaS landing page

Props

The ProductTourProps interface from components/ui/product-tour.tsx, with the comments from the code.

  • variantoptional
    ProductTourVariant

    stepsscroll-storyhotspotscarouselvideo-chapterscoachmarks

  • eyebrowoptional
    React.ReactNode
  • titleoptional
    React.ReactNode
  • descriptionoptional
    React.ReactNode
  • actionsoptional
    React.ReactNode
  • stepsrequired
    TourStep[]
  • mediaoptional
    React.ReactNode

    hotspots, coachmarks, video-chapters: the one screen or film still all steps refer to

  • durationoptional
    number

    video-chapters: length of the film in seconds

Built-in texts

Product tour writes these texts itself. The language follows the KitProvider, the labels prop replaces single ones.

Show all 13 texts
stepEnglish StepGerman Schritt
ofEnglish ofGerman von
previousEnglish PreviousGerman Zurück
nextEnglish NextGerman Weiter
doneEnglish DoneGerman Fertig
restartEnglish Start againGerman Von vorn
tourEnglish Product tourGerman Produkttour
playEnglish PlayGerman Abspielen
pauseEnglish PauseGerman Pause
chaptersEnglish ChaptersGerman Kapitel
closeEnglish CloseGerman Schließen
slideEnglish SlideGerman Folie
showEnglish ShowGerman Zeigen

Accessibility

Read from the source of the component.

  • Product tour handles the keys Escape, Arrow up, Arrow down, Arrow left and Arrow right itself.
  • Sets aria-controls, aria-current, aria-expanded, aria-label, aria-labelledby, aria-live, aria-orientation, aria-pressed, aria-roledescription, aria-selected and aria-valuetext, so screen readers announce purpose and state.
  • Uses the roles dialog, group, region, tab, tablist and tabpanel.
  • Announces changes through a live region without moving focus.
  • Adds text for screen readers where icons and graphics stand alone.
  • Shows a visible focus ring when used with the keyboard.
  • The server renders the starting state in full, JavaScript only adds the interaction.

Motion

  • Rises in briefly the first time it comes into view (kit-rise, useInView).
  • Moves with the scroll, its progress follows the position on the page.
  • Brings animations of its own, calmly timed and without wobble.
  • With reduced motion (prefers-reduced-motion) it stays still. 12 places in the code switch motion off then.

Frequent questions

How do I install Product tour?

With aiw add @ai-website/product-tour. The command puts components/ui/product-tour.tsx into your project, the code is yours from then on. It brings along icon and section. It needs no further npm packages.

Which variants does Product tour have?

6 variants, Guided steps, Scroll story, Hotspots on a screen, Feature carousel, Video chapters and In-app tour with spotlight. You pick one with the variant prop, for example variant="scroll-story".

Can I translate the texts of Product tour?

Yes. Product tour carries 13 texts of its own in English and German, such as “Step”, “of” and “Previous”. The language follows the KitProvider, single texts change through the labels prop.

Can an AI assistant build with Product tour?

Yes. Through the MCP server of the aiw CLI, Claude, Cursor, GitHub Copilot, Windsurf, Codex and Gemini find Product tour with aiw_components and install it with aiw_add @ai-website/product-tour. Name the variant in your prompt, for example variant="steps", and the assistant writes your content straight into the props.

Often searched

Jump to

Copied to the clipboard