Filament Inbox

https://github.com/qalainau/filament-inbox
Admin
Filament Inbox is an email-like inbox messaging plugin for Filament v5 that provides threads,...
Tokens:945
Snippets:17
Trust Score:8.3
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### Filament Inbox Configuration Example

Source: https://github.com/qalainau/filament-inbox/blob/main/README.md

Example configuration file for Filament Inbox, showing options for custom user models, table names, and tenant relationships.

```php
// config/filament-inbox.php
return [
    // Custom user model (defaults to auth provider model)
    'user_model' => null,

    // Custom users table name (auto-detected from model)
    'users_table' => null,

    // Tenant-users relationship method on tenant model
    // Auto-detects 'members' or 'users' if null
    'tenant_users_relationship' => null,
];
```

--------------------------------

### Install Filament Inbox Plugin

Source: https://github.com/qalainau/filament-inbox/blob/main/README.md

Install the plugin using Composer. This is the first step to integrating the inbox functionality.

```bash
composer require qalainau/filament-inbox
```

--------------------------------

### Setup Filament Database Notifications

Source: https://github.com/qalainau/filament-inbox/blob/main/README.md

Run the necessary Artisan commands to create and migrate the notifications table, which is required for Filament's database notification system.

```bash
php artisan make:notifications-table
php artisan migrate
```

--------------------------------

### Run Tests for Filament Inbox

Source: https://github.com/qalainau/filament-inbox/blob/main/README.md

Execute the test suite for the Filament Inbox plugin to ensure its functionality and stability.

```bash
composer test
```

--------------------------------

### Publish Filament Inbox Configuration

Source: https://github.com/qalainau/filament-inbox/blob/main/README.md

Publish the configuration file for Filament Inbox to customize settings like the user model or tenant relationships.

```bash
php artisan vendor:publish --tag=filament-inbox-config
```

--------------------------------

### Register Filament Inbox Plugin in Panel

Source: https://github.com/qalainau/filament-inbox/blob/main/README.md

Register the FilamentInboxPlugin within your Filament panel configuration. Ensure `databaseNotifications()` is called to enable the notification system.

```php
use FilamentInbox\FilamentInboxPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->databaseNotifications()
        ->plugin(FilamentInboxPlugin::make());
}
```

--------------------------------

### Add HasInbox Trait to User Model

Source: https://github.com/qalainau/filament-inbox/blob/main/README.md

Incorporate the `HasInbox` trait into your User model to enable inbox functionalities for users.

```php
use FilamentInbox\Concerns\HasInbox;

class User extends Authenticatable
{
    use HasInbox;
}
```
Tokens:
Raw