Weave Code
Tour Bundle Laravel Package
rich-id/tour-bundle
Rich ID Tour Bundle is a PHP package for adding guided tours and onboarding flows to your app. Define multi-step tours, attach contextual steps to pages or features, and help users discover functionality through an in-app walkthrough experience.
At a glance
Frequently asked questions about Tour Bundle
- What is rich-id/tour-bundle used for?
- rich-id/tour-bundle is a PHP package for defining and running multi-step guided tours in an app, including onboarding walkthroughs, product demos, and feature spotlights. Tours are declared as ordered steps with targets, copy, and display conditions in plain PHP config. It renders through a lightweight, framework-friendly runtime with no heavy frontend dependency. Use it when you want tour logic close to the rest of your Laravel application.
- How do I install rich-id/tour-bundle in a Laravel app?
- Install the package with Composer using the rich-id/tour-bundle package name, then follow the repository README for service provider registration and config publishing. The provided excerpt does not include the exact artisan or vendor:publish commands, so verify them before scripting deployment. Confirm the package's composer.json constraints against your Laravel and PHP versions first.
- Which Laravel and PHP versions does rich-id/tour-bundle support?
- The source data provided here does not include the composer.json version matrix, so treat Laravel and PHP support as unverified until you check the package constraints. The v2.1.0 'Add Voter' note may silently raise the floor if the feature relies on newer container or enum support. Test a clean composer update in a branch before committing to the upgrade.
- How do I define a multi-step tour with rich-id/tour-bundle?
- Define tours as ordered steps in plain PHP configuration, with each step carrying its target, copy, and display conditions. The package is designed so tour logic stays in application config rather than hand-written frontend code. Use the pluggable step renderers to control how each step appears. Check the README for the exact config schema and renderer contract.
- Can I target tours by route, role, or user state?
- Yes, the package supports conditional targeting by route, role, or user state as part of its declarative tour definitions. That lets you show onboarding only on relevant pages or to users who meet specific conditions. The exact condition syntax and evaluation order should be confirmed in the README. Test edge cases such as unauthenticated users and role changes.
- How do I track tour progress and lifecycle events?
- The package provides pluggable step renderers with progress persistence and fires events for tour start, advance, skip, and completion. Use those events for analytics, logging, or gating later steps. You will need to configure the persistence layer and confirm event names and payloads in the source or docs. Keep persistence and event handling testable so tour state does not leak between users.
- How do I test guided tours in a Laravel app?
- Start by unit-testing tour definitions as config: assert step order, targets, and route, role, or user-state conditions. For integration, assert that the runtime emits start, advance, skip, and completion events when expected. If the package ships test helpers or fake renderers, use them, but the provided excerpt does not document them. Keep renderer tests separate from tour logic tests.
- Is rich-id/tour-bundle production-ready for onboarding tours?
- The core tour runtime is described as lightweight and framework-friendly, but the v2.1.0 'Add Voter' note introduces material ambiguity. Treat production adoption as conditional: pin the current 2.0.x line, diff 2.0.x to 2.1.0 in the vendor tree, and pilot on a non-critical flow. Run any new authorization-related behavior behind a feature flag and log disagreements before default-on.
- What is the 'Add Voter' change in rich-id/tour-bundle v2.1.0?
- The only source signal is a two-word v2.1.0 note, 'Add Voter,' so the change is not disambiguated. It could be an authorization voter that composes with or bypasses Laravel Gate/Policy, a domain voting feature, or a new Voter model that implies migrations. Verify the diff before upgrading, and document precedence and ABSTAIN behavior if it touches authorization. Do not adopt it first on billing, admin, or tenancy boundaries.
- What are the alternatives and maintenance concerns for rich-id/tour-bundle?
- Alternatives include JavaScript tour libraries such as Shepherd.js or Intro.js, custom Laravel onboarding code, or other PHP tour packages; this package's differentiator is declarative PHP config and a lightweight runtime. Maintenance risk is mainly the undocumented v2.1.0 'Add Voter' change and the documentation burden it creates. Name an internal owner before merging and avoid ambient composer updates. Audit for collisions with existing authorization middleware or Gate extensions if the Voter feature is enabled.
Weaver
How can I help you explore Laravel packages today?