GlowTour.js documentation
GlowTour.js is an open-source, MIT-licensed product tour library for JavaScript and TypeScript. It builds onboarding tours, guided tours and feature highlights in React, Vue, Angular, Solid and vanilla JavaScript, with one core engine and a native adapter for each framework.
Get started
Section titled “Get started”- Getting Started - Install GlowTour.js and build your first tour in minutes.
Choose your framework
Section titled “Choose your framework”Select your framework to learn framework-specific setup, APIs, and patterns:
- React - React components and hooks
- Vue - Vue components and composition API
- Solid - Solid components and signals
- Angular - Angular components and dependency injection
- Vanilla - Custom elements and plain JavaScript
Learn the concepts
Section titled “Learn the concepts”Deepen your understanding with our guides:
- Theming - Customize tour appearance
- Accessibility - Build inclusive tours
- Positioning - Control popover placement
- Programmatic control - Control tours with code
- Resuming a tour - Persist the position and restart on a given step
- Monitoring - Send tour events to your analytics
- JSON config - Build tours from a plain, serializable object
- SSR - Server-side rendering support
API Reference
Section titled “API Reference”Look up complete API documentation:
- Builder - Workflow/step builder API and every option’s default
- Tour - Tour controller API (
createGlowTour,tour.start,tour.state, …) - React - React adapter API
- Vue - Vue adapter API
- Solid - Solid adapter API
- Angular - Angular adapter API
- Vanilla - Vanilla adapter API
Compatibility
Section titled “Compatibility”Check framework and browser support for all adapters.