README

Provides an action to invite users from Filament users resource.

Version Compatibility

Installation

You can install the package via Composer:

composer require tapp/filament-invite:"^2.0"

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
        ->recordActions([
            \Tapp\FilamentInvite\Actions\InviteAction::make(),
        ]);
}

Add invite action to header actions in your resource view or edit page (e.g. App\Filament\Resources\Users\Pages\EditUser.php or App\Filament\Resources\Users\Pages\ViewUser.php), as the InviteAction resolves the user from the current record, which is available on edit and view pages.

    protected function getHeaderActions(): array
    {
        return [
            \Tapp\FilamentInvite\Actions\InviteAction::make(),
        ];
    }

Add invite bulk action to table toolbar actions

use Filament\Actions\BulkActionGroup;
use Tapp\FilamentInvite\Actions\InviteBulkAction;

public static function table(Table $table): Table
{
    return $table
        ->toolbarActions([
            BulkActionGroup::make([
                InviteBulkAction::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 sendPasswordSetNotification method on the user model

public function sendPasswordSetNotification($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

• TappNetwork
• All Contributors

License

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