tapp/filament-invite

invite users from filament panel

Fund package maintenance!
Tapp

v1.0.4 2024-04-24 14:31 UTC

This package is auto-updated.

Last update: 2024-04-29 05:35:55 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Provides an action to invite users from Filament users resource.

Installation

You can install the package via composer:

composer require tapp/filament-invite

You can publish the config using:

php artisan filament-invite:install

Requirements

  • User model which implements password resets and email verification (Laravel defaults)

Usage

Add invite action to a table

public static function table(Table $table): Table
{
    return $table
        ->actions([
            Tapp\FilamentInvite\Tables\InviteAction::make(),
        ]);
}

Invite action outside of a table uses a different class

public static function table(Table $table): Table
{
    return $table
        ->actions([
            Tapp\FilamentInvite\Actions\InviteAction::make(),
        ]);
}

Customization

Reset URL

implement getResetPasswordUrl on the user model

public function getResetPasswordUrl(string $token, array $parameters = []): string
{
    return URL::signedRoute(
        'filament.admin.auth.password-reset.reset',
        [
            'email' => $this->email,
            'token' => $token,
            ...$parameters,
        ],
    );
}

Notification

implement the sendPasswordResetNotification method on the user model

public function sendPasswordResetNotification($token)
{
    Notification::send($this, new SetPassword($token));
}

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.