What’s New

Latest updates to NFSFU234TourGuide. For the full commit-level history, see the Changelog.

📦 The package moved to @nfsfu234/tour-guide

As part of NFSFU234 Open Source Day, this library now publishes under the @nfsfu234 scope, alongside @nfsfu234/form-validation and @nfsfu234/shotsweep.

- npm install nfsfu234-tour-guide
+ npm install @nfsfu234/tour-guide

- import { Tour } from 'nfsfu234-tour-guide'
+ import { Tour } from '@nfsfu234/tour-guide'

Nothing about the API changed — this is a rename only. If you’re upgrading, see the Migration Guide for the full checklist.

⚙️ Project-wide config with defineConfig() + TourProvider

Running more than one tour in your app? You can now set shared defaults once — theme, accentColor, buttonLabels, showBranding — instead of repeating them on every <Tour>.

// tour.config.ts
import { defineConfig } from '@nfsfu234/tour-guide';
 
export default defineConfig({
  theme: 'dark',
  accentColor: '#10b981',
  showBranding: false,
});

// app/layout.tsx
import { TourProvider } from '@nfsfu234/tour-guide';
import tourConfig from '../tour.config';
 
export default function RootLayout({ children }) {
  return <TourProvider config={tourConfig}>{children}</TourProvider>;
}

Any prop passed directly to a specific <Tour> still overrides the shared config — nothing gets locked in. See Project-Wide Config for the full reference.

Upgrading?

• New install → just get started.
• Coming from nfsfu234-tour-guide v0.x or v1.0.x → follow the Migration Guide.