https://github.com/tappnetwork/filament-invite
https://github.com/tappnetwork/filament-invite
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tappnetwork/filament-invite
- Owner: TappNetwork
- License: mit
- Created: 2024-04-04T18:53:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-24T05:08:07.000Z (7 months ago)
- Last Synced: 2025-12-05T16:12:29.931Z (7 months ago)
- Language: PHP
- Size: 339 KB
- Stars: 31
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Invite users from Filament panel
[](https://packagist.org/packages/tapp/filament-invite)
[](https://packagist.org/packages/tapp/filament-invite)
Provides an action to invite users from Filament users resource.
## Version Compatibility
Filament | Filament Invite
:---------|:---------------
3.x | 1.x
4.x | 2.x
## Installation
You can install the package via Composer:
### For Filament 3
```bash
composer require tapp/filament-invite:"^1.0"
```
### For Filament 4
```bash
composer require tapp/filament-invite:"^2.0"
```
Please check the docs for [Filament 4 here](https://github.com/TappNetwork/Filament-Invite/tree/2.x)
You can publish the config using:
```bash
php artisan filament-invite:install
```
## Requirements
- User model which implements password resets and email verification (Laravel defaults)
## Usage
Add invite action to a table
```php
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
```php
protected function getHeaderActions(): array
{
return [
\Tapp\FilamentInvite\Actions\InviteAction::make(),
];
}
```
## Customization
### Reset URL
implement getResetPasswordUrl on the user model
```php
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
```php
public function sendPasswordSetNotification($token)
{
Notification::send($this, new SetPassword($token));
}
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [TappNetwork](https://github.com/scottgrayson)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.