Download the PHP package filamerce/filament-comments without Composer

Filament Comments

Add comments to your Filament Resources.

This package is a fork of [https://github.com/parallax/filament-comments] with merged Pull Requests and support of Laravel 12.

Installation

Install the package via composer:

Publish and run the migrations:

You can publish the config file with:

You can publish the language files with:

Optionally, you can publish the views using

Quickstart

1. Add model trait

First open the eloquent model you wish to add Filament Comments to.

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.

You may customise the page action as you would any other action.

2. Table actions

Open the resource where you want the comments table action to appear.

Add the CommentsAction to the $table->actions() method.

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.

Please note that this cannot be used in combination with a comments action on the same page.

Comment sanitization

Comment bodies are written by your panel users and rendered as HTML in every other user's browser, so they are treated as untrusted input. Before a comment is rendered it is passed through an allowlist sanitizer that keeps the formatting the bundled editors produce (bold, italic, lists, links, quotes, code blocks) and drops everything else, including <script>, event handler attributes such as onerror, javascript: URLs and inline style attributes.

If you need a different policy, rebind the sanitizer in a service provider:

[!WARNING] If you published this package's views before v2.0.2, your published comments.blade.php still renders comments unsanitized. Re-publish it, or replace the comment body output with {{ \Filamerce\FilamentComments\Support\CommentSanitizer::render($comment->comment) }}.

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 Filamerce\FilamentComments\Models\FilamentComment model.

You should define the policy class in the filament-comments config file.

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:

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:

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• Parallax
• Contributors

License

The MIT License (MIT). Please see License File for more information.