README

A package to show the user's current team in the url. Good to generate permalinks and to auto switch when is convenient. You must install Laravel Jetstream with the Team feature enabled.

Installation

You can install the package via composer:

composer require danpalmieri/jetstream-team-url

You can publish the config file with:

php artisan vendor:publish --tag="jetstream-team-url-config"

This is the contents of the published config file:

return [
    'url' => [
        'prefix' => 'teams', // the prefix for the team routes
        'team_attribute' => 'id', // the attribute to use for the team route
    ],

    'middleware' => \DanPalmieri\JetstreamTeamUrl\Middleware\VerifyOrSetCurrentTeamInRoute::class,
    
    'livewire_support' => true, // Add a persistent middleware to Livewire to support the team in the URL

    'on_denied' => [
        'strategy' => 'redirect', // abort|redirect
        'redirect' => [
            'to' => '/',
            'with' => [
                'key' => 'error',
                'value' => 'You are not allowed to access this team.',
            ],
        ],
        'abort' => [403, 'You are not allowed to access this team.'],
    ],

    'on_different_team' => [
        'strategy' => 'switch', // abort|switch
        'abort' => [403, 'You are not working on the right team.'],
    ],
];

Usage

Just add the method useTeamInUrl() method to your routes group.

Route::useTeamInUrl(function () {
    Route::get('/dashboard', fn () => view('dashboard')); // example.test/teams/2352/dashboard
});

You also get the currentTeamRedirect() method. Put this outside of the Route::useTeamInUrl() method.

Route::currentTeamRedirect('_'); // example.test/_/posts/34 -> example.test/teams/2352/posts/34

Behaviour

Somethings to note about the package:

The package will automatically add the team id (or other attribute) to the url if the user is logged and on a team (and you are using named routes).
It will also check if the user is on the correct team. If not, it will redirect or abort.
The currentTeamRedirect($char) method will replace the occurence of the character with the current team id (or other attribute) in the url.

Testing

composer test

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

License

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

danpalmieri / jetstream-team-url

Maintainers

Details