Introduction
Guideway adds in-app product tours, coachmarks, and spotlight onboarding to React Native and Expo apps. It draws an animated spotlight around any view, shows a tooltip that stays on-screen, and walks people through your UI one step at a time.
It is hook-first (no higher-order components, no wrapper views that shift your layout), tours are plain data, and it is written in TypeScript.
Why Guideway
Section titled “Why Guideway”The established libraries - react-native-copilot, rn-tourguide, react-native-spotlight-tour - were built for the old architecture and broke when Fabric (the New Architecture) became the default. Guideway started on Fabric, and is verified on iOS and Android.
What you get
Section titled “What you get”- Animated spotlight - a Reanimated cutout glides between targets and reshapes (rectangle, rounded, circle, pill), entirely on the UI thread.
- Smart tooltips - flip above or below, shift to stay on-screen, and clear the notch and home indicator. Safe-area aware, per-step placement.
- Auto-scroll - off-screen targets scroll into view before they are highlighted, in a ScrollView or a virtualized FlatList row.
- Theming - built-in light and dark, a
colorSchemeprop, tokens for colors, radius, and labels, or replace the tooltip entirely. - Interactive spotlight - let people tap through the hole to use the real element; the keyboard dismisses on every step.
- Show-once -
showOncetours fire on first launch and never nag again, through a pluggable storage adapter.
Next steps
Section titled “Next steps”- Installation - install and configure peer dependencies
- Quick start - a working tour in a few lines
- API reference - every prop, hook, and type
Guideway is MIT licensed and open source on GitHub.