Download the PHP package spatie/laravel-onboard without Composer

On this page you can find all versions of the php package spatie/laravel-onboard. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of spatie/laravel-onboard

Informations about the package laravel-onboard

A Laravel package to help track user onboarding steps

Latest Version on Packagist Total Downloads

This package lets you set up an onboarding flow for your application's users.

Here's an example of how it's set up:

You can then render this onboarding flow however you want in your templates:

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

Usage

Add the Spatie\Onboard\Concerns\GetsOnboarded trait and Spatie\Onboard\Concerns\Onboardable interface to any model or class in your app, for example the User model:

Example configuration

Configure your steps in your App\Providers\AppServiceProvider.php

The variable name passed to the completeIf callback must be $model.

Usage

Now you can access these steps along with their state wherever you like. Here is an example blade template:

Check out all the available features below:

Excluding steps based on condition:

Limiting steps to a specific class:

When using limited steps, steps that are not limited will be available to all classes. For example:

The above will result in 1 step being available to all classes, and 2 steps being available to the User and Team classes:

Other classes will only see the Normal Step. User classes will both see the Normal Step and Limited User Step. Team classes will both see the Normal Step and Limited Team Step.

Definining custom attributes and accessing them:

Example middleware

If you want to ensure that your User is redirected to the next unfinished onboarding step, whenever they access your web application, you can use the following middleware as a starting point:

Quick tip: Don't add this middleware to routes that update the state of the onboarding steps, your users will not be able to progress because they will be redirected back to the onboarding step.

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

The original code from this package came from Onboard by Caleb Porzio, who was gratious enough to let us continue development.

License

The MIT License (MIT). Please see License File for more information.

All versions of laravel-onboard with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
illuminate/contracts Version ^9.0|^10.0|^11.0
spatie/laravel-package-tools Version ^1.9.2
spatie/once Version ^3.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package spatie/laravel-onboard contains the following files

Loading the files please wait ....