Filament Notification Center

https://github.com/prodstarter/filament-notification-center
Admin
A smarter notification experience for Filament — categorized tabs for the notification drawer, with...
Tokens:42,595
Snippets:382
Trust Score:7
License:MIT
Update:3 days ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/prodstarter/filament-notification-center/blob/main/README.md

Install the package using Composer. No migration is needed; categories are stored in the existing notifications table's data column.

```bash
composer require prodstarter/filament-notification-center
```

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

### Example: Iterating categoryTabs

Source: https://github.com/prodstarter/filament-notification-center

Basic example showing how to access the categoryTabs computed property and iterate over the tabs to read their properties.

```php
/** @var NotificationCenter $component */
$tabs = $component->categoryTabs;

foreach ($tabs as $tab) {
    // $tab->id, $tab->label, $tab->icon, $tab->color, $tab->count
}
```

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

### getCategoryEmptyState() example

Source: https://github.com/prodstarter/filament-notification-center

Basic usage example for getCategoryEmptyState() with the 'orders' category, showing the returned array structure.

```php
$state = $component->getCategoryEmptyState('orders');
// ['heading' => 'No notifications yet.', 'description' => "You're all caught up."]
```

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

### getCategory usage example

Source: https://github.com/prodstarter/filament-notification-center

Example of retrieving a category by id and handling the case where it is null.

```php
$category = $center->getCategory('orders');

if ($category === null) {
    // handle missing category
} else {
    $label = $category->getLabel();
}
```

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

### emptyStateUsing basic example

Source: https://github.com/prodstarter/filament-notification-center

Example of registering a callback that returns the empty state heading and description for a category.

```php
$center->emptyStateUsing(fn (string $categoryId): array => [
    'heading' => "Nothing here yet",
    'description' => "You're all caught up in {$categoryId}.",
]);
```

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

### Full fluent construction example

Source: https://github.com/prodstarter/filament-notification-center

Shows how to create a NotificationCenterCategory with fluent methods, including label, icon, color, and order. Also demonstrates creating multiple categories.

```php
use Filament\Support\Colors\Color;
use Filament\Support\Icons\Heroicon;
use Prodstarter\FilamentNotificationCenter\NotificationCenterCategory;

$category = NotificationCenterCategory::make('system')
    ->label('System')
    ->icon(Heroicon::Cog6Tooth)
    ->color(Color::Gray)
    ->order(1);

$categories = [$category, NotificationCenterCategory::make('orders')->order(2)];
```

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

### boot(Panel $panel): void

Source: https://github.com/prodstarter/filament-notification-center

Empty hook required by the Plugin contract. This method is invoked by Filament during panel setup but performs no actions.

```APIDOC
## boot(Panel $panel): void

### Description
Empty hook required by the `Plugin` contract.

### Method
`boot`

### Endpoint
`FilamentNotificationCenterPlugin::boot(Panel $panel)`

### Parameters
#### Path Parameters
- `$panel` (`Filament\Panel`) - Required - The panel being configured.

### Returns
`void`

### Source
`src/FilamentNotificationCenterPlugin.php:31`

```php
public function boot(Panel $panel): void
{
    //
}
```
```

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

### configurePackage method

Source: https://github.com/prodstarter/filament-notification-center

Configures the package for package-tools: registers commands, an install command that publishes the config file and prompts to star the repo, and conditionally adds config file, translations, and views based on file existence.

```php
public function configurePackage(Package $package): void
{
    $package->name(static::$name)
        ->hasCommands($this->getCommands())
        ->hasInstallCommand(function (InstallCommand $command) {
            $command
                ->publishConfigFile()
                ->askToStarRepoOnGitHub('prodstarter/filament-notification-center');
        });

    if (file_exists($package->basePath('/../config/notification-center.php'))) {
        $package->hasConfigFile('notification-center');
    }

    if (file_exists($package->basePath('/../resources/lang'))) {
        $package->hasTranslations();
    }

    if (file_exists($package->basePath('/../resources/views'))) {
        $package->hasViews(static::$viewNamespace);
    }
}
```

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

### assertNotificationCategoryTabCount error handling example

Source: https://github.com/prodstarter/filament-notification-center

Example showing failure messages when the tab does not exist or the count mismatches.

```php
// This fails the test with: No notification category tab exists with id [billing].
livewire(NotificationCenter::class)
    ->assertNotificationCategoryTabCount('billing', 0);

// This fails with: Expected [2] unread notifications in the [orders] category, got [1].
livewire(NotificationCenter::class)
    ->assertNotificationCategoryTabCount('orders', 2);
```

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

### assertNotificationCategoryTabCount basic example

Source: https://github.com/prodstarter/filament-notification-center

Example of using assertNotificationCategoryTabCount in a Pest test with Livewire.

```php
use Filament\Notifications\Notification;
use Prodstarter\FilamentNotificationCenter\Livewire\NotificationCenter;
use function Pest\Livewire\livewire;

Notification::make()->title('Order shipped')->category('orders')->sendToDatabase($user);

livewire(NotificationCenter::class)
    ->assertNotificationCategoryTabCount('orders', 1)
    ->assertNotificationCategoryTabCount('all', 1);
```

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

### getOrder() usage example

Source: https://github.com/prodstarter/filament-notification-center

Example of calling getOrder() on a category instance. The result is 0 by default.

```php
$order = $category->getOrder(); // 0 by default
```

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

### Example: Register plugin on panel with databaseNotifications

Source: https://github.com/prodstarter/filament-notification-center

Shows how to register the plugin on a Filament panel, combined with databaseNotifications.

```php
use Filament\Panel;
use Prodstarter\FilamentNotificationCenter\FilamentNotificationCenterPlugin;

return $panel
    ->databaseNotifications()
    ->plugins([
        FilamentNotificationCenterPlugin::make(),
    ]);
```

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

### Command invocation example

Source: https://github.com/prodstarter/filament-notification-center

Invoke the command via `php artisan filament-notification-center`. The output is 'All done'.

```bash
php artisan filament-notification-center
# Output: All done
```

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

### getColor() usage example

Source: https://github.com/prodstarter/filament-notification-center

Example of calling getColor() on a category instance. The result is 'amber' or null.

```php
$color = $category->getColor(); // 'amber' or null
```

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

### Basic usage example with contract-implementing enum

Source: https://github.com/prodstarter/filament-notification-center

Shows how to create a category from a BackedEnum case. The enum must implement HasLabel, HasIcon, and/or HasColor contracts to provide label, icon, and color. The id is derived from the enum's value.

```php
use App\Enums\NotificationCategory;

$category = NotificationCenterCategory::fromEnum(NotificationCategory::Orders);

$category->getId();    // 'orders'
$category->getLabel(); // from getLabel()
$category->getIcon();  // from getIcon() or null
$category->getColor(); // from getColor() or null
```

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

### Basic per-panel categories example

Source: https://github.com/prodstarter/filament-notification-center

Shows how to set categories for a panel using NotificationCenterCategory instances with labels and ordering.

```php
FilamentNotificationCenterPlugin::make()->categories([
    NotificationCenterCategory::make('system')->label('System')->order(1),
    NotificationCenterCategory::make('orders')->label('Orders')->order(2),
]);
```

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

### Basic usage example

Source: https://github.com/prodstarter/filament-notification-center

Calls getEmptyState with a category ID and shows the default output when no custom callback is registered.

```php
$state = $center->getEmptyState('orders');
// ['heading' => 'No notifications yet.', 'description' => "You're all caught up."]
```

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

### Example: NotificationCenterCategory::make('orders')

Source: https://github.com/prodstarter/filament-notification-center

Basic usage creating a category with id 'orders'.

```php
use Prodstarter\FilamentNotificationCenter\NotificationCenterCategory;

$category = NotificationCenterCategory::make('orders');
```

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

### resolveCategoryId usage example

Source: https://github.com/prodstarter/filament-notification-center

Shows resolution for null, empty string, and a specific category.

```php
$center->defaultCategory('general');

$center->resolveCategoryId(null);       // 'general'
$center->resolveCategoryId('');         // 'general'
$center->resolveCategoryId('orders');   // 'orders'
```

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

### Custom callback example

Source: https://github.com/prodstarter/filament-notification-center

Registers a custom callback via emptyStateUsing and then calls getEmptyState to see the custom output.

```php
$center->emptyStateUsing(fn (string $categoryId): array => [
    'heading' => "Empty in {$categoryId}",
    'description' => 'Custom description',
]);

$center->getEmptyState('orders'); // ['heading' => 'Empty in orders', 'description' => 'Custom description']
```

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

### assertActiveNotificationCategory usage example

Source: https://github.com/prodstarter/filament-notification-center

Example of using assertActiveNotificationCategory in a Pest test with Livewire.

```php
use Prodstarter\FilamentNotificationCenter\Livewire\NotificationCenter;
use function Pest\Livewire\livewire;

livewire(NotificationCenter::class)
    ->assertActiveNotificationCategory('all')
    ->call('setActiveCategory', 'orders')
    ->assertActiveNotificationCategory('orders');
```

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

### defaultCategory usage example

Source: https://github.com/prodstarter/filament-notification-center

Shows how to set the default category to 'general' using the defaultCategory method.

```php
FilamentNotificationCenterPlugin::make()->defaultCategory('general');
```

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

### Enum-based categories example

Source: https://github.com/prodstarter/filament-notification-center

Shows how to set categories using a BackedEnum, such as NotificationCategory::Orders and NotificationCategory::Crm.

```php
FilamentNotificationCenterPlugin::make()->categories([
    NotificationCategory::Orders,
    NotificationCategory::Crm,
]);
```

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

### getCategories() basic usage example

Source: https://github.com/prodstarter/filament-notification-center

Returns sorted ids, e.g. ['orders', 'crm'].

```php
$ids = $center->getCategories()->keys()->all(); // sorted ids, e.g. ['orders', 'crm']
```

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

### get(): static

Source: https://github.com/prodstarter/filament-notification-center

Returns the current plugin instance for the panel, resolved via filament($pluginId). This static accessor is used internally by the Livewire component to retrieve the plugin instance.

```APIDOC
## get(): static

### Description
Returns the current plugin instance for the panel — resolved via `filament($pluginId)`.

### Method
`get`

### Endpoint
`FilamentNotificationCenterPlugin::get()`

### Parameters
None.

### Returns
`static` — the active plugin instance for the current panel.

### Source
`src/FilamentNotificationCenterPlugin.php:44`

```php
public static function get(): static
{
    /** @var static $plugin */
    $plugin = filament(app(static::class)->getId());

    return $plugin;
}
```
```

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

### getIcon() usage example

Source: https://github.com/prodstarter/filament-notification-center

Retrieves the icon for a category, which may be a string like 'heroicon-o-shopping-bag' or null.

```php
$icon = $category->getIcon(); // 'heroicon-o-shopping-bag' or null
```

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

### defaultCategory usage example

Source: https://github.com/prodstarter/filament-notification-center

Sets the default category to 'general' and retrieves it.

```php
$center->defaultCategory('general');

$center->getDefaultCategory(); // 'general'
```

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

### Full plugin registration example

Source: https://github.com/prodstarter/filament-notification-center

Registers the FilamentNotificationCenterPlugin with categories, default category, and empty state. Uses Filament's databaseNotifications() and plugin methods. No custom exceptions are thrown; methods silently overwrite prior values.

```php
use Filament\Panel;
use Filament\Support\Colors\Color;
use Filament\Support\Icons\Heroicon;
use Prodstarter\FilamentNotificationCenter\FilamentNotificationCenterPlugin;
use Prodstarter\FilamentNotificationCenter\NotificationCenterCategory;

public function panel(Panel $panel): Panel
{
    return $panel
        ->databaseNotifications()
        ->plugins([
            FilamentNotificationCenterPlugin::make()
                ->defaultCategory('general')
                ->categories([
                    NotificationCenterCategory::make('system')
                        ->label('System')
                        ->icon(Heroicon::Cog6Tooth)
                        ->color(Color::Gray)
                        ->order(1),
                    NotificationCenterCategory::make('orders')
                        ->label('Orders')
                        ->icon(Heroicon::ShoppingBag)
                        ->color(Color::Amber)
                        ->order(2),
                ])
                ->emptyStateUsing(fn (string $categoryId): array => [
                    'heading' => 'Nothing here yet',
                    'description' => "You're all caught up in {$categoryId}.",
                ]),
        ]);
}
```

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

### getId() usage example

Source: https://github.com/prodstarter/filament-notification-center

Retrieves the category id, which is the id passed to the constructor or make().

```php
$id = $category->getId(); // 'orders'
```

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

### Static accessor get(): static

Source: https://github.com/prodstarter/filament-notification-center

Returns the current plugin instance for the panel, resolved via filament($pluginId). Used internally by the Livewire component's getCategoryRegistry() method.

```php
public static function get(): static
{
    /** @var static $plugin */
    $plugin = filament(app(static::class)->getId());

    return $plugin;
}
```

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

### hasCategories() usage example

Source: https://github.com/prodstarter/filament-notification-center

Shows initial false, then true after setting categories. The plugin's getCategoryRegistry() uses this to decide fallback to global singleton.

```php
$center = new FilamentNotificationCenter;
$center->hasCategories(); // false

$center->categories([NotificationCenterCategory::make('orders')]);
$center->hasCategories(); // true
```

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

### getDefaultCategory usage example

Source: https://github.com/prodstarter/filament-notification-center

Echoes the default category id, which is 'general' unless overridden.

```php
echo $center->getDefaultCategory(); // 'general' unless overridden
```

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

### Livewire test: calling setActiveCategory

Source: https://github.com/prodstarter/filament-notification-center

Example of testing the setActiveCategory method from a Livewire test. Asserts that the activeCategory property is set to 'orders'.

```php
livewire(NotificationCenter::class)
    ->call('setActiveCategory', 'orders')
    ->assertSet('activeCategory', 'orders');
```

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

### Usage examples for category and getCategory macros

Source: https://github.com/prodstarter/filament-notification-center

Shows categorized notifications, reading back the category, enum usage, and uncategorized behavior. When sent to the database, the category is stored in the notification data['viewData']['category'] JSON column without requiring a schema migration; existing viewData is merged without dropping the category key.

```php
use Filament\Notifications\Notification;

// Categorized notification
Notification::make()
    ->title('New order #1042 received')
    ->icon('heroicon-o-shopping-bag')
    ->color('warning')
    ->category('orders')
    ->sendToDatabase($user);

// Reads back
$category = Notification::make()->title('x')->category('orders')->getCategory(); // 'orders'

// Enum form
Notification::make()->category(NotificationCategory::Orders)->sendToDatabase($user);

// Uncategorized -> getCategory() returns null
$blank = Notification::make()->title('Server restarted')->getCategory(); // null
```

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

### register(Panel $panel): void

Source: https://github.com/prodstarter/filament-notification-center

Registers the plugin's Livewire component as the panel's database-notifications component, replacing Filament's built-in drawer. This method is required by the Plugin contract and is invoked by Filament during panel setup.

```APIDOC
## register(Panel $panel): void

### Description
Registers the plugin's Livewire component as the panel's database-notifications component, replacing Filament's built-in drawer.

### Method
`register`

### Endpoint
`FilamentNotificationCenterPlugin::register(Panel $panel)`

### Parameters
#### Path Parameters
- `$panel` (`Filament\Panel`) - Required - The panel being configured.

### Returns
`void`

### Source
`src/FilamentNotificationCenterPlugin.php:26`

```php
public function register(Panel $panel): void
{
    $panel->databaseNotificationsLivewireComponent(NotificationCenter::class);
}
```
```

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

### Run tests with composer test

Source: https://github.com/prodstarter/filament-notification-center/blob/main/README.md

Executes the project's test suite using Composer. Run this command from the project root to verify the package works as expected.

```bash
composer test
```

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

### boot(Panel $panel): void

Source: https://github.com/prodstarter/filament-notification-center

Empty hook required by the Plugin contract.

```php
public function boot(Panel $panel): void
{
    //
}
```

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

### packageBooted(): void

Source: https://github.com/prodstarter/filament-notification-center

Registers CSS assets, script data, icons, stubs, the Livewire testing mixin, and the notification category macros.

```APIDOC
## packageBooted(): void

### Description
Registers CSS assets, script data, icons, stubs, the Livewire testing mixin, and the notification category macros.

### Method
`packageBooted`

### Signature
```php
public function packageBooted(): void
```

### Returns
`void`

### Source
`src/FilamentNotificationCenterServiceProvider.php:59`
```

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

### Instantiate FilamentNotificationCenter (direct, container, facade)

Source: https://github.com/prodstarter/filament-notification-center

Shows three ways to obtain the manager: direct instantiation, container singleton via app(), and the facade (aliased as NotificationCenter). The facade call proxies to the singleton.

```php
// Direct instantiation (not the container way — see the facade below):
$manager = new FilamentNotificationCenter;

// Container singleton:
$manager = app(FilamentNotificationCenter::class);

// Facade (also aliased as NotificationCenter):
use Prodstarter\FilamentNotificationCenter\Facades\FilamentNotificationCenter as Facade;
FilamentNotificationCenter::categories([...]); // static facade call proxies to the singleton
```

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

### packageBooted(): void - Register assets, icons, stubs, testing mixin, and macros

Source: https://github.com/prodstarter/filament-notification-center

Registers CSS assets, script data, icons, stubs, the Livewire testing mixin, and the notification category macros. Returns void.

```php
public function packageBooted(): void
{
    FilamentAsset::register(
        $this->getAssets(),
        $this->getAssetPackageName()
    );

    FilamentAsset::registerScriptData(
        $this->getScriptData(),
        $this->getAssetPackageName()
    );

    FilamentIcon::register($this->getIcons());

    if (app()->runningInConsole()) {
        foreach (app(Filesystem::class)->files(__DIR__ . '/../stubs/') as $file) {
            $this->publishes([
                $file->getRealPath() => base_path("stubs/filament-notification-center/{$file->getFilename()}"),
            ], 'filament-notification-center-stubs');
        }
    }

    Testable::mixin(new TestsFilamentNotificationCenter);

    $this->registerNotificationCategoryMacros();
}
```

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

### Register categories globally via NotificationCenter facade

Source: https://github.com/prodstarter/filament-notification-center/blob/main/README.md

Register categories once in a service provider's boot() method so every panel shares them. A panel falls back to this global registration only if its plugin instance has no categories of its own.

```php
use NotificationCenter;

NotificationCenter::categories([
    // ...
]);
```

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

### Publish config file

Source: https://github.com/prodstarter/filament-notification-center

Run this artisan command to publish the package's configuration file to your Laravel app.

```bash
php artisan vendor:publish --tag="filament-notification-center-config"
```

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

### handle() method implementation

Source: https://github.com/prodstarter/filament-notification-center

The handle() method writes the comment 'All done' to the console and always returns self::SUCCESS (0), never signaling an error exit code.

```php
public function handle(): int
{
    $this->comment('All done');

    return self::SUCCESS;
}
```

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

### getCategoryEmptyState() method

Source: https://github.com/prodstarter/filament-notification-center

Returns the empty-state heading/description for the given category, delegating to the category registry. Source: src/Livewire/NotificationCenter.php:111.

```php
/**
 * @return array{heading: string, description: string}
 */
public function getCategoryEmptyState(string $categoryId): array
{
    return $this->getCategoryRegistry()->getEmptyState($categoryId);
}
```

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

### FilamentNotificationCenterCommand class implementation

Source: https://github.com/prodstarter/filament-notification-center

Minimal Laravel artisan command stub with signature 'filament-notification-center', placeholder description 'My command', and a handle() method that prints 'All done' and returns self::SUCCESS (0). No arguments or options are defined.

```php
class FilamentNotificationCenterCommand extends Command
{
    public $signature = 'filament-notification-center';

    public $description = 'My command';

    public function handle(): int
    {
        $this->comment('All done');

        return self::SUCCESS;
    }
}
```

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

### render() method

Source: https://github.com/prodstarter/filament-notification-center

Renders the filamenotification-center::livewire.notification-center Blade view. Source: src/Livewire/NotificationCenter.php:116.

```php
public function render(): View
{
    return view('filament-notification-center::livewire.notification-center');
}
```

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

### Static factory make(): resolves plugin from container

Source: https://github.com/prodstarter/filament-notification-center

Resolves the plugin instance from the container. Returns the plugin instance.

```php
public static function make(): static
{
    return app(static::class);
}
```

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

### Register Plugin on a Panel

Source: https://github.com/prodstarter/filament-notification-center/blob/main/README.md

Register the plugin in a panel provider and define categories. This replaces Filament's built-in notification drawer; ensure ->databaseNotifications() is enabled. Different panels can have their own category sets.

```php
use Filament\Panel;
use Filament\Support\Colors\Color;
use Filament\Support\Icons\Heroicon;
use Prodstarter\FilamentNotificationCenter\FilamentNotificationCenterPlugin;
use Prodstarter\FilamentNotificationCenter\NotificationCenterCategory;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->databaseNotifications()
        ->plugins([
            FilamentNotificationCenterPlugin::make()->categories([
                NotificationCenterCategory::make('system')
                    ->label('System')
                    ->icon(Heroicon::Cog6Tooth)
                    ->color(Color::Gray)
                    ->order(1),
                NotificationCenterCategory::make('orders')
                    ->label('Orders')
                    ->icon(Heroicon::ShoppingBag)
                    ->color(Color::Amber)
                    ->order(2),
                NotificationCenterCategory::make('crm')
                    ->label('CRM')
                    ->icon(Heroicon::Users)
                    ->color(Color::Blue)
                    ->order(3),
                NotificationCenterCategory::make('billing')
                    ->label('Billing')
                    ->icon(Heroicon::CreditCard)
                    ->color(Color::Emerald)
                    ->order(4),
            ]),
        ]);
}
```

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

### Usage: using the trait

Source: https://github.com/prodstarter/filament-notification-center

Example of using the CategorizesImportNotifications trait in a Filament Importer class. The trait automatically categorizes the completion notification.

```php
use Filament\Actions\Imports\Importer;
use Prodstarter\FilamentNotificationCenter\Concerns\CategorizesImportNotifications;

class ProductImporter extends Importer
{
    use CategorizesImportNotifications;

    // ... rest of your importer
}
```

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

### make(): static

Source: https://github.com/prodstarter/filament-notification-center

Resolves the plugin instance from the container. This static factory method is used to create and register the plugin on a Filament panel.

```APIDOC
## make(): static

### Description
Resolves the plugin instance from the container. This static factory method is used to create and register the plugin on a Filament panel.

### Method
make

### Signature
```php
public static function make(): static
```

### Parameters
None.

### Returns
`static` — the plugin instance.

### Example
```php
use Filament\Panel;
use Prodstarter\FilamentNotificationCenter\FilamentNotificationCenterPlugin;

return $panel
    ->databaseNotifications()
    ->plugins([
        FilamentNotificationCenterPlugin::make(),
    ]);
```
```

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

### Usage: trait + custom modifyCompletedNotification

Source: https://github.com/prodstarter/filament-notification-center

Example of using the trait while overriding modifyCompletedNotification for additional customization. Calls categorizeImportNotification() and then adds an icon to the notification.

```php
use Filament\Actions\Imports\Importer;
use Filament\Actions\Imports\Models\Import;
use Filament\Notifications\Notification;
use Prodstarter\FilamentNotificationCenter\Concerns\CategorizesImportNotifications;

class ProductImporter extends Importer
{
    use CategorizesImportNotifications;

    public static function modifyCompletedNotification(Notification $notification, Import $import): Notification
    {
        $notification = static::categorizeImportNotification($notification);

        return $notification->icon('heroicon-o-shopping-bag');
    }
}
```

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

### Inspecting tabs from Livewire component

Source: https://github.com/prodstarter/filament-notification-center

Shows how to access tab properties in tests or app code. Uses firstWhere to find tabs by id and reads the count property.

```php
/** @var NotificationCenter $component */
$tabs = $component->categoryTabs; // Collection<int, NotificationCenterTab>

$allTab = $tabs->firstWhere('id', 'all');
$allTab->count; // total unread count

$ordersTab = $tabs->firstWhere('id', 'orders');
$ordersTab?->count; // unread count in 'orders'
```

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

### Enable Imports tab in config/notification-center.php

Source: https://github.com/prodstarter/filament-notification-center/blob/main/README.md

Controls whether the Imports tab exists and its label, icon, color, and order. Setting 'enabled' to false stops new notifications from being tagged.

```php
// config/notification-center.php
'imports' => [
    'enabled' => true,
    'category' => 'imports',
    'label' => 'Imports',
    'icon' => 'heroicon-o-arrow-up-tray',
    'color' => 'info',
    'order' => 90,
],
```

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

### hasAnyNotifications() method

Source: https://github.com/prodstarter/filament-notification-center

Returns whether the base query has any notifications at all, regardless of category. Source: src/Livewire/NotificationCenter.php:103.

```php
public function hasAnyNotifications(): bool
{
    return $this->getBaseNotificationsQuery()->exists();
}
```

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

### NotificationCenterTab class definition

Source: https://github.com/prodstarter/filament-notification-center

Final immutable value object representing a single rendered tab in the drawer. Constructor accepts id, label, icon, color, and count; all properties are public readonly.

```php
final class NotificationCenterTab
{
    public function __construct(
        public readonly string $id,
        public readonly string | Htmlable $label,
        public readonly string | BackedEnum | Htmlable | null $icon,
        public readonly string | array | null $color,
        public readonly int $count,
    ) {}
}
```

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

### scopeQueryToCategory method

Source: https://github.com/prodstarter/filament-notification-center

Scopes the notification query to a category by filtering the data->viewData->category JSON column. For the default category, it matches null or the default id; for other ids, it matches the exact category.

```php
protected function scopeQueryToCategory(Builder | Relation $query, string $categoryId): Builder | Relation
{
    if ($categoryId === $this->getCategoryRegistry()->getDefaultCategory()) {
        return $query->where(function (Builder | Relation $query) use ($categoryId) {
            $query->whereNull('data->viewData->category')
                ->orWhere('data->viewData->category', $categoryId);
        });
    }

    return $query->where('data->viewData->category', $categoryId);
}
```

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

### Define Enum with Filament Contracts

Source: https://github.com/prodstarter/filament-notification-center/blob/main/README.md

Define a BackedEnum implementing HasColor, HasIcon, and HasLabel so the tab's label, icon, and color are read directly from the enum, eliminating the need for a separate NotificationCenterCategory.

```php
use Filament\Support\Contracts\HasColor;
use Filament\Support\Contracts\HasIcon;
use Filament\Support\Contracts\HasLabel;

enum NotificationCategory: string implements HasColor, HasIcon, HasLabel
{
    case Orders = 'orders';
    case Crm = 'crm';

    public function getLabel(): string
    {
        return match ($this) {
            self::Orders => 'Orders',
            self::Crm => 'CRM',
        };
    }

    public function getIcon(): string
    {
        return match ($this) {
            self::Orders => 'heroicon-o-shopping-bag',
            self::Crm => 'heroicon-o-users',
        };
    }

    public function getColor(): string
    {
        return match ($this) {
            self::Orders => 'amber',
            self::Crm => 'info',
        };
    }
}
```

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

### hasAnyNotifications(): bool

Source: https://github.com/prodstarter/filament-notification-center

Returns whether the base query has any notifications at all, regardless of category. This method is useful for checking if there are any notifications to display.

```APIDOC
## hasAnyNotifications(): bool

### Description
Returns whether the base query has any notifications at all (regardless of category).

### Method
hasAnyNotifications

### Returns
`bool`

### Source
`src/Livewire/NotificationCenter.php:103`

### Example
```php
public function hasAnyNotifications(): bool
{
    return $this->getBaseNotificationsQuery()->exists();
}
```
```

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

### Basic usage of categories()

Source: https://github.com/prodstarter/filament-notification-center

Creates a FilamentNotificationCenter instance and registers two categories with labels and order values.

```php
use Prodstarter\FilamentNotificationCenter\FilamentNotificationCenter;
use Prodstarter\FilamentNotificationCenter\NotificationCenterCategory;

$center = new FilamentNotificationCenter;

$center->categories([
    NotificationCenterCategory::make('orders')->label('Orders')->order(1),
    NotificationCenterCategory::make('crm')->label('CRM')->order(2),
]);
```

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

### getCategoryEmptyState(string $categoryId): array

Source: https://github.com/prodstarter/filament-notification-center

Returns the empty-state heading and description for a given category, delegating to the category registry. This method is useful for displaying a custom empty state message for each notification category.

```APIDOC
## getCategoryEmptyState(string $categoryId): array

### Description
Returns the empty-state heading/description for the given category, delegating to the category registry.

### Method
getCategoryEmptyState

### Parameters
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `$categoryId` | `string` | yes | — | Category id, or the active category id. |

### Returns
`array{heading: string, description: string}`

### Source
`src/Livewire/NotificationCenter.php:111`

### Example (basic)
```php
$state = $component->getCategoryEmptyState('orders');
// ['heading' => 'No notifications yet.', 'description' => "You're all caught up."]
```
```

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

### Read categories globally

Source: https://github.com/prodstarter/filament-notification-center

Retrieves all categories, a specific category by ID, and the default category. The default category is 'general' by default.

```php
use Prodstarter\FilamentNotificationCenter\Facades\FilamentNotificationCenter;

$allCategories = FilamentNotificationCenter::getCategories();
$orders        = FilamentNotificationCenter::getCategory('orders');
$default       = FilamentNotificationCenter::getDefaultCategory(); // 'general' by default
```

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

### Public static properties $name and $viewNamespace

Source: https://github.com/prodstarter/filament-notification-center

Defines the package name and view namespace used by the package-tools framework. Both default to 'filament-notification-center'.

```php
public static string $name = 'filament-notification-center';

public static string $viewNamespace = 'filament-notification-center';
```

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

### getLabel() basic usage

Source: https://github.com/prodstarter/filament-notification-center

Creates a category with id 'customer_support' and echoes its label, which evaluates to 'Customer Support'.

```php
$category = NotificationCenterCategory::make('customer_support');
echo $category->getLabel(); // 'Customer Support'
```

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

### Set tab icon with icon()

Source: https://github.com/prodstarter/filament-notification-center

Sets the tab icon. Returns static for chaining.

```php
public function icon(string | BackedEnum | Htmlable | Closure | null $icon): static
```

```php
$category->icon('heroicon-o-shopping-bag');
```

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

### getEmptyState method implementation

Source: https://github.com/prodstarter/filament-notification-center

Returns the empty state for a category. Uses a custom callback if registered, otherwise falls back to translation keys with defaults 'No notifications yet.' and 'You're all caught up.'.

```php
/**
 * @return array{heading: string, description: string}
 */
public function getEmptyState(string $categoryId): array
{
    if ($this->emptyStateUsing) {
        return ($this->emptyStateUsing)($categoryId);
    }

    return [
        'heading' => __('filament-notification-center::notification-center.empty.heading'),
        'description' => __('filament-notification-center::notification-center.empty.description'),
    ];
}
```

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

### order() basic usage

Source: https://github.com/prodstarter/filament-notification-center

Sets the sort order to 2 for a category instance.

```php
$category->order(2);
```

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

### Customize global empty state

Source: https://github.com/prodstarter/filament-notification-center

Sets a custom empty state callback for all categories. The callback receives the category ID and returns an array with heading and description.

```php
NotificationCenter::emptyStateUsing(fn (string $categoryId): array => [
    'heading' => "Nothing here yet",
    'description' => "You're all caught up in {$categoryId}.",
]);
```

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

### Blade view: wire:click for setActiveCategory

Source: https://github.com/prodstarter/filament-notification-center

Blade view wiring each tab item to the setActiveCategory method. Uses Filament's tabs.item component with active state, icon, badge, and wire:click.

```blade
<x-filament::tabs.item
    :active="$activeCategory === $tab->id"
    :icon="$tab->icon"
    :badge="$tab->count > 0 ? $tab->count : null"
    wire:click="setActiveCategory('{{ $tab->id }}')"
    wire:key="notification-center-tab-{{ $tab->id }}"
>
    {{ $tab->label }}
</x-filament::tabs.item>
```

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

### Public state property: activeCategory

Source: https://github.com/prodstarter/filament-notification-center

Holds the id of the currently selected tab. Defaults to 'all' (the synthetic 'All' tab). Persisted across requests as Livewire state.

```php
public string $activeCategory = 'all';
```

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

### order() method signature

Source: https://github.com/prodstarter/filament-notification-center

Declares the order() method that sets the sort order. Categories are sorted ascending by this value, defaulting to 0 if never set.

```php
public function order(int | Closure $order): static
```

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

### TestsFilamentNotificationCenter class skeleton

Source: https://github.com/prodstarter/filament-notification-center

Mixin class that adds assertion helpers to Livewire's Testable class. Applied globally via Testable::mixin() in the service provider's packageBooted().

```php
namespace Prodstarter\FilamentNotificationCenter\Testing;

use Closure;
use Livewire\Features\SupportTesting\Testable;
use PHPUnit\Framework\Assert;
use Prodstarter\FilamentNotificationCenter\Livewire\NotificationCenter;

/**
 * @mixin Testable
 */
class TestsFilamentNotificationCenter
{
    public function assertActiveNotificationCategory(): Closure
    public function assertNotificationCategoryTabCount(): Closure
}
```

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

### Customize Default Category and Empty States

Source: https://github.com/prodstarter/filament-notification-center/blob/main/README.md

Override the default category for uncategorized notifications and customize the empty-state heading and description per category using ->defaultCategory() and ->emptyStateUsing().

```php
FilamentNotificationCenterPlugin::make()
    ->categories([...])
    ->defaultCategory('general') // where uncategorized notifications land
    ->emptyStateUsing(fn (string $categoryId): array => [
        'heading' => "Nothing here yet",
        'description' => "You're all caught up in {$categoryId}.",
    ]);
```

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

### getCategories() method implementation

Source: https://github.com/prodstarter/filament-notification-center

Merges explicitly registered categories with config-enabled built-in categories, rejects duplicates, sorts by getOrder() ascending, then re-keys by id.

```php
/**
 * @return Collection<string, NotificationCenterCategory>
 */
public function getCategories(): Collection
{
    $categories = $this->categories ?? collect();

    $builtIn = $this->getBuiltInCategories()->reject(
        fn (NotificationCenterCategory $category): bool => $categories->has($category->getId())
    );

    return $categories->merge($builtIn)
        ->sortBy(fn (NotificationCenterCategory $category): int => $category->getOrder())
        ->values()
        ->keyBy(fn (NotificationCenterCategory $category): string => $category->getId());
}
```

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

### Constructor: defaultCategory from config

Source: https://github.com/prodstarter/filament-notification-center

Seeds the plugin's private registry with the default category from config, falling back to 'general'.

```php
public function __construct()
{
    $this->categoryRegistry = (new FilamentNotificationCenter)
        ->defaultCategory(config('notification-center.default_category', 'general'));
}
```

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

### register(Panel $panel): void

Source: https://github.com/prodstarter/filament-notification-center

Registers the plugin's Livewire component as the panel's database-notifications component, replacing Filament's built-in drawer. Required by the Plugin contract.

```php
public function register(Panel $panel): void
{
    $panel->databaseNotificationsLivewireComponent(NotificationCenter::class);
}
```

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

### emptyStateUsing method implementation

Source: https://github.com/prodstarter/filament-notification-center

Registers a callback that produces the empty state (heading + description) for a given category id. Used when a tab is active but has no notifications.

```php
/**
 * @param  Closure(string $categoryId): array{heading: string, description: string}  $callback
 */
public function emptyStateUsing(Closure $callback): static
{
    $this->emptyStateUsing = $callback;

    return $this;
}
```

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

### render(): View

Source: https://github.com/prodstarter/filament-notification-center

Renders the `filament-notification-center::livewire.notification-center` Blade view. This method is responsible for outputting the notification center component's HTML.

```APIDOC
## render(): View

### Description
Renders the `filament-notification-center::livewire.notification-center` Blade view.

### Method
render

### Returns
`Illuminate\Contracts\View\View`

### Source
`src/Livewire/NotificationCenter.php:116`

### Example
```php
public function render(): View
{
    return view('filament-notification-center::livewire.notification-center');
}
```
```

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

### Send a Categorized Notification

Source: https://github.com/prodstarter/filament-notification-center/blob/main/README.md

Send a notification with a category by adding ->category() to the chain. Notifications without a category automatically appear under the 'General' tab.

```php
use Filament\Notifications\Notification;

Notification::make()
    ->title('New order #1042 received')
    ->icon('heroicon-o-shopping-bag')
    ->color('warning')
    ->category('orders')
    ->sendToDatabase($user);
```

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

### fromEnum(BackedEnum $case): static

Source: https://github.com/prodstarter/filament-notification-center

Builds a NotificationCenterCategory from a BackedEnum case. The id is the enum's value cast to string, and if the enum implements Filament's HasLabel, HasIcon, or HasColor contracts, the corresponding label, icon, or color are read directly from the enum.

```APIDOC
## fromEnum(BackedEnum $case): static

### Description
Builds a category from a `BackedEnum` case. The id is the enum's `value` cast to string. If the case implements Filament's `HasLabel`, `HasIcon`, and/or `HasColor` contracts, the corresponding label/icon/color are read directly from the enum — no `NotificationCenterCategory` definition is needed.

### Method
Static factory method

### Signature
```php
public static function fromEnum(BackedEnum $case): static
```

### Parameters
- `$case` (BackedEnum) - Required - A backed enum case.

### Returns
- `static` - The derived category.

### Example (basic, contract-implementing enum)
```php
use App\Enums\NotificationCategory;

$category = NotificationCenterCategory::fromEnum(NotificationCategory::Orders);

$category->getId();    // 'orders'
$category->getLabel(); // from getLabel()
$category->getIcon();  // from getIcon() or null
$category->getColor(); // from getColor() or null
```
```

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

### Use Enum in Plugin and Notification

Source: https://github.com/prodstarter/filament-notification-center/blob/main/README.md

Pass enum cases directly to the plugin's categories and use the enum in the notification's ->category() method. This works because the enum implements the required contracts.

```php
FilamentNotificationCenterPlugin::make()->categories([
    NotificationCategory::Orders,
    NotificationCategory::Crm,
]);

Notification::make()
    ->title('New order #1042 received')
    ->category(NotificationCategory::Orders)
    ->sendToDatabase($user);
```

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

### Static factory: make(string $id): static

Source: https://github.com/prodstarter/filament-notification-center

Creates a new category instance with the given id. Returns a static instance.

```php
public static function make(string $id): static
{
    return new static($id);
}
```

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

### icon(string | BackedEnum | Htmlable | Closure | null $icon): static

Source: https://github.com/prodstarter/filament-notification-center

Sets the tab icon. Returns static for chaining.

```APIDOC
## icon(string | BackedEnum | Htmlable | Closure | null $icon): static

### Description
Sets the tab icon.

### Method
icon

### Parameters
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `$icon` | `string \| BackedEnum \| Htmlable \| Closure \| null` | yes | — | Icon (e.g. a heroicon name string or enum). |

### Returns
`static` — for chaining.

### Request Example
```php
$category->icon('heroicon-o-shopping-bag');
```
```

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

### Register categories globally

Source: https://github.com/prodstarter/filament-notification-center

Registers categories globally for every panel that has no categories of its own. Populates the shared singleton, which panel-less plugins fall back to via FilamentNotificationCenterPlugin::getCategoryRegistry().

```php
use NotificationCenter;

NotificationCenter::categories([
    NotificationCenterCategory::make('system')->label('System')->order(1),
    NotificationCenterCategory::make('orders')->label('Orders')->order(2),
]);
```

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

### fromEnum() implementation in NotificationCenterCategory

Source: https://github.com/prodstarter/filament-notification-center

Static factory that builds a category from a BackedEnum case. The id is the enum's value cast to string. If the case implements Filament's HasLabel, HasIcon, and/or HasColor contracts, the corresponding label/icon/color are read directly from the enum.

```php
public static function fromEnum(BackedEnum $case): static
{
    $category = static::make((string) $case->value);

    if ($case instanceof HasLabel) {
        $category->label($case->getLabel());
    }

    if ($case instanceof HasIcon) {
        $category->icon($case->getIcon());
    }

    if ($case instanceof HasColor) {
        $category->color($case->getColor());
    }

    return $category;
}
```

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

### packageRegistered(): void

Source: https://github.com/prodstarter/filament-notification-center

Registers the FilamentNotificationCenter singleton bound to a new instance seeded with defaultCategory from config.

```APIDOC
## packageRegistered(): void

### Description
Registers the `FilamentNotificationCenter` singleton bound to a new instance seeded with `defaultCategory` from config.

### Method
`packageRegistered`

### Signature
```php
public function packageRegistered(): void
```

### Returns
`void`

### Source
`src/FilamentNotificationCenterServiceProvider.php:53`
```

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

### Constructor: __construct(string $id)

Source: https://github.com/prodstarter/filament-notification-center

Final constructor that sets the category id. Use NotificationCenterCategory::make($id) instead of direct new.

```php
final public function __construct(string $id)
{
    $this->id = $id;
}
```

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

### Set tab badge color with color()

Source: https://github.com/prodstarter/filament-notification-center

Sets the tab badge color. Accepts a color name (e.g. 'amber', 'info') or RGB array. Returns static for chaining.

```php
public function color(string | array | Closure | null $color): static
```

```php
$category->color(Color::Amber); // or 'amber' / Color::rgb([239, 68, 68])
```

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

### packageRegistered(): void - Register FilamentNotificationCenter singleton

Source: https://github.com/prodstarter/filament-notification-center

Registers the FilamentNotificationCenter singleton bound to a new instance seeded with defaultCategory from config. Returns void.

```php
public function packageRegistered(): void
{
    $this->app->singleton(FilamentNotificationCenter::class, fn () => (new FilamentNotificationCenter)
        ->defaultCategory(config('notification-center.default_category', 'general')));
}
```

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

### getEmptyState(string $categoryId): array

Source: https://github.com/prodstarter/filament-notification-center

Produces the empty state for a category. Uses the custom callback if registered, otherwise the translation keys `filament-notification-center::notification-center.empty.heading` / `.description` (defaults: `No notifications yet.` / `You're all caught up.`).

```APIDOC
## getEmptyState(string $categoryId): array

### Description
Produces the empty state for a category. Uses the custom callback if registered, otherwise the translation keys `filament-notification-center::notification-center.empty.heading` / `.description` (defaults: `No notifications yet.` / `You're all caught up.`).

### Method
`getEmptyState`

### Parameters
#### Parameters
- **$categoryId** (string) - Required - Category id passed to the custom callback.

### Returns
`array{heading: string, description: string}`

### Request Example
```php
$state = $center->getEmptyState('orders');
// ['heading' => 'No notifications yet.', 'description' => "You're all caught up."]
```

### Request Example (custom callback)
```php
$center->emptyStateUsing(fn (string $categoryId): array => [
    'heading' => "Empty in {$categoryId}",
    'description' => 'Custom description',
]);

$center->getEmptyState('orders'); // ['heading' => 'Empty in orders', 'description' => 'Custom description']
```
```

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

### categories() method implementation

Source: https://github.com/prodstarter/filament-notification-center

Registers categories from an array of NotificationCenterCategory instances and/or BackedEnum cases. BackedEnum cases are converted via NotificationCenterCategory::fromEnum(). Already-registered categories are replaced because the collection is re-keyed by id. Returns the manager instance for chaining.

```php
/**
 * @param  array<NotificationCenterCategory | BackedEnum>  $categories
 */
public function categories(array $categories): static
{
    $this->categories = collect($categories)
        ->map(fn (NotificationCenterCategory | BackedEnum $category): NotificationCenterCategory => $category instanceof BackedEnum
            ? NotificationCenterCategory::fromEnum($category)
            : $category)
        ->keyBy(fn (NotificationCenterCategory $category): string => $category->getId());

    return $this;
}
```

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

### categoryTabs

Source: https://github.com/prodstarter/filament-notification-center

Public computed property on the Livewire component returning the list of category tabs. This is part of the interactive surface of the notification drawer.

```APIDOC
## categoryTabs

### Description
Computed property returning the available category tabs.

### Type
array

### Usage
Accessible as a public property on the Livewire component.
```

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

### getCategory method implementation

Source: https://github.com/prodstarter/filament-notification-center

Returns a single category by id, or null if not present. Delegates to getCategories(), so built-in categories are included.

```php
public function getCategory(string $id): ?NotificationCenterCategory
{
    return $this->getCategories()->get($id);
}
```
Tokens:
Raw