PHPackages                             eminiarts/aura-notifications - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. eminiarts/aura-notifications

ActiveLibrary[Mail & Notifications](/categories/mail)

eminiarts/aura-notifications
============================

A comprehensive notification system for Aura CMS with user notifications and system updates

v1.0.0(5mo ago)00MITPHPPHP ^8.1

Since Dec 5Pushed 5mo agoCompare

[ Source](https://github.com/eminiarts/aura-notifications)[ Packagist](https://packagist.org/packages/eminiarts/aura-notifications)[ Docs](https://github.com/eminiarts/aura-notifications)[ RSS](/packages/eminiarts-aura-notifications/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (9)Versions (2)Used By (0)

Aura CMS Notifications Plugin
=============================

[](#aura-cms-notifications-plugin)

A comprehensive notification system for Aura CMS that provides user notifications and system updates with a beautiful slide-over panel interface.

Features
--------

[](#features)

- **User Notifications** - Laravel notification system integration with database channel
- **System Updates** - Announce new features, security patches, and maintenance schedules
- **Slide-over Panel** - Beautiful right-side panel with blurred backdrop
- **Bell Icon** - Sidebar notification bell with unread count badge (toggle open/close)
- **Tabs** - Switch between "All" notifications and "Updates"
- **Mark as Read** - Mark individual or all notifications as read
- **Team Support** - Filter updates by team or show global updates
- **Dark Mode** - Full dark mode support
- **Responsive** - Works on desktop and mobile devices

Requirements
------------

[](#requirements)

- PHP 8.1+
- Laravel 10+
- Aura CMS
- Livewire 3.x

Installation
------------

[](#installation)

### 1. Add the plugin to your project

[](#1-add-the-plugin-to-your-project)

Copy the plugin folder to your project's `plugins/aura/notifications` directory.

### 2. Register the namespace in composer.json

[](#2-register-the-namespace-in-composerjson)

Add the following to your `composer.json` autoload section:

```
{
    "autoload": {
        "psr-4": {
            "Aura\\Notifications\\": "plugins/aura/notifications/src"
        }
    }
}
```

Then run:

```
composer dump-autoload
```

### 3. Register the Service Provider

[](#3-register-the-service-provider)

Add the service provider to your `config/app.php` providers array:

```
'providers' => [
    // ...
    Aura\Notifications\NotificationsServiceProvider::class,
],
```

Or if using Laravel's auto-discovery, add to your `composer.json`:

```
{
    "extra": {
        "laravel": {
            "providers": [
                "Aura\\Notifications\\NotificationsServiceProvider"
            ]
        }
    }
}
```

### 4. Run migrations

[](#4-run-migrations)

```
php artisan migrate
```

This creates the following tables:

- `aura_system_updates` - Stores system update announcements
- `aura_system_update_reads` - Tracks which users have read which updates

### 5. Publish configuration (optional)

[](#5-publish-configuration-optional)

```
php artisan vendor:publish --tag=aura-notifications-config
```

### 6. Add the Bell Icon to Your Sidebar

[](#6-add-the-bell-icon-to-your-sidebar)

Publish Aura's navigation view if you haven't already:

```
php artisan vendor:publish --tag=aura-views
```

Then add the bell component to `resources/views/vendor/aura/livewire/navigation.blade.php` in the sidebar footer section, next to the user profile:

```
{{-- Notifications Bell --}}

```

### 7. Enable notifications in Aura config

[](#7-enable-notifications-in-aura-config)

Make sure notifications are enabled in your `config/aura.php`:

```
'features' => [
    'notifications' => true,
    // ...
],
```

Configuration
-------------

[](#configuration)

The configuration file `config/aura-notifications.php` allows you to customize:

```
return [
    // Enable/disable notification features
    'enabled' => true,

    // System updates settings
    'system_updates' => [
        'enabled' => true,
        'categories' => [
            'feature' => 'New Feature',
            'improvement' => 'Improvement',
            'security' => 'Security Update',
            'maintenance' => 'Maintenance',
            'announcement' => 'Announcement',
        ],
    ],

    // Display settings
    'display' => [
        'max_unread_badge' => 99,
        'per_page' => 10,
    ],

    // Notification types with icons and colors
    'types' => [
        'success' => [
            'icon' => 'check-circle',
            'color' => 'green',
        ],
        'info' => [
            'icon' => 'information-circle',
            'color' => 'blue',
        ],
        'warning' => [
            'icon' => 'exclamation-triangle',
            'color' => 'yellow',
        ],
        'error' => [
            'icon' => 'x-circle',
            'color' => 'red',
        ],
    ],
];
```

Usage
-----

[](#usage)

### Sending User Notifications

[](#sending-user-notifications)

Use Laravel's built-in notification system. Create a notification class:

```