Weave Code
Commentions Laravel Package
kirschbaum-development/commentions
Commentions is a Laravel package for adding comments and reactions to Eloquent models. Simple traits make models commentable and users commenters, with support for mentions, emoji reactions, and easy customization for displaying and managing comments in your app.
A package to allow you to create comments, tag users and more
Frequently asked questions about Commentions
- How do I install Commentions in a Laravel application?
- Install it with Composer using composer require kirschbaum-development/commentions, then publish the package migrations and config and run php artisan migrate. Add the commentable trait to the Eloquent models that should accept comments and the commenter trait to your User model. If you want the bundled UI, register the Filament plugin in your panel provider. Plan for roughly one to three developer days for a pilot once testing and permission review are included.
- Does Commentions require Filament, or can I use it in a plain Laravel app?
- The UI and management experience is delivered as a Filament plugin, so the package's main value assumes a Laravel app already running Filament. The underlying traits, migrations, and models can be used without Filament, but you would be building your own comment interface. If your product is API-first or has no admin panel, a custom implementation may fit better.
- Which Laravel, PHP, and Filament versions does Commentions support?
- The best-supported stack is a standard Laravel 10 or 11 app with Filament v3, MySQL or Postgres, and a conventional User model. Always check the composer.json constraints in the package repository against your own Laravel, Filament, and PHP versions before installing. Filament major-version compatibility is the most likely constraint to change over time.
- How do I make an Eloquent model commentable with Commentions?
- Add the package's commentable trait to the model that should receive comments and the commenter trait to your User model. The package ships polymorphic migrations, so comments can attach to multiple model types without schema changes per resource. After migrating, register the Filament plugin so the comments UI appears on your resources.
- How are @mentions resolved, and do they send queued notifications?
- Mentions are resolved against searchable user attributes that you configure, so you control which fields the mention search looks at. Notification and queue behavior for mentions should be reviewed in the package source before relying on it in production. If you need guaranteed delivery or custom channels, plan to add your own listener or notification class.
- Can I moderate, soft-delete, or restrict who can see comments?
- Moderation and permission scoping are not guaranteed out of the box, so review the package code for authorization hooks and add Laravel policies or global scopes where needed. Soft deletes depend on whether the published migration includes a deleted_at column, which you should check before running it. For multi-tenant apps, verify the polymorphic columns and indexes match your tenancy conventions.
- Does Commentions support threaded replies, file attachments, or rich text?
- Documentation is largely limited to the README and GitHub issues, and threaded replies, attachments, and rich text editors are not part of the documented feature set. The data model and Filament views would need customization or a fork to add those capabilities. Validate these requirements in a sandbox proof of concept before committing to the package.
- How do I limit or customize emoji reactions in Commentions?
- Reaction sets are configurable, so you can restrict which emoji are available rather than accepting arbitrary input. Constrain reactions at the configuration and policy level to prevent abuse, and add rate limiting if the UI is exposed to a broad audience. Test how reactions behave when a user reacts multiple times or to comments that are later deleted.
- Is Commentions production-ready, and what are the alternatives?
- It is MIT licensed and maintained by a reputable Laravel agency, but it has modest community validation with around 152 GitHub stars and very few dependents. Treat it as a dependency you own: budget time for security review, upgrade tracking, and possibly a fork. Alternatives include building comments directly on your own Eloquent models or using a dedicated comments package that matches your UI stack.
- What is the upgrade path when Filament releases a new major version?
- Because the UI is a Filament plugin, your upgrade path is tied to Filament's release cycle, so check for a compatible package release before upgrading your panel. Keep a staging environment where you can run the panel upgrade with the comments plugin enabled. Since the license permits forking, you can patch compatibility yourself if maintenance stalls.
Weaver
How can I help you explore Laravel packages today?