PHPackages                             mrshanebarron/tour - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. mrshanebarron/tour

ActiveLibrary[Utility & Helpers](/categories/utility)

mrshanebarron/tour
==================

Product tour/onboarding component for Laravel - supports Livewire and Vue

v1.0.3(4mo ago)115MITVuePHP ^8.1

Since Dec 14Pushed 4mo agoCompare

[ Source](https://github.com/mrshanebarron/tour)[ Packagist](https://packagist.org/packages/mrshanebarron/tour)[ RSS](/packages/mrshanebarron-tour/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (1)Versions (5)Used By (0)

Tour
====

[](#tour)

Guided product tours and feature walkthroughs for Laravel applications. Highlights elements, shows tooltips, and navigates users through steps. Works with Livewire and Vue 3.

Installation
------------

[](#installation)

```
composer require mrshanebarron/tour
```

Livewire Usage
--------------

[](#livewire-usage)

### Basic Usage

[](#basic-usage)

```
@php
$steps = [
    ['target' => 'btn-new', 'title' => 'Create New', 'content' => 'Click here to create a new item.'],
    ['target' => 'btn-search', 'title' => 'Search', 'content' => 'Use this to search for items.'],
    ['target' => 'btn-settings', 'title' => 'Settings', 'content' => 'Access your settings here.'],
];
@endphp

New
Search
Settings
```

### Start Tour Button

[](#start-tour-button)

```
Start Tour
```

### With Progress Indicator

[](#with-progress-indicator)

```

```

### Allow Skip

[](#allow-skip)

```

```

### Custom Overlay Color

[](#custom-overlay-color)

```

```

### Livewire Props

[](#livewire-props)

PropTypeDefaultDescription`steps`array`[]`Array of tour steps`showProgress`boolean`true`Show step progress (1/3)`allowSkip`boolean`true`Show skip button`overlayColor`string`'rgba(0,0,0,0.5)'`Backdrop overlay color### Step Structure

[](#step-structure)

```
$steps = [
    [
        'target' => 'element-id',      // ID of element to highlight
        'title' => 'Step Title',        // Tooltip title
        'content' => 'Description...',  // Tooltip content
        'position' => 'bottom',         // Optional: top, bottom, left, right
    ],
];
```

### Methods

[](#methods)

```
Start
Skip
```

### Events

[](#events)

```

```

Vue 3 Usage
-----------

[](#vue-3-usage)

### Setup

[](#setup)

```
import { SbTour } from './vendor/sb-tour';
app.component('SbTour', SbTour);
```

### Basic Usage

[](#basic-usage-1)

```

  Start Tour

const steps = [
  { target: 'btn-1', title: 'First', content: 'This is the first step.' },
  { target: 'btn-2', title: 'Second', content: 'This is the second step.' },
];

```

### With Options

[](#with-options)

```

```

### Vue Props

[](#vue-props)

PropTypeDefaultDescription`steps`Array`[]`Tour steps`showProgress`Boolean`true`Show progress`allowSkip`Boolean`true`Allow skipping`overlayColor`String`'rgba(0,0,0,0.5)'`Overlay color### Methods

[](#methods-1)

MethodDescription`start()`Begin the tour`next()`Go to next step`previous()`Go to previous step`skip()`Skip the tour### Events

[](#events-1)

EventPayloadDescription`started`-Tour started`completed`-Tour finished all steps`skipped`-Tour was skipped`step-changed`numberCurrent step changedPersistent Tour State
---------------------

[](#persistent-tour-state)

```
// Remember if user completed the tour
public function mount()
{
    $this->showTour = !auth()->user()->completed_onboarding;
}

#[On('tour-completed')]
public function handleTourComplete(): void
{
    auth()->user()->update(['completed_onboarding' => true]);
}
```

Styling
-------

[](#styling)

The tour includes:

- Dark overlay with spotlight on target element
- Positioned tooltip with arrow
- Navigation buttons (Previous, Next, Skip)
- Step counter (1/5)
- Smooth transitions between steps

Requirements
------------

[](#requirements)

- PHP 8.1+
- Laravel 10, 11, or 12
- Tailwind CSS 3.x
- Alpine.js

License
-------

[](#license)

MIT License

###  Health Score

35

—

LowBetter than 80% of packages

Maintenance74

Regular maintenance activity

Popularity7

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

4

Last Release

145d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/7a38dc9b4ccc180ee3e9df8879f8747ea9dbf36812c6546827fe504fa8993eb8?d=identicon)[mrshanebarron](/maintainers/mrshanebarron)

### Embed Badge

![Health badge](/badges/mrshanebarron-tour/health.svg)

```
[![Health](https://phpackages.com/badges/mrshanebarron-tour/health.svg)](https://phpackages.com/packages/mrshanebarron-tour)
```

###  Alternatives

[barryvdh/laravel-ide-helper

Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.

14.9k123.0M683](/packages/barryvdh-laravel-ide-helper)[orchestra/canvas

Code Generators for Laravel Applications and Packages

21017.2M157](/packages/orchestra-canvas)[illuminate/pipeline

The Illuminate Pipeline package.

9446.6M210](/packages/illuminate-pipeline)[illuminate/pagination

The Illuminate Pagination package.

10532.5M858](/packages/illuminate-pagination)[spatie/laravel-pjax

A pjax middleware for Laravel 5

513371.8k11](/packages/spatie-laravel-pjax)[spatie/laravel-mix-preload

Add preload and prefetch links based your Mix manifest

169176.0k2](/packages/spatie-laravel-mix-preload)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)