https://github.com/parallax/filament-comments
Add comments to your Filament Resources
https://github.com/parallax/filament-comments
Last synced: 7 months ago
JSON representation
Add comments to your Filament Resources
- Host: GitHub
- URL: https://github.com/parallax/filament-comments
- Owner: parallax
- License: mit
- Created: 2024-01-27T19:40:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-27T12:13:46.000Z (10 months ago)
- Last Synced: 2025-06-22T00:55:34.808Z (7 months ago)
- Language: PHP
- Homepage: https://filamentphp.com/plugins/parallax-comments
- Size: 2.65 MB
- Stars: 117
- Watchers: 6
- Forks: 53
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Filament Comments
[](https://packagist.org/packages/parallax/filament-comments)
[](LICENSE.md)
[](https://packagist.org/packages/parallax/filament-comments)
Add comments to your Filament Resources.
## Installation
Install the package via composer:
```bash
composer require parallax/filament-comments
```
Publish and run the migrations:
```bash
php artisan vendor:publish --tag="filament-comments-migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="filament-comments-config"
```
You can publish the language files with:
```bash
php artisan vendor:publish --tag="filament-comments-translations"
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="filament-comments-views"
```
## Quickstart
### 1. Add model trait
First open the eloquent model you wish to add Filament Comments to.
```php
namespace App\Models;
use Parallax\FilamentComments\Models\Traits\HasFilamentComments;
class Product extends Model
{
use HasFilamentComments;
}
```
### 2. Add comments to Filament Resource
There are 3 ways of using this plugin in your Filament Resources:
#### 1. Page actions
Open the page where you want the comments action to appear, this will most likely be the `ViewResource` page.
Add the `CommentsAction` to the `getHeaderActions()` method.
```php
actions()` method.
```php
actions([
CommentsAction::make(),
]);
}
}
```
You may customise the table action as you would any other action.
#### 3. Infolist entry
It's also possible to use the comments component within your infolist.
Add the `CommentsEntry` to the `$infolist->schema()` method.
```php
schema([
CommentsEntry::make('filament_comments'),
]);
}
}
```
Please note that this cannot be used in combination with a comments action on the same page.
## Authorisation
By default, all users can view & create comments as well as only delete their own comments.
If you would like to change this behaviour you can create your own eloquent model policy for the `Parallax\FilamentComments\Models\FilamentComment` model.
You should define the policy class in the `filament-comments` config file.
```php
return [
'model_policy' => \Parallax\FilamentComments\Policies\FilamentCommentPolicy::class,
];
```
## Pruning deleted comments
Comment records are set to be pruned after 30 days of being soft-deleted by default. You may change this value in the config file:
```php
return [
'prune_after_days' => 30,
];
```
After configuring the model, you should schedule the `model:prune` Artisan command in your application's `Kernel` class. Don't forget to explicitly mention the `FilamentComment` class. You are free to choose the appropriate interval at which this command should be run:
```php
namespace App\Console;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
use Parallax\FilamentComments\Models\FilamentComment;
class Kernel extends ConsoleKernel
{
protected function schedule(Schedule $schedule)
{
$schedule->command('model:prune', [
'--model' => [FilamentComment::class],
])->daily();
// This will not work, as models in a package are not used by default
// $schedule->command('model:prune')->daily();
}
}
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Credits
- [Parallax](https://parall.ax)
- [Contributors](https://github.com/parallax/filament-comments/graphs/contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.