@tour-kit/coreProviders
TourKitProvider
TourKitProvider: wrap your app to enable global tour management, shared configuration, and multi-tour coordination
domidex01Published
Global provider that manages multiple tours across your application.
Usage
import { TourKitProvider } from '@tour-kit/core';
function App() {
return (
<TourKitProvider>
<YourApp />
</TourKitProvider>
);
}Props
Prop
Type
With Global Config
<TourKitProvider
defaultConfig={{
keyboard: true,
spotlight: {
padding: 8,
},
}}
persistence={{
strategy: 'localStorage',
key: 'tour-kit-state',
}}
>
<App />
</TourKitProvider>Multiple Tours
When using TourKitProvider, you can define multiple tours:
<TourKitProvider>
<TourProvider tour={onboardingTour}>
<TourProvider tour={featureTour}>
<App />
</TourProvider>
</TourProvider>
</TourKitProvider>Related
<TourProvider>— wrap individual tours inside this global provider.useTourKitContext— read the resolved global config from descendants.useDirection— convenience hook for the resolveddirvalue.- Configuration types — every field that goes into
defaultConfig. - Quick start — see this provider wired into a working app.
Ship onboarding, not config.
npm i @tour-kit/core is MIT and free. The Pro packages work unlicensed too — a one-time $99 license removes the production watermark when you ship.
MIT-licensed — no signup, no credit card. Pay once, only when you ship.