Filament Notification Bell

https://github.com/benriadh1/filament-notification-bell
Admin
A real-time notification bell for Filament v5, powered by Laravel Reverb and Livewire v4, that...
Tokens:39,489
Snippets:309
Trust Score:4
License:MIT
Update:3 days ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Install the package using Composer.

```bash
composer require benriadh1/filament-notification-bell
```

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

### Global exposure of setup and teardown

Source: https://github.com/benriadh1/filament-notification-bell

Attaches setupNotificationBell and teardownNotificationBell to window.FilamentNotificationBell for inline script contexts.

```js
window.FilamentNotificationBell = {
    setup: setupNotificationBell,
    teardown: teardownNotificationBell,
};
```

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

### Usage example with NotificationBell facade

Source: https://github.com/benriadh1/filament-notification-bell

Shows how to use the NotificationBell facade, but notes that the send() method is not implemented in the package source. The call is commented out because it would fail without a binding.

```php
use Benriadh1\FilamentNotificationBell\Facades\NotificationBell;

// Only valid if the accessor is bound; the @method docblock declares this
// signature but no implementation of send() exists in the package source.
// NotificationBell::send($userId);
```

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

### Add a New Language File

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Create a new language file at resources/lang/vendor/filament-notification-bell/{locale}/notification-bell.php. The example shows a French file but the comment incorrectly says 'it'.

```php
// resources/lang/vendor/filament-notification-bell/it/notification-bell.php
return [
    'title'            => 'Notification',
    'mark_all_read'    => '',
    // ... all keys
];
```

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

### window.FilamentNotificationBell

Source: https://github.com/benriadh1/filament-notification-bell

Global object exposing `setup` and `teardown` methods for the notification bell. It is part of the JavaScript API for the Filament Notification Bell package.

```APIDOC
## window.FilamentNotificationBell

### Description
Global object with `setup` and `teardown` methods for the notification bell.

### Methods
- **setup** - Sets up the notification bell.
- **teardown** - Tears down the notification bell.

### Usage
Access via `window.FilamentNotificationBell`.
```

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

### Notification class with toDatabase payload

Source: https://github.com/benriadh1/filament-notification-bell

Example notification class implementing toDatabase to return a payload with title, body, url, and type. The type comment shows allowed values including 'success'.

```php
use Illuminate\Notifications\Notification;

class OrderShipped extends Notification
{
    public function via($notifiable): array
    {
        return ['database'];
    }

    public function toDatabase($notifiable): array
    {
        return [
            'title' => 'Order Shipped',
            'body'  => 'Your order #1234 has been shipped.',
            'url'   => route('orders.show', 1234),
            'type'  => 'success', // 'info' | 'success' | 'warning' | 'error'
        ];
    }
}
```

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

### Publish and run the migration

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Publish the migration files and run them to create the necessary database tables.

```bash
php artisan vendor:publish --tag="filament-notification-bell-migrations"
php artisan migrate
```

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

### mount() method: initialize component state

Source: https://github.com/benriadh1/filament-notification-bell

Sets $userId from auth()->id() (cast to int; guests become 0), applies the forced locale if set, and seeds $unreadCount from the unread-notifications count. No parameters.

```php
public function mount(): void
{
    $this->userId = (int) auth()->id();

    if ($this->locale) {
        app()->setLocale($this->locale);
    }

    $this->unreadCount = $this->fetchUnreadCount();
}
```

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

### Publish and override full config file

Source: https://github.com/benriadh1/filament-notification-bell

Publishes the package config file and runs migrations. The published file includes keys like 'limit', 'reverb', 'channel_type', 'polling', 'poll_interval', 'model', 'date_format', 'locale', 'rtl_locales', 'force_rtl', and 'theme'. Note that 'model', 'locale', 'channel_type', 'reverb', and 'theme' are not read by any code path in src/ or resources/.

```php
// config/filament-notification-bell.php (published)
return [
    'limit'         => 15,
    'reverb'        => true,
    'channel_type'  => 'private',
    'polling'       => true,
    'poll_interval' => 45,
    'model'         => App\Models\CustomNotification::class,
    'date_format'   => 'datetime',
    'locale'        => 'fr',
    'rtl_locales'   => ['ar', 'fa', 'he', 'ur', 'ug'],
    'force_rtl'     => false,
    'theme'         => 'auto',
];
```

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

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

### Configure plugin at registration time

Source: https://github.com/benriadh1/filament-notification-bell

Equivalent to the config file, but set via the plugin's fluent methods. The 'withPolling(45)' sets polling to true and pollInterval to 45. The 'limit()' method flows into rendering, unlike the config key alone.

```php
use Benriadh1\FilamentNotificationBell\FilamentNotificationBellPlugin;

public function panel(Panel $panel): Panel
{
    return $panel->plugin(
        FilamentNotificationBellPlugin::make()
            ->limit(15)
            ->withPolling(45)     // polling = true, pollInterval = 45
            ->slideOver()
            ->locale('fr')
            ->autoTheme()
    );
}
```

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

### useReverb() / usePusher()

Source: https://github.com/benriadh1/filament-notification-bell

Selects the broadcast driver for real-time notifications. Returns the plugin instance for chaining.

```APIDOC
## useReverb() / usePusher()

### Description
Selects the broadcast driver for real-time notifications. Returns the plugin instance for chaining.

### Method
Fluent method

### Parameters
None

### Returns
`static` - The plugin instance for chaining

### Default
`true` (using Reverb)
```

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

### Getters

Source: https://github.com/benriadh1/filament-notification-bell

Retrieve the current value of each configuration option.

```APIDOC
## Getters

### Description
Retrieve the current value of each configuration option.

### Methods
- `getLimit()` - Returns the per-page limit (int)
- `getPanelMode()` - Returns the panel mode (string)
- `getForcedLocale()` - Returns the forced locale (?string)
- `isForceRtl()` - Returns whether RTL is forced (bool)
- `getTheme()` - Returns the theme (string)
- `isPolling()` - Returns whether polling is enabled (bool)
- `getPollInterval()` - Returns the poll interval (int)
- `isUsingReverb()` - Returns whether Reverb is used (bool)
```

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

### lightMode() / darkMode() / autoTheme()

Source: https://github.com/benriadh1/filament-notification-bell

Sets the theme mode for the notification panel. Returns the plugin instance for chaining.

```APIDOC
## lightMode() / darkMode() / autoTheme()

### Description
Sets the theme mode for the notification panel. Returns the plugin instance for chaining.

### Method
Fluent method

### Parameters
None

### Returns
`static` - The plugin instance for chaining

### Default
`'auto'`
```

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

### setupNotificationBell(userId)

Source: https://github.com/benriadh1/filament-notification-bell

Initializes the notification bell's Echo listener for the given user ID. This function is exported from the module and is also exposed globally as window.FilamentNotificationBell.setup.

```APIDOC
## setupNotificationBell(userId)

### Description
Initializes the notification bell's Echo listener for the given user ID. This function is exported from the module and is also exposed globally as `window.FilamentNotificationBell.setup`.

### Method
Function call

### Parameters
- **userId** (number) - Required - The ID of the user to listen for notifications.

### Usage Example
```js
import { setupNotificationBell } from './vendor/filament-notification-bell/echo-listener';
const userId = Number(document.querySelector('meta[name="user-id"]')?.content) || 0;
setupNotificationBell(userId);
```

### Notes
- If Echo is not yet configured, the module logs a console.warn and returns without throwing an exception.
```

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

### Fluent Plugin API Configuration

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Configure the plugin fluently with options like limit, slideOver, polling, locale, RTL, theme, and broadcasting driver.

```php
FilamentNotificationBellPlugin::make()
    ->limit(30)
    ->slideOver()              // or ->dropdown() (default)
    ->withPolling(60)          // enable polling every 60 seconds
    ->locale('fr')             // force French locale
    ->rtl()                    // force RTL layout
    ->lightMode()              // or ->darkMode() or ->autoTheme() (default)
    ->usePusher()              // or ->useReverb() (default)
```

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

### boot(Panel $panel)

Source: https://github.com/benriadh1/filament-notification-bell

Boots the plugin with the given Filament panel. This is a no-op implementation required by the Plugin contract.

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

### Description
Boots the plugin with the given Filament panel. This is a no-op implementation required by the Plugin contract.

### Method
boot

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

### Response
#### Success Response
- Returns `void`.
```

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

### Error-tolerant pattern

Source: https://github.com/benriadh1/filament-notification-bell

Shows that setupNotificationBell never throws; if Echo is not configured, it logs a console.warn and returns, so no try/catch is needed.

```js
import { setupNotificationBell } from './vendor/filament-notification-bell/echo-listener';

// Echo not yet configured → module logs a console.warn and returns;
// no exception is thrown, so no try/catch is required.
setupNotificationBell(1);
```

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

### Programmatic interaction via Livewire test

Source: https://github.com/benriadh1/filament-notification-bell

Uses Livewire::test to instantiate the component with dark theme and limit 5, then calls actions like markAllRead, loadMore, and markRead with a notification ID.

```php
use Livewire\Livewire;
use Benriadh1\FilamentNotificationBell\Livewire\NotificationBell;

$component = Livewire::test(NotificationBell::class, ['theme' => 'dark', 'limit' => 5]);

// Actions are invoked the same way the blade wire:click bindings call them
$component->call('markAllRead');
$component->call('loadMore');       // page 1 -> 2
$component->call('markRead', $notificationId);
```

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

### Publish Lang Files Command

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Publish the plugin's language files to override translations.

```bash
php artisan vendor:publish --tag="filament-notification-bell-lang"
```

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

### boot() method registering views, translations, and Livewire component

Source: https://github.com/benriadh1/filament-notification-bell

Registers views, translations, and a Livewire component unconditionally. Views are available under the 'filament-notification-bell' namespace, translations in 6 locales, and the component is mountable via @livewire.

```php
public function boot(): void
{
    $this->loadViewsFrom(__DIR__ . '/../resources/views', 'filament-notification-bell');

    $this->loadTranslationsFrom(__DIR__ . '/../resources/lang', 'filament-notification-bell');

    Livewire::component(
        'filament-notification-bell.notification-bell',
        NotificationBell::class
    );

    if ($this->app->runningInConsole()) {
        // ... publishes (see table below)
    }
}
```

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

### Auto Theme (Default)

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Use auto theme (default) which respects the Filament panel's dark mode setting.

```php
FilamentNotificationBellPlugin::make()->autoTheme()
```

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

### Register the plugin in your Filament panel

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Add the plugin to your Filament panel provider (e.g., app/Providers/Filament/AdminPanelProvider.php).

```php
use Benriadh1\FilamentNotificationBell\FilamentNotificationBellPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        // ... your other panel config
        ->plugin(FilamentNotificationBellPlugin::make());
}
```

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

### rtl()

Source: https://github.com/benriadh1/filament-notification-bell

Enables right-to-left layout for the notification panel. Returns the plugin instance for chaining.

```APIDOC
## rtl()

### Description
Enables right-to-left layout for the notification panel. Returns the plugin instance for chaining.

### Method
Fluent method

### Parameters
None

### Returns
`static` - The plugin instance for chaining

### Default
`false`
```

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

### Read config values in your own code

Source: https://github.com/benriadh1/filament-notification-bell

Shows how to retrieve config values. The 'limit' key defaults to 20, and 'rtl_locales' defaults to ['ar','fa','he','ur'] when not set.

```php
$limit = config('filament-notification-bell.limit');          // 20 default
$rtlLocales = config('filament-notification-bell.rtl_locales', []); // ['ar','fa','he','ur']
```

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

### setupNotificationBell(userId)

Source: https://github.com/benriadh1/filament-notification-bell

Sets up a Laravel Echo listener on the user's private channel to listen for NotificationSent broadcasts and dispatch a Livewire event to refresh the bell. Requires a valid user ID and initialized Echo instance.

```APIDOC
## setupNotificationBell(userId)

### Description
Sets up a Laravel Echo listener on the user's private channel to listen for NotificationSent broadcasts and dispatch a Livewire event to refresh the bell. Requires a valid user ID and initialized Echo instance.

### Parameters
- **userId** (number) - Required - The authenticated user's numeric ID (`auth()->id()`)

### Returns
`undefined` (`void`)

### Behavior
- If `userId` is falsy (0, `null`, `undefined`), logs a warning and returns early.
- If `window.Echo` is undefined, logs a warning and returns early.
- Subscribes to `window.Echo.private('App.Models.User.{userId}')` and listens for the `'.NotificationSent'` event.
- On each broadcast, dispatches the Livewire event `notification-bell-refresh`.
- Exceptions during subscription are caught and logged with `console.error` (does not rethrow).
```

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

### Publish the CSS asset

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Publish the CSS assets required for the notification bell.

```bash
php artisan vendor:publish --tag="filament-notification-bell-assets"
```

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

### render() method for Filament Notification Bell Livewire component

Source: https://github.com/benriadh1/filament-notification-bell

Returns the 'filament-notification-bell::livewire.notification-bell' view with computed notification data, unread count, load-more flag, hard-coded view-all URL, theme, panel mode, RTL flag, polling settings, and poll interval. Re-applies the forced locale before rendering.

```php
public function render(): View
{
    if ($this->locale) {
        app()->setLocale($this->locale);
    }

    return view('filament-notification-bell::livewire.notification-bell', [
        'notifications' => $this->notifications,
        'unreadCount'   => $this->unreadCount,
        'canLoadMore'   => $this->canLoadMore,
        'viewAllUrl'    => url('/admin'),
        'theme'         => $this->resolveTheme(),
        'panelMode'     => $this->panelMode,
        'rtl'           => $this->rtl,
        'polling'       => $this->polling,
        'pollInterval'  => $this->pollInterval,
    ]);
}
```

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

### Publish Views Command

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Publish the plugin's views to override them in your application. Views are copied to resources/views/vendor/filament-notification-bell/.

```bash
php artisan vendor:publish --tag="filament-notification-bell-views"
```

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

### ES module integration

Source: https://github.com/benriadh1/filament-notification-bell

Imports and calls setupNotificationBell with a user ID from a meta tag, then teardownNotificationBell on logout or SPA transition.

```js
import { setupNotificationBell, teardownNotificationBell } from './vendor/filament-notification-bell/echo-listener';

const userId = Number(document.querySelector('meta[name="user-id"]')?.content) || 0;
setupNotificationBell(userId);

// on logout / SPA page transition
teardownNotificationBell(userId);
```

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

### Publish everything with provider flag

Source: https://github.com/benriadh1/filament-notification-bell

Publish all groups at once by specifying the service provider class.

```bash
php artisan vendor:publish --provider="Benriadh1\FilamentNotificationBell\FilamentNotificationBellServiceProvider"
```

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

### refresh() method: Livewire Echo listener for NotificationSent

Source: https://github.com/benriadh1/filament-notification-bell

Listens on the private channel 'App.Models.User.{userId}' (interpolated from $userId) for broadcast events named 'NotificationSent'. Recomputes $unreadCount from the database.

```php
#[On('echo-private:App.Models.User.{userId},NotificationSent')]
public function refresh(): void
{
    $this->unreadCount = $this->fetchUnreadCount();
}
```

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

### Live event-driven refresh from front end

Source: https://github.com/benriadh1/filament-notification-bell

Sets up the Echo listener with the authenticated user ID. A broadcast NotificationSent on App.Models.User.{id} triggers the component's refresh() listener.

```javascript
import { setupNotificationBell } from './vendor/filament-notification-bell/echo-listener';
setupNotificationBell(window.__FILAMENT_AUTH_USER_ID__);

// a broadcast NotificationSent on App.Models.User.{id} will now
// trigger the component's refresh() listener (Livewire Echo binding)
```

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

### resolveTheme() method

Source: https://github.com/benriadh1/filament-notification-bell

Returns 'light', 'dark', or 'auto'. For 'auto', delegates to Filament's panel dark-mode setting: filament()->hasDarkModeForced() ? 'dark' : 'auto'.

```php
public function resolveTheme(): string
{
    if ($this->theme === 'light') {
        return 'light';
    }

    if ($this->theme === 'dark') {
        return 'dark';
    }

    // 'auto' — delegate to Filament's panel dark-mode class strategy
    return filament()->hasDarkModeForced() ? 'dark' : 'auto';
}
```

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

### Publish Filament Notification Bell config

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Run this Artisan command to publish the package configuration file. The published config can then be customized using the keys listed in the configuration reference table.

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

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

### make()

Source: https://github.com/benriadh1/filament-notification-bell

Resolves the plugin instance from the Laravel container. Returns a plugin instance ready for fluent configuration.

```APIDOC
## make()

### Description
Resolves the plugin from the Laravel container: `return app(static::class);`. Returns a plugin instance ready for fluent configuration.

### Method
`public static function make(): static`

### Parameters
No parameters.

### Returns
- `static` — a plugin instance ready for fluent configuration.

### Request Example
```php
use Benriadh1\FilamentNotificationBell\FilamentNotificationBellPlugin;

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

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

### setupNotificationBell(userId) - default export surface

Source: https://github.com/benriadh1/filament-notification-bell

Wires Laravel Echo to the Livewire bell by subscribing to the user's private channel and listening for the NotificationSent broadcast. Requires a numeric userId and an initialized window.Echo; otherwise it warns and returns early. On each broadcast, dispatches the Livewire event 'notification-bell-refresh'.

```javascript
export function setupNotificationBell(userId) {
    if (!userId) {
        console.warn('[filament-notification-bell] setupNotificationBell: no userId provided.');
        return;
    }

    if (typeof window.Echo === 'undefined') {
        console.warn(
            '[filament-notification-bell] Laravel Echo is not initialized. ' +
            'Make sure you have imported and configured Echo (with Reverb or Pusher) ' +
            'before calling setupNotificationBell().'
        );
        return;
    }

    try {
        window.Echo.private(`App.Models.User.${userId}`)
            .listen('.NotificationSent', (event) => {
                dispatchBellRefresh(event.userId ?? userId);
            });

        console.info(
            `[filament-notification-bell] Listening on private channel: App.Models.User.${userId}`
        );
    } catch (error) {
        console.error('[filament-notification-bell] Failed to set up Echo listener:', error);
    }
}
```

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

### Combining theme control and RTL, then inspecting state

Source: https://github.com/benriadh1/filament-notification-bell

Configures the plugin with Pusher, RTL, and auto theme, then uses getters to inspect state. The comment notes that getPanelMode returns 'dropdown' (default) and isUsingReverb returns false because usePusher was called.

```php
$plugin = FilamentNotificationBellPlugin::make()
    ->usePusher()
    ->rtl()
    ->autoTheme();

// Getters reflect the fluent configuration
if ($plugin->isForceRtl()) {
    // layout will render dir="rtl"
}
echo $plugin->getPanelMode(); // 'dropdown' (default)
echo $plugin->isUsingReverb(); // false (usePusher was called)
```

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

### Define a database notification class

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Create a notification class that sends a database notification with title, body, URL, and type fields.

```php
use Illuminate\Notifications\Notification;
use Illuminate\Notifications\Messages\DatabaseMessage;

class OrderShipped extends Notification
{
    public function via($notifiable): array
    {
        return ['database'];
    }

    public function toDatabase($notifiable): array
    {
        return [
            'title' => 'Order Shipped',
            'body'  => 'Your order #1234 has been shipped.',
            'url'   => route('orders.show', 1234),
            'type'  => 'success', // 'info' | 'success' | 'warning' | 'error'
        ];
    }
}
```

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

### Fluent Configuration Methods

Source: https://github.com/benriadh1/filament-notification-bell

Methods for configuring the plugin: limit, slideOver, darkMode, locale, withPolling, usePusher, rtl, autoTheme.

```APIDOC
## Fluent Configuration Methods

### Description
Methods for configuring the plugin: limit, slideOver, darkMode, locale, withPolling, usePusher, rtl, autoTheme.

### Method
GET

### Endpoint
`limit(int $limit)`, `slideOver()`, `darkMode()`, `locale(string $locale)`, `withPolling(int $seconds)`, `usePusher()`, `rtl()`, `autoTheme()`

### Parameters
#### Request Body
- **limit** (int) - Required - Page limit
- **locale** (string) - Required - Locale code
- **withPolling** (int) - Required - Poll interval in seconds

### Response
#### Success Response
- **FilamentNotificationBellPlugin** - The plugin instance for chaining

### Request Example
```php
use Benriadh1\FilamentNotificationBell\FilamentNotificationBellPlugin;

public function panel(Panel $panel): Panel
{
    return $panel->plugin(
        FilamentNotificationBellPlugin::make()
            ->limit(15)
            ->slideOver()
            ->darkMode()
            ->locale('fr')
            ->withPolling(45)
    );
}
```

### Response Example
```php
$plugin = FilamentNotificationBellPlugin::make()
    ->usePusher()
    ->rtl()
    ->autoTheme();

// Getters reflect the fluent configuration
if ($plugin->isForceRtl()) {
    // layout will render dir="rtl"
}
echo $plugin->getPanelMode(); // 'dropdown' (default)
echo $plugin->isUsingReverb(); // false (usePusher was called)
```
```

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

### make() usage in panel configuration

Source: https://github.com/benriadh1/filament-notification-bell

Registers the plugin on a Filament panel using the make() method.

```php
use Benriadh1\FilamentNotificationBell\FilamentNotificationBellPlugin;

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

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

### slideOver() / dropdown()

Source: https://github.com/benriadh1/filament-notification-bell

Sets the panel mode to slide-over or dropdown. Returns the plugin instance for chaining.

```APIDOC
## slideOver() / dropdown()

### Description
Sets the panel mode to slide-over or dropdown. Returns the plugin instance for chaining.

### Method
Fluent method

### Parameters
None

### Returns
`static` - The plugin instance for chaining

### Default
`'dropdown'`
```

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

### Inline Blade usage

Source: https://github.com/benriadh1/filament-notification-bell

Calls window.FilamentNotificationBell.setup with the authenticated user ID inside a DOMContentLoaded listener.

```blade
<script>
    document.addEventListener('DOMContentLoaded', () => {
        window.FilamentNotificationBell.setup({{ auth()->id() }});
    });
</script>
```

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

### setupNotificationBell(userId)

Source: https://github.com/benriadh1/filament-notification-bell

Exported ES module function that sets up the notification bell listener for a given user. It is part of the JavaScript API for the Filament Notification Bell package.

```APIDOC
## setupNotificationBell(userId)

### Description
Sets up the notification bell for the specified user.

### Parameters
- **userId** (string) - Required - The user identifier to set up notifications for.

### Returns
No return value documented.
```

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

### Force Light Mode

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Force the bell to use light mode regardless of the panel setting.

```php
FilamentNotificationBellPlugin::make()->lightMode()
```

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

### Server-side channel authorization (routes/channels.php)

Source: https://github.com/benriadh1/filament-notification-bell

Configures authorization for the private channel 'App.Models.User.{id}' in routes/channels.php. The exact channel string must match 'App.Models.User.{id}'.

```php
use Illuminate\Support\Facades\Broadcast;

Broadcast::channel('App.Models.User.{id}', function ($user, $id) {
    return (int) $user->id === (int) $id;
});
```

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

### broadcastOn() method

Source: https://github.com/benriadh1/filament-notification-bell

Returns a single PrivateChannel named App.Models.User.{userId} (e.g. App.Models.User.42). Because it is a private channel, presence on it requires channel authorization; authorization for App.Models.User.{id} must be configured in routes/channels.php if it is not already.

```php
public function broadcastOn(): Channel|array
{
    return new PrivateChannel("App.Models.User.{$this->userId}");
}
```

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

### broadcastAs() method

Source: https://github.com/benriadh1/filament-notification-bell

Returns 'NotificationSent' — the broadcast event name. Consumers must listen for the prefixed form '.NotificationSent' (leading dot = no App\Events\ prefix), which is exactly what echo-listener.js does with .listen('.NotificationSent', ...) and what the Livewire component does with #[On('echo-private:App.Models.User.{userId},NotificationSent')].

```php
public function broadcastAs(): string
{
    return 'NotificationSent';
}
```

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

### make() method signature

Source: https://github.com/benriadh1/filament-notification-bell

Declares the static make() method that resolves the plugin from the Laravel container.

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

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

### RTL Support Configuration

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Add locales to the rtl_locales config or force RTL via the fluent API. RTL is automatically enabled for ar, fa, he, and ur.

```php
// In config/filament-notification-bell.php
'rtl_locales' => ['ar', 'fa', 'he', 'ur', 'ug'],

// Or via fluent plugin API
FilamentNotificationBellPlugin::make()->rtl()
```

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

### refreshFromEvent() method: plain Livewire event listener

Source: https://github.com/benriadh1/filament-notification-bell

Listens for the plain Livewire event 'notification-bell-refresh', dispatched by dispatchBellRefresh() in resources/js/echo-listener.js. Fallback path when the native Livewire Echo listener is not active. Recomputes $unreadCount.

```php
#[On('notification-bell-refresh')]
public function refreshFromEvent(): void
{
    $this->unreadCount = $this->fetchUnreadCount();
}
```

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

### Send the notification

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Send the notification to a user.

```php
$user->notify(new OrderShipped());
```

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

### loadMore method

Source: https://github.com/benriadh1/filament-notification-bell

Increments the page counter and busts the notifications() and canLoadMore() computed caches. The next render fetches up to limit * page notifications.

```php
public function loadMore(): void
{
    $this->page++;

    unset($this->notifications, $this->canLoadMore);
}
```

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

### Basic registration with fluent options

Source: https://github.com/benriadh1/filament-notification-bell

Registers the plugin in a Filament panel with fluent options: limit 15, slideOver, darkMode, locale 'fr', and polling every 45 seconds.

```php
use Benriadh1\FilamentNotificationBell\FilamentNotificationBellPlugin;

public function panel(Panel $panel): Panel
{
    return $panel->plugin(
        FilamentNotificationBellPlugin::make()
            ->limit(15)
            ->slideOver()
            ->darkMode()
            ->locale('fr')
            ->withPolling(45)
    );
}
```

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

### locale(string $locale)

Source: https://github.com/benriadh1/filament-notification-bell

Forces a specific locale for the notification component. Returns the plugin instance for chaining.

```APIDOC
## locale(string $locale)

### Description
Forces a specific locale for the notification component. Returns the plugin instance for chaining.

### Method
Fluent method

### Parameters
- **$locale** (string) - Required - The locale to force

### Returns
`static` - The plugin instance for chaining

### Default
`null`
```

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

### Manual dispatch

Source: https://github.com/benriadh1/filament-notification-bell

Shows two ways to manually dispatch the event: using the event() helper or the Dispatchable trait's static dispatch() method.

```php
use Benriadh1\FilamentNotificationBell\Events\NotificationSent;

event(new NotificationSent($user->id));

// or via the Dispatchable trait
NotificationSent::dispatch($user->id);
```

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

### getTheme()

Source: https://github.com/benriadh1/filament-notification-bell

Returns the theme setting: 'auto', 'light', or 'dark'.

```APIDOC
## getTheme()

### Description
Returns the theme setting: 'auto', 'light', or 'dark'.

### Method
GET

### Endpoint
`getTheme()`

### Response
#### Success Response
- **string** - 'auto', 'light', or 'dark'
```

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

### markAllRead method

Source: https://github.com/benriadh1/filament-notification-bell

Marks all unread notifications as read for the authenticated user via a single query, zeroes the unread count, and busts the computed cache. Silent no-op for guests.

```php
public function markAllRead(): void
{
    auth()->user()?->unreadNotifications()->update(['read_at' => now()]);

    $this->unreadCount = 0;

    unset($this->notifications);
}
```

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

### usePusher()

Source: https://github.com/benriadh1/filament-notification-bell

Sets `$usingReverb = false`. Same caveat as `useReverb()`.

```APIDOC
## usePusher()

### Description
Sets `$usingReverb = false`. Same caveat as `useReverb()`.

### Method
usePusher

### Parameters
None

### Response
#### Success Response
- Returns `static` for chaining.
```

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

### limit(int $limit)

Source: https://github.com/benriadh1/filament-notification-bell

Sets the maximum number of notifications displayed per page. Returns the plugin instance for chaining.

```APIDOC
## limit(int $limit)

### Description
Sets the maximum number of notifications displayed per page. Returns the plugin instance for chaining.

### Method
Fluent method

### Parameters
- **$limit** (int) - Required - Maximum notifications per page

### Returns
`static` - The plugin instance for chaining

### Default
`20`
```

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

### withPolling(int $seconds = 30)

Source: https://github.com/benriadh1/filament-notification-bell

Enables polling for automatic refresh of notifications. Returns the plugin instance for chaining.

```APIDOC
## withPolling(int $seconds = 30)

### Description
Enables polling for automatic refresh of notifications. Returns the plugin instance for chaining.

### Method
Fluent method

### Parameters
- **$seconds** (int) - Optional - Polling interval in seconds (default: 30)

### Returns
`static` - The plugin instance for chaining

### Default
`false` (polling disabled) / `30` (poll interval)
```

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

### Send notification and broadcast via notifyBell

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Send a notification and then call notifyBell() to broadcast the NotificationSent event via Reverb.

```php
$user->notify(new OrderShipped());
$user->notifyBell(); // broadcasts the NotificationSent event via Reverb
```

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

### Force Dark Mode

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Force the bell to use dark mode regardless of the panel setting.

```php
FilamentNotificationBellPlugin::make()->darkMode()
```

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

### Basic dispatch through the trait

Source: https://github.com/benriadh1/filament-notification-bell

Shows how to dispatch the event via the HasNotificationBell trait's notifyBell() method, which internally fires event(new NotificationSent($user->id)).

```php
$user->notify(new OrderShipped());
$user->notifyBell(); // internally: event(new NotificationSent($user->id));
```

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

### loadMore

Source: https://github.com/benriadh1/filament-notification-bell

Loads more notifications by incrementing the page counter. Triggered from the panel footer; re-renders with additional items.

```APIDOC
## loadMore

### Description
Loads more notifications by incrementing the page counter. Triggered from the panel footer; re-renders with additional items.

### Action
`loadMore()`

### Request Parameters
None

### Behavior
`page++`; busts `notifications()` and `canLoadMore()` caches; next render fetches `limit * page` rows (`->latest()->take($this->limit * $this->page)->get()`)

### Response Effect
Re-render with more items; `canLoadMore` recomputed

### Authentication
Requires authenticated user for data; guests render empty list

### Failures
None defined in source
```

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

### Publish individual groups with artisan vendor:publish

Source: https://github.com/benriadh1/filament-notification-bell

Publish specific groups (config, migrations, assets, lang, views) using their tags. All publish groups are gated behind runningInConsole().

```bash
php artisan vendor:publish --tag="filament-notification-bell-config"
php artisan vendor:publish --tag="filament-notification-bell-migrations"
php artisan vendor:publish --tag="filament-notification-bell-assets"
php artisan vendor:publish --tag="filament-notification-bell-lang"
php artisan vendor:publish --tag="filament-notification-bell-views"
```

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

### slideOver()

Source: https://github.com/benriadh1/filament-notification-bell

Renders the panel as a slide-over drawer (`fnb-slide`) with an overlay.

```APIDOC
## slideOver()

### Description
Renders the panel as a slide-over drawer (`fnb-slide`) with an overlay.

### Method
slideOver

### Parameters
None

### Response
#### Success Response
- Returns `static` for chaining.
```

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

### Migration: add read_at column with data comment

Source: https://github.com/benriadh1/filament-notification-bell

Defines the JSON data column and documents expected keys in a comment. The comment lists title, body, url, and type with their types and allowed values.

```php
$table->json('data')->comment(
    'Expected keys: title (string), body (string), url (string|null), type (info|success|warning|error)'
);
```

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

### NotificationBell facade class with getFacadeAccessor method

Source: https://github.com/benriadh1/filament-notification-bell

Defines the NotificationBell facade that proxies static calls to the container binding under the accessor key 'filament-notification-bell'. The @method annotation declares a send() method, but no implementation exists in the package source.

```php
<?php

/**
 * @method static void send(int $userId)
 *
 * @see \Benriadh1\FilamentNotificationBell\FilamentNotificationBellPlugin
 */
class NotificationBell extends Facade
{
    protected static function getFacadeAccessor(): string
    {
        return 'filament-notification-bell';
    }
}
```

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

### dropdown()

Source: https://github.com/benriadh1/filament-notification-bell

Sets the panel mode to 'dropdown'. This is the default mode.

```APIDOC
## dropdown()

### Description
Sets the panel mode to 'dropdown'. This is the default mode.

### Method
dropdown

### Parameters
None

### Response
#### Success Response
- Returns `static` for chaining.
```

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

### register() method merging package config

Source: https://github.com/benriadh1/filament-notification-bell

Merges the packaged config file into the app config under the key 'filament-notification-bell', providing defaults unless overridden by published config.

```php
public function register(): void
{
    $this->mergeConfigFrom(
        __DIR__ . '/../config/filament-notification-bell.php',
        'filament-notification-bell'
    );
}
```

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

### Basic usage: enable real-time bell updates

Source: https://github.com/benriadh1/filament-notification-bell

Shows how to use the trait in a User model and then notify the bell after sending a notification.

```php
use Benriadh1\FilamentNotificationBell\Concerns\HasNotificationBell;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use HasNotificationBell, Notifiable;
}
```

```php
$user->notify(new OrderShipped()); // persists to the notifications table
$user->notifyBell();               // broadcasts NotificationSent via Reverb/Pusher
```

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

### Add HasNotificationBell trait to User model

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Add the trait to enable real-time broadcasting.

```php
use Benriadh1\FilamentNotificationBell\Concerns\HasNotificationBell;

class User extends Authenticatable
{
    use HasNotificationBell;
}
```

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

### getLimit()

Source: https://github.com/benriadh1/filament-notification-bell

Returns the configured page limit for the notification bell.

```APIDOC
## getLimit()

### Description
Returns the configured page limit for the notification bell.

### Method
GET

### Endpoint
`getLimit()`

### Response
#### Success Response
- **int** - Configured page limit
```

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

### dispatchBellRefresh function

Source: https://github.com/benriadh1/filament-notification-bell

Internal function that dispatches the 'notification-bell-refresh' event with a userId payload via Livewire.dispatch(). Skipped silently if Livewire is not defined.

```js
function dispatchBellRefresh(userId) {
    if (typeof Livewire !== 'undefined') {
        Livewire.dispatch('notification-bell-refresh', { userId });
    }
}
```

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

### register(Panel $panel) method implementation

Source: https://github.com/benriadh1/filament-notification-bell

Registers the plugin on a panel by attaching a render hook at PanelsRenderHook::TOPBAR_END and passing plugin options to the view.

```php
public function register(Panel $panel): void
{
    $plugin = $this;

    $panel->renderHook(
        PanelsRenderHook::TOPBAR_END,
        fn (): View => view('filament-notification-bell::livewire.hook', [
            'panelMode'    => $plugin->panelMode,
            'locale'       => $plugin->forcedLocale,
            'rtl'          => $plugin->forceRtl,
            'theme'        => $plugin->theme,
            'limit'        => $plugin->limit,
            'polling'      => $plugin->polling,
            'pollInterval' => $plugin->pollInterval,
        ])
    );
}
```

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

### NotificationSent::__construct

Source: https://github.com/benriadh1/filament-notification-bell

Creates a new NotificationSent event instance. The constructor accepts the user ID whose notification bell must refresh.

```APIDOC
## NotificationSent::__construct

### Description
Creates a new NotificationSent event instance. The constructor accepts the user ID whose notification bell must refresh.

### Method
Constructor

### Signature
```php
public function __construct(public readonly int $userId)
```

### Parameters
- `$userId` (int) - Required - The authenticated user whose bell must refresh (`readonly` property promoted)

### Usage Example
```php
use Benriadh1\FilamentNotificationBell\Events\NotificationSent;

event(new NotificationSent($user->id));

// or via the Dispatchable trait
NotificationSent::dispatch($user->id);
```
```

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

### NotificationSent constructor

Source: https://github.com/benriadh1/filament-notification-bell

The constructor promotes a readonly int $userId parameter, which is exposed as $event->userId on the instance.

```php
public function __construct(public readonly int $userId)
```

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

### canLoadMore() computed property

Source: https://github.com/benriadh1/filament-notification-bell

Returns true when the user has more notifications than the current page window, false otherwise (including unauthenticated).

```php
#[Computed]
public function canLoadMore(): bool
{
    $user = auth()->user();

    if (! $user) {
        return false;
    }

    return $user->notifications()->count() > ($this->limit * $this->page);
}
```

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

### Manual registration in bootstrap/providers.php

Source: https://github.com/benriadh1/filament-notification-bell

Register the service provider manually in Laravel 11+ when auto-discovery is disabled.

```php
return [
    App\Providers\AppServiceProvider::class,
    Benriadh1\FilamentNotificationBell\FilamentNotificationBellServiceProvider::class,
];
```

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

### autoTheme()

Source: https://github.com/benriadh1/filament-notification-bell

Sets the theme to 'auto'. This is the default; `resolveTheme()` then returns `'dark'` when Filament reports `hasDarkModeForced()`, otherwise `'auto'`.

```APIDOC
## autoTheme()

### Description
Sets the theme to 'auto'. This is the default; `resolveTheme()` then returns `'dark'` when Filament reports `hasDarkModeForced()`, otherwise `'auto'`.

### Method
autoTheme

### Parameters
None

### Response
#### Success Response
- Returns `static` for chaining.
```

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

### getPanelMode()

Source: https://github.com/benriadh1/filament-notification-bell

Returns the panel mode, either 'dropdown' or 'slideOver'.

```APIDOC
## getPanelMode()

### Description
Returns the panel mode, either 'dropdown' or 'slideOver'.

### Method
GET

### Endpoint
`getPanelMode()`

### Response
#### Success Response
- **string** - 'dropdown' or 'slideOver'
```

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

### lightMode()

Source: https://github.com/benriadh1/filament-notification-bell

Sets the theme to 'light'. The Alpine expression on the root element then renders without the `dark` class.

```APIDOC
## lightMode()

### Description
Sets the theme to 'light'. The Alpine expression on the root element then renders without the `dark` class.

### Method
lightMode

### Parameters
None

### Response
#### Success Response
- Returns `static` for chaining.
```

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

### broadcastWith() method

Source: https://github.com/benriadh1/filament-notification-bell

Returns ['userId' => $this->userId] — the broadcast payload. Consumers receive this payload as the event object; echo-listener.js reads event.userId.

```php
public function broadcastWith(): array
{
    return ['userId' => $this->userId];
}
```

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

### NotificationSent class declaration

Source: https://github.com/benriadh1/filament-notification-bell

The only event in the package. Implements ShouldBroadcast, so dispatching it broadcasts over the configured broadcaster (Laravel Reverb by default, Pusher as fallback) and, because it is not ShouldQueue, it is broadcast synchronously during queue-free dispatch.

```php
class NotificationSent implements ShouldBroadcast
{
    use Dispatchable, InteractsWithSockets, SerializesModels;
```

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

### Force a Specific Locale

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

Force the plugin to use a specific locale, e.g., French.

```php
FilamentNotificationBellPlugin::make()->locale('fr')
```

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

### getFacadeAccessor() method implementation

Source: https://github.com/benriadh1/filament-notification-bell

Returns the container key 'filament-notification-bell' that the facade resolves at runtime. This method is part of the NotificationBell facade class.

```php
protected static function getFacadeAccessor(): string
{
    return 'filament-notification-bell';
}
```

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

### Composer auto-discovery configuration for the service provider

Source: https://github.com/benriadh1/filament-notification-bell

Registers the service provider in Laravel's auto-discovery mechanism via the extra.laravel.providers entry in composer.json.

```json
"extra": {
    "laravel": {
        "providers": [
            "Benriadh1\\FilamentNotificationBell\\FilamentNotificationBellServiceProvider"
        ]
    }
}
```

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

### register(Panel $panel)

Source: https://github.com/benriadh1/filament-notification-bell

Registers the plugin on a Filament panel. Called once by Filament when the panel boots; attaches a render hook at the end of the panel top bar.

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

### Description
Registers the plugin on a Filament panel. Called once by Filament when the panel boots; attaches a render hook at `PanelsRenderHook::TOPBAR_END` (end of the panel top bar). The callback renders the `filament-notification-bell::livewire.hook` view, passing the seven options listed below as view variables; that view mounts the Livewire component.

### Method
`public function register(Panel $panel): void`

### Parameters
- `$panel` (`Filament\Panel`) - Required - The Filament panel the plugin is registered on.

### Returns
- `void`
```

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

### Override a Translation Key

Source: https://github.com/benriadh1/filament-notification-bell/blob/main/README.md

After publishing, edit the file at lang/vendor/filament-notification-bell/en/notification-bell.php to override translation keys.

```php
return [
    'title' => 'My Custom Title',
    // ...
];
```

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

### Manual mounting in Blade view

Source: https://github.com/benriadh1/filament-notification-bell

Mounts the notification bell component outside the top bar with dropdown mode, limit 10, dark theme, polling enabled, and 60-second poll interval.

```blade
@livewire('filament-notification-bell.notification-bell', [
    'panelMode'    => 'dropdown',
    'limit'        => 10,
    'theme'        => 'dark',
    'polling'      => true,
    'pollInterval' => 60,
])
```

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

### useReverb()

Source: https://github.com/benriadh1/filament-notification-bell

Sets `$usingReverb = true`. Informational — the value is not propagated to the view and has no effect on the bundled rendering path.

```APIDOC
## useReverb()

### Description
Sets `$usingReverb = true`. Informational — the value is not propagated to the view and has no effect on the bundled rendering path.

### Method
useReverb

### Parameters
None

### Response
#### Success Response
- Returns `static` for chaining.
```

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

### FilamentNotificationBellPlugin class declaration

Source: https://github.com/benriadh1/filament-notification-bell

The plugin class implements Filament\Contracts\Plugin and is the panel-facing configuration object for the notification bell. It is instantiated via the container's make() method, not as a singleton.

```php
class FilamentNotificationBellPlugin implements Plugin
```
Tokens:
Raw