filament-announcement

KO | EN

gitlite — search

#privacy #framework #hacktoberfest #python #android #http #rust #typescript #terminal #golang

filament-announcement

(★ 9)

No description available.

File Explorer

ZIP Download

- - bug.yml
  - config.yml
- CONTRIBUTING.md
- dependabot.yml
- FUNDING.yml
- SECURITY.md
- announcement.php
- - ModelFactory.php
- - create_announcement_recipients_table.php.stub
  - create_announcement_table.php.stub
- create.png
- edit.png
- list.png
- - index.css
- - .gitkeep
- - index.js
- - .gitkeep
- - AnnouncementCommand.php
  - SendAnnouncementCommand.php
- - AnnouncementType.php
- - Announcement.php
- - GlobalAnnouncementBanner.php
- - Announcement.php
  - AnnouncementRecipient.php
- - AnnouncementNotification.php
- - HasAnnouncements.php
- AnnouncementPlugin.php
- AnnouncementServiceProvider.php
.gitignore
CHANGELOG.md
composer.json
LICENSE
package.json
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

A powerful Filament plugin for broadcasting announcements to all users or specific recipients with support for scheduling, dismissible alerts, live updates, and custom recipient models.

---
## Screenshots

### List View
![List Announcements](https://raw.githubusercontent.com/HasanYagout/filament-announcement/main/img/list.png)

### Create Announcement
![Create Announcement](https://raw.githubusercontent.com/HasanYagout/filament-announcement/main/img/create.png)

### Edit Announcement
![Edit Announcement](https://raw.githubusercontent.com/HasanYagout/filament-announcement/main/img/edit.png)

## Features

- ✅ Global announcements
- ✅ Targeted recipients
- ✅ Dismissible announcements
- ✅ Live polling updates
- ✅ Scheduled announcements
- ✅ Multiple announcement types
- ✅ Translation ready
- ✅ Filament native UI
- ✅ Custom recipient models
- ✅ User-specific visibility
- ✅ Laravel policy support

---

## Installation

Install the package via Composer:

```bash
composer require hasanyagout/filament-announcements
```

> [!IMPORTANT]
> If you are using Filament Panels and have not set up a custom theme yet,
> follow the official Filament documentation first:
>
> https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme

After setting up a custom theme, add the plugin views to your theme CSS file:

```css
@source '../../../../vendor/hasanyagout/filament-announcements/resources/**/*.blade.php';
```

Publish and run migrations:

```bash
php artisan vendor:publish --tag="announcements-migrations"
php artisan migrate
```

Publish the config file:

```bash
php artisan vendor:publish --tag="announcements-config"
```

Optionally publish translations:

```bash
php artisan vendor:publish --tag="announcements-translations"
```

Optionally publish views:

```bash
php artisan vendor:publish --tag="announcements-views"
```

---

## Setup

1. Register the plugin inside your Filament panel provider:

```php
use HasanYagout\Announcement\AnnouncementPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            AnnouncementPlugin::make(),
        ]);
}
```

2. Add the trait to your User model:

```php
use HasanYagout\Announcement\Traits\HasAnnouncements;

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

---

## Configuration

Example configuration:

```php
use App\Models\User;

return [

'recipient_models' => [

User::class => [
            'label' => 'Users',
            'title_attribute' => 'name',
        ],

];
```

---

## Polling Interval

Customize the polling interval:

```php
AnnouncementPlugin::make()
    ->pollingInterval('10s')
```

---

## Announcement Types

Supported announcement types:

- `info`
- `warning`
- `danger`
- `success`

---

## Translation Support

The plugin is fully translation-ready.

Example:

```php
__('announcement::filament.form.title.label')
```

---

## Scheduling

Announcements support scheduling using:

- `starts_at`
- `ends_at`

Only active announcements are displayed automatically.

---

## Dismissible Announcements

Users can dismiss announcements individually.

Dismiss states are stored per recipient.

---

## Recipient Targeting

Announcements can be:

- Global (`is_global`)
- Assigned to specific users/models

Supported via polymorphic recipient relationships.

---

## Permissions & Policies

The plugin supports Laravel Policies.

Example policy registration:

---

## Testing

```bash
composer test
```

---

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes.

---

## Contributing

Contributions, issues, and feature requests are welcome.

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

---

## Security Vulnerabilities

Please review [our security policy](.github/SECURITY.md) on how to report security vulnerabilities.

---

## Credits

- [Hasan Yagout](https://github.com/HasanYagout)

---

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

filament-announcement

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README