Overlays
v1.0.0Added in 1.0.0
A product tour that dims the page around the real UI, explains each step in a card and docks at the bottom on phones, plus hotspots.
Start the tour with its button or the shortcut and the page dims around the first target: a rounded spotlight hugs the element and a card beside it explains the step. Next, Back and Skip sit in the card; the progress dots can be clicked to jump. Each step scrolls its target into view first, then the spotlight glides there on a spring and the card fades in beside it; steps without a target show a centered card. Keys: Right arrow or Enter goes next, Left goes back, Escape skips (announced), Tab stays inside the card, and focus returns to where it was when the tour ends. Interactive steps let clicks and typing reach the highlighted element, and advanceOn click moves on when you press the real button. On a phone the card docks at the bottom above the safe area and the keyboard, its target is scrolled into the top half, and a swipe left or right pages the steps. With persistKey a finished or skipped tour is remembered and autoStart leaves it alone. TourHotspot is a pulsing dot on a new feature: tap or click it for a hint (a bottom card on phones); once seen it stays away. Reduced motion makes the spotlight jump and the cards fade.
npx wingo-ui@latest add tourPro item: the CLI needs a Pro account. See plans
Welcome tour
Not started
Northwind Labs · today, 4:40 PM
Tech Solutions Inc.
12-3456740 · New York
Keystone Builders
56-7812330 · Denver
Greenleaf Pharmacy
45-6781280 · Portland
Dental Art Clinic
78-1234500 · Miami
dim 0.55 · pad 8 · r 14 · progress dots · md / lg · neutral · phones docked · scroll smooth