Commentions

https://github.com/kirschbaum-development/commentions
Admin
Commentions is a drop-in package for Filament that enables adding comments to resources, with user...
Tokens:106,904
Snippets:850
Trust Score:9.8
License:MIT
Update:5 days ago
Show doc for...
Tokens:
Raw
### Run Commentions Installer

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Run the installer command to set up the package. This is the second step after installing via Composer.

```bash
php artisan commentions:install
```

--------------------------------

### Install Commentions via Composer

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Install the package using Composer. This is the first step in the installation process.

```bash
composer require kirschbaum-development/commentions
```

--------------------------------

### Example translation file for English

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

This is an example of the translation file content. Override only the keys you need. The file is located at `lang/vendor/commentions/en/comments.php`.

```php
// lang/vendor/commentions/en/comments.php
return [
    'label' => 'Notes',
    'no_comments_yet' => 'No notes yet.',
    'add_reaction' => 'Add a reaction',
    'cancel' => 'Close',
    'delete' => 'Remove',
    'save' => 'Update',
];
```

--------------------------------

### Disable Reactions Per Component

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Disable reactions on individual components using ->disableReactions().

```php
CommentsEntry::make('comments')
    ->mentionables(User::all())
    ->disableReactions();

CommentsAction::make()
    ->mentionables(User::all())
    ->disableReactions();
```

--------------------------------

### Register assets with artisan filament:assets

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Run this command to publish the package assets for Filament.

```bash
php artisan filament:assets
```

--------------------------------

### Resolve authenticated user

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Custom resolver for the authenticated user, overriding the default auth()->user().

```php
use Kirschbaum\Commentions\Config;

Config::resolveAuthenticatedUserUsing(
    fn () => auth()->guard('my-guard')->user()
)
```

--------------------------------

### Frontend Development Commands

Source: https://github.com/kirschbaum-development/commentions/blob/main/CLAUDE.md

Commands for installing JS dependencies and building assets for development and production.

```bash
# Install JS dependencies
npm install

# Build frontend assets for development with watch mode
npm run dev

# Build frontend assets for production
npm run build

# Individual build commands
npm run dev:scripts     # Build JS in dev mode with watch
npm run build:scripts   # Build JS for production
npm run dev:styles      # Build CSS in dev mode with watch
npm run build:styles    # Build CSS for production
```

--------------------------------

### Get mentioned commenters from a comment

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Retrieve the mentioned Commenters for an existing comment.

```php
$comment->getMentioned()->each(function (Commenter $commenter) {
    // do something with $commenter...
});
```

--------------------------------

### Publish Commentions configuration file

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Publish the configuration file using the commentions-config tag.

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

--------------------------------

### Dispatch refresh event from JavaScript

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Dispatch the commentions:refresh Livewire event from JavaScript.

```javascript
Livewire.dispatch('commentions:refresh')
```

--------------------------------

### Configure Allowed Reactions in config/commentions.php

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Customize the allowed reactions by updating the 'reactions.allowed' option.

```php
'reactions' => [
    'enabled' => env('COMMENTIONS_REACTIONS_ENABLED', true),

    'allowed' => ['👍', '❤️', '😂', '🎉', '👀'],
],
```

--------------------------------

### Register Custom Actions

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Add additional actions next to edit/delete using Config::registerCommentActions.

```php
use Kirschbaum\Commentions\Config;
use Filament\Actions\Action;

Config::registerCommentActions(fn ($comment) => Action::make('activityLogs')
    ->icon('heroicon-s-clock')
    ->iconButton()
    ->modalContent(/* ... */)
);
```

--------------------------------

### PHP Development Commands

Source: https://github.com/kirschbaum-development/commentions/blob/main/CLAUDE.md

Commands for installing dependencies, running tests, code style checks, and static analysis.

```bash
# Install PHP dependencies
composer install

# Run tests
./vendor/bin/pest

# Code style checks
composer lint:check

# Apply code style fixes
composer lint

# Static analysis
composer static-analysis
```

--------------------------------

### Disable Avatars Per Component

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Disable avatars on individual components using ->disableAvatars().

```php
CommentsEntry::make('comments')
    ->mentionables(User::all())
    ->disableAvatars();

CommentsAction::make()
    ->mentionables(User::all())
    ->disableAvatars();
```

--------------------------------

### Disable pagination on CommentsAction

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Disable pagination on a CommentsAction by chaining disablePagination().

```php
use Kirschbaum\Commentions\Filament\Actions\CommentsAction;

->recordActions([
    CommentsAction::make()
        ->mentionables(User::all())
        ->disablePagination();

])
```

--------------------------------

### Force Avatar Provider in config/commentions.php

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Set the 'avatar_provider' config key to force a specific avatar provider.

```php
// config/commentions.php
use Filament\AvatarProviders\GravatarProvider;

return [
    // ...
    'avatar_provider' => GravatarProvider::class,
];
```

--------------------------------

### Implement Commenter interface in User model

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Add the Commenter interface to your User model to enable commenting.

```php
use Kirschbaum\Commentions\Contracts\Commenter;

class User extends Model implements Commenter
{
    // ...
}
```

--------------------------------

### View file contents for Filament 3

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

The view file contents for Filament 3 to render comments via Livewire.

```php
@livewire('commentions::comments', [
    'record' => $record,
    'mentionables' => \App\Models\User::all(),
    'readonly' => $readonly ?? false
])
```

--------------------------------

### View file contents for Filament 4

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

The view file contents for Filament 4 to render comments via Livewire.

```php
@livewire('commentions.comments', [
    'record' => $record,
    'mentionables' => \App\Models\User::all(),
    'readonly' => $readonly ?? false
])
```

--------------------------------

### Render non-comments in the list

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Override getComments to return RenderableComment instances for non-comment entries like status changes.

```php
use Kirschbaum\Commentions\RenderableComment;

public function getComments(?int $limit = null): Collection
{
    $statusHistory = $this->statusHistory()->get()->map(fn (StatusHistory $statusHistory) => new RenderableComment(
        id: $statusHistory->id,
        authorName: $statusHistory->user->name,
        body: sprintf('Status changed from %s to %s', $statusHistory->old_status, $statusHistory->new_status),
        createdAt: $statusHistory->created_at,
    ));

    $comments = $this->comments()->latest()->with('author')->get();

    $mergedCollection = $statusHistory->merge($comments);

    if ($limit) {
        return $mergedCollection->take($limit);
    }

    return $mergedCollection;
}
```

--------------------------------

### Advanced pagination configuration with CommentsEntry

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Configure pagination on a CommentsEntry inside an Infolists section, setting perPage, loadMoreIncrementsBy, and loadMoreLabel.

```php
use Kirschbaum\Commentions\Filament\Infolists\Components\CommentsEntry;

Infolists\Components\Section::make('Comments')
    ->schema([
        CommentsEntry::make('comments')
            ->mentionables(fn (Model $record) => User::all())
            ->perPage(8)
            ->loadMoreIncrementsBy(8)
            ->loadMoreLabel('Show older'),
    ])
```

--------------------------------

### Install Commentions package and publish assets

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/plugin-and-provider.md

Run these Artisan commands to install the package, run the installer, and publish Filament assets.

```bash
composer require kirschbaum-development/commentions
php artisan commentions:install
php artisan filament:assets
```

--------------------------------

### Enable built-in mention notifications

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Configuration snippet to enable notifications for mentions and set channels. Place in config/commentions.php.

```php
    'notifications' => [
        'mentions' => [
            'enabled' => true,
            'channels' => ['mail', 'database'],
        ],
    ],
```

--------------------------------

### Register Custom Policy in config/commentions.php

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Update the 'comment.policy' option to point to your custom policy class.

```php
'comment' => [
    // ...
    'policy' => \App\Policies\CommentPolicy::class,
],
```

--------------------------------

### Implement HasAvatar Interface for Commenter Avatar

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Implement Filament's HasAvatar interface to provide a custom avatar URL.

```php
use Filament\Models\Contracts\HasAvatar;

class User extends Authenticatable implements Commenter, HasName, HasAvatar
{
    public function getFilamentAvatarUrl(): ?string
    {
        return $this->avatar_url;
    }
}
```

--------------------------------

### Implement HasName Interface for Commenter Name

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use Filament's HasName interface to customize the commenter name.

```php
use Filament\Models\Contracts\HasName;
use Kirschbaum\Commentions\Contracts\Commenter;

class User extends Model implements Commenter, HasName
{
    public function getFilamentName(): string
    {
        return (string) '#' . $this->id . ' - ' . $this->name;
    }
}
```

--------------------------------

### Dispatch refresh event from PHP

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Dispatch the commentions:refresh Livewire event to reload the comments list immediately.

```php
protected function afterSave(): void
{
    $this->dispatch('commentions:refresh');
}
```

--------------------------------

### Implement getCommenterName Method for Commenter Name

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use the optional getCommenterName method to customize the commenter name.

```php
use Kirschbaum\Commentions\Contracts\Commenter;

class User extends Model implements Commenter
{
    public function getCommenterName(): string
    {
        return (string) '#' . $this->id . ' - ' . $this->name;
    }
}
```

--------------------------------

### Enable polling on comments component

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Enable polling for new comments on a component by calling the poll method with an interval.

```php
Infolists\Components\Section::make('Comments')
    ->schema([
        CommentsEntry::make('comments')
            ->mentionables(fn (Model $record) => User::all())
            ->poll('10s')
    ]),
```

--------------------------------

### Configure custom User model in config/commentions.php

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Set a custom commenter model namespace in the configuration file.

```php
    'commenter' => [
        'model' => \App\Domains\Users\User::class,
    ],
```

--------------------------------

### Publish translation files

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Run this artisan command to publish the package translation files into your application. The files will be copied to `lang/vendor/commentions/{locale}/comments.php`.

```bash
php artisan vendor:publish --tag="commentions-lang"
```

--------------------------------

### Configure Comment Model in config/commentions.php

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Extend the Comment model by setting the 'comment.model' option to your custom class.

```php
'comment' => [
    'model' => \App\Models\Comment::class,
    // ...
],
```

--------------------------------

### Configure Avatars Globally in config/commentions.php

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Disable avatars globally by setting 'avatars.enabled' to false.

```php
'avatars' => [
    'enabled' => env('COMMENTIONS_AVATARS_ENABLED', true),
],
```

--------------------------------

### Implement Commentable interface and HasComments trait

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Add the Commentable interface and HasComments trait to the model you want to comment on.

```php
use Kirschbaum\Commentions\HasComments;
use Kirschbaum\Commentions\Contracts\Commentable;

class Project extends Model implements Commentable
{
    use HasComments;
}
```

--------------------------------

### configurePackage method

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/plugin-and-provider.md

Registers the package with spatie/laravel-package-tools, including config, translations, assets, views, migrations, and install command.

```php
public function configurePackage(Package $package): void   // src/CommentionsServiceProvider.php:29
```

--------------------------------

### Resolve comment URL for notifications

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Optional URL resolver so emails/links point users to the right place. Uses Config::resolveCommentUrlUsing.

```php
use Kirschbaum\Commentions\Config;

Config::resolveCommentUrlUsing(function (\Kirschbaum\Commentions\Comment $comment) {
    // Return a URL to view the record and scroll to the comment
    return route('projects.show', $comment->commentable) . '#comment-' . $comment->getId();
});
```

--------------------------------

### Programmatic subscription methods from HasComments trait

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use the HasComments trait methods to manage subscriptions programmatically: subscribe, unsubscribe, isSubscribed, and getSubscribers.

```php
// Subscribe a user
$commentable->subscribe($user);
```

```php
// Unsubscribe a user
$commentable->unsubscribe($user);
```

```php
// Check if a user is subscribed
$isSubscribed = $commentable->isSubscribed($user);
```

```php
// Get all subscribers
$subscribers = $commentable->getSubscribers();
```

--------------------------------

### Configure pagination with perPage on CommentsAction

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Set the number of comments per page using perPage(10) on a CommentsAction. Pagination is enabled by default.

```php
use Kirschbaum\Commentions\Filament\Actions\CommentsAction;

->recordActions([
    CommentsAction::make()
        ->mentionables(User::all())
        ->perPage(10)

])
```

--------------------------------

### Wrap CommentsEntry in Section for Filament 3

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Wrap the CommentsEntry in a Section to make comments more distinct. Use this for Filament 3.

```php
\Filament\Infolists\Components\Section::make('Comments')
    ->schema([
        CommentsEntry::make('comments')
            ->mentionables(fn (Model $record) => User::all()),
    ]),
```

--------------------------------

### Send notification on user mention

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Listener for the UserWasMentionedEvent that sends a notification to the mentioned user. Requires event auto-discovery or manual registration in EventServiceProvider.

```php
namespace App\Listeners;

use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use App\Notifications\UserMentionedInCommentNotification;
use Kirschbaum\Commentions\Events\UserWasMentionedEvent;

class SendUserMentionedNotification implements ShouldQueue
{
    use InteractsWithQueue;

    public function handle(UserWasMentionedEvent $event): void
    {
        $event->user->notify(
            new UserMentionedInCommentNotification($event->comment)
        );
    }
}
```

--------------------------------

### Wrap CommentsEntry in Section for Filament 4

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Wrap the CommentsEntry in a Section to make comments more distinct. Use this for Filament 4.

```php
\Filament\Schemas\Components\Section::make('Comments')
    ->components([
        CommentsEntry::make('comments')
            ->mentionables(fn (Model $record) => User::all()),
    ]),
```

--------------------------------

### Commentions configuration file (config/commentions.php)

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/configuration.md

Example configuration for the Commentions package. Defines commenter and comment models, optional policy, reaction settings with allowed emojis, ratings toggle and max value, and toolbar button groups. Uses environment variables for enabling features and max rating.

```php
// config/commentions.php
return [
    'commenter' => [
        'model' => \App\Domains\Users\User::class,
    ],
    'comment' => [
        'model' => \App\Models\Comment::class,
        'policy' => \App\Policies\CommentPolicy::class,
    ],
    'reactions' => [
        'enabled' => env('COMMENTIONS_REACTIONS_ENABLED', true),
        'allowed' => ['👍', '❤️', '😂', '🎉', '👀'],
    ],
    'ratings' => [
        'enabled' => env('COMMENTIONS_RATINGS_ENABLED', false),
        'max' => (int) env('COMMENTIONS_RATINGS_MAX', 5),
    ],
    'toolbar' => [
        'enabled' => env('COMMENTIONS_TOOLBAR_ENABLED', true),
        'buttons' => [
            ['bold', 'italic', 'underline'],
            ['bulletList', 'orderedList'],
            ['link'],
        ],
    ],
];

```

--------------------------------

### Custom Comment Policy Class

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Create a custom policy by extending CommentionsPolicy and implementing create, update, and delete methods.

```php
namespace App\Policies;

use Kirschbaum\Commentions\Comment;
use Kirschbaum\Commentions\Contracts\Commenter;
use Kirschbaum\Commentions\Policies\CommentPolicy as CommentionsPolicy;

class CommentPolicy extends CommentionsPolicy
{
    public function create(Commenter $user): bool
    {
        // TODO: Implement custom permission logic.
    }

    public function update($user, Comment $comment): bool
    {
        // TODO: Implement custom permission logic.
    }

    public function delete($user, Comment $comment): bool
    {
        // TODO: Implement custom permission logic.
    }
}
```

--------------------------------

### Make form comments readonly via viewData

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Pass the readonly flag in viewData to make form comments readonly.

```php
ViewField::make('comments_section')
    ->view('...') // View file
    ->viewData(fn ($livewire) => [
        'record' => $livewire->record ?? null,
        'readonly' => true, // Enable readonly mode
    ])
    ->columnSpanFull()
    ->hiddenLabel(),
```

--------------------------------

### Filament 3 table and Filament 4 record actions example

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/filament-subscription-actions.md

Shows how to add subscription actions to Filament 3 table actions and Filament 4 record actions using SubscriptionTableAction and SubscriptionAction respectively.

```php
use Kirschbaum\Commentions\Filament\Actions\SubscriptionAction;
use Kirschbaum\Commentions\Filament\Actions\SubscriptionTableAction;

// Filament 3 table
->actions([
    SubscriptionTableAction::make(),
])

// Filament 4 record action
->recordActions([
    SubscriptionAction::make(),
])
```

--------------------------------

### Add SubscriptionAction to Filament record actions (Filament 4)

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use SubscriptionAction in the recordActions array for Filament 4 resources. Requires importing the action class.

```php
// In record actions (Filament 4)
->recordActions([
    SubscriptionAction::make(),
])
```

--------------------------------

### Listen for mentions and notifications

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/events.md

Example listener for UserWasMentionedEvent, implementing ShouldQueue to handle mention notifications asynchronously.

```php
namespace App\Listeners;

use Illuminate\Contracts\Queue\ShouldQueue;
use Kirschbaum\Commentions\Events\UserWasMentionedEvent;

class SendUserMentionedNotification implements ShouldQueue
{
    public function handle(UserWasMentionedEvent $event): void
    {
        $event->user->notify(
            new \App\Notifications\UserMentionedInCommentNotification($event->comment)
        );
    }
}
```

--------------------------------

### Use CommentsAction as header action

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Add a comments action to the header actions of a Filament page. Works for Filament 3 and 4.

```php
use Kirschbaum\Commentions\Filament\Actions\CommentsAction;

protected function getHeaderActions(): array
{
    return [
        CommentsAction::make()
            ->mentionables(User::all()),
    ];
}
```

--------------------------------

### Listener for UserIsSubscribedToCommentableEvent

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

This listener handles the `UserIsSubscribedToCommentableEvent` to send custom notifications to subscribed users. It uses the `NewCommentNotification` and the event's user and comment properties.

```php
namespace App\Listeners;

use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use App\Notifications\NewCommentNotification;
use Kirschbaum\Commentions\Events\UserIsSubscribedToCommentableEvent;

class SendSubscribedUserNotification implements ShouldQueue
{
    use InteractsWithQueue;

    public function handle(UserIsSubscribedToCommentableEvent $event): void
    {
        $event->user->notify(
            new NewCommentNotification($event->comment)
        );
    }
}
```

--------------------------------

### Listen for subscription notifications

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/events.md

Example listener for UserIsSubscribedToCommentableEvent, implementing ShouldQueue to handle subscription notifications asynchronously.

```php
use Illuminate\Contracts\Queue\ShouldQueue;
use Kirschbaum\Commentions\Events\UserIsSubscribedToCommentableEvent;

class SendSubscribedUserNotification implements ShouldQueue
{
    public function handle(UserIsSubscribedToCommentableEvent $event): void
    {
        $event->user->notify(new NewCommentNotification($event->comment));
    }
}
```

--------------------------------

### Add SubscriptionAction to Filament table actions (Filament 3)

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use SubscriptionTableAction in the table actions array for Filament 3 resources. Requires importing the action class.

```php
// In table actions (Filament 3)
->actions([
    SubscriptionTableAction::make(),
])
```

--------------------------------

### Register CommentsEntry in Filament Infolists

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Add a CommentsEntry component to your Filament infolist to display comments. Works for Filament 3 and 4.

```php
CommentsEntry::make('comments')
    ->mentionables(fn (Model $record) => User::all()),
```

--------------------------------

### Use ViewField in Filament 4 form schemas

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Add a ViewField to a Filament 4 form schema to embed comments.

```php
use Filament\Forms\Components\ViewField;

public static function configure(Schema $schema): Schema
{
    return $schema
        ->components([
            // Your other form fields...

            ViewField::make('comments_section')
                ->view('...') // View file
                ->viewData(fn ($livewire) => [
                    'record' => $livewire->record ?? null
                ])
                ->columnSpanFull()
                ->hiddenLabel(),
        ]);
}
```

--------------------------------

### Header action example

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/filament-subscription-actions.md

Adds a subscription action to Filament resource header actions using SubscriptionAction::make().

```php
use Kirschbaum\Commentions\Filament\Actions\SubscriptionAction;

protected function getHeaderActions(): array
{
    return [
        SubscriptionAction::make(),
    ];
}
```

--------------------------------

### Use CommentsAction in Filament 4 recordActions

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Add a comments action to your Filament 4 table's recordActions array.

```php
use Kirschbaum\Commentions\Filament\Actions\CommentsAction;

->recordActions([
    CommentsAction::make()
        ->mentionables(User::all())
])
```

--------------------------------

### Configure toolbar buttons in config/commentions.php

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

This configuration sets the toolbar buttons for the comment editor. Buttons can be a flat list or grouped into arrays to render visual separators. Set `enabled` to false to hide the toolbar entirely.

```php
    'toolbar' => [
        'enabled' => env('COMMENTIONS_TOOLBAR_ENABLED', true),

        'buttons' => [
            ['bold', 'italic', 'underline'],
            ['bulletList', 'orderedList'],
            ['link'],
        ],
    ],
```

--------------------------------

### Enable attachments globally in config/commentions.php

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Attachments are disabled by default. Configure the storage disk, directory, maximum file size and count, signed URL expiration, and accepted MIME types via environment variables. The accepted_mime_types array ships with a safe set; leaving it empty allows any file type, which is dangerous on a public disk.

```php
    'attachments' => [
        'enabled' => env('COMMENTIONS_ATTACHMENTS_ENABLED', false),

        // Filesystem disk and directory used to store uploads.
        'disk' => env('COMMENTIONS_ATTACHMENTS_DISK', 'public'),
        'directory' => env('COMMENTIONS_ATTACHMENTS_DIRECTORY', 'commentions-attachments'),

        // Maximum size per file, in kilobytes.
        'max_size' => (int) env('COMMENTIONS_ATTACHMENTS_MAX_SIZE', 10240),

        // Maximum number of files per comment.
        'max_files' => (int) env('COMMENTIONS_ATTACHMENTS_MAX_FILES', 5),

        // Lifetime, in minutes, of signed URLs for attachments on a private disk.
        'url_expiration' => (int) env('COMMENTIONS_ATTACHMENTS_URL_EXPIRATION', 30),

        // Accepted MIME types, validated against the file's actual contents.
        'accepted_mime_types' => [
            'image/jpeg', 'image/png', 'image/gif', 'image/webp', 'application/pdf',
            // ...
        ],
    ],
```

--------------------------------

### Livewire component example with per-component feature toggles

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/livewire-concerns.md

Shows how to configure the comments component directly on Livewire parameters, toggling features like ratings, reactions, avatars, toolbar buttons, pagination, and readonly.

```blade
<livewire:commentions.comments
    :record="$record"
    :mentionables="\App\Models\User::all()"
    :ratings-enabled="true"
    :max-rating="10"
    :reactions-enabled="false"
    :avatars-enabled="true"
    :toolbar-buttons="[['bold','italic'],['link']]"
    :paginate="false"
    :readonly="true"
/>
```

--------------------------------

### Calling handleReactionToggle from application code

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/livewire-reactions.md

Example of reading the reaction summary from a Livewire component that renders Reactions. The call forwards to the Comment component, which persists and emits 'comment:reaction:saved'.

```php
// Inside a Livewire component that renders Reactions
$this->handleReactionToggle('😂');  // forwards to the Comment component, which persists and emits 'comment:reaction:saved'
```

--------------------------------

### isLivewireV4(): bool

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/config.md

Determines whether the installed Livewire version is 4.0 or higher.

```APIDOC
## isLivewireV4(): bool

### Description
Determines whether the installed Livewire version is 4.0 or higher.

### Method
`isLivewireV4`

### Parameters
None

### Return Value
`bool` - `true` if Livewire version is >= 4.0, `false` otherwise.

### Example
```php
if (Commentions::isLivewireV4()) {
    // Livewire 4 specific logic
}
```
```

--------------------------------

### Enable ratings per component with enableRatings() and maxRating()

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Overrides the global ratings config for a specific component. Works on CommentsEntry, CommentsAction, and CommentsTableAction. The maxRating() method sets the highest selectable rating, defaulting to ratings.max.

```php
CommentsEntry::make('comments')
    ->mentionables(fn (Model $record) => User::all())
    ->enableRatings()
    ->maxRating(10)
```

--------------------------------

### Set private disk for attachments via COMMENTIONS_ATTACHMENTS_DISK

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use a private disk (e.g., Laravel 11+ local disk with 'serve' => true or private S3) to store attachments with temporary signed URLs. The disk must support temporary URLs; otherwise a plain URL is used. Signed URLs are not tied to a user and anyone with the link can access the file until it expires.

```env
COMMENTIONS_ATTACHMENTS_DISK=local
```

--------------------------------

### Resolve TipTap CSS classes globally using Config

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use this to customize the TipTap editor CSS classes globally. The closure returns the CSS classes string. Ensure the classes are whitelisted in your Tailwind config.

```php
use Kirschbaum\Commentions\Config;

Config::resolveTipTapCssClassesUsing(function () {
    return 'prose max-w-none focus:outline-none p-4';
});
```

--------------------------------

### Add SubscriptionAction to Filament resource header actions

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use SubscriptionAction in the getHeaderActions method to add a subscription action to a Filament resource. Requires importing Kirschbaum\Commentions\Filament\Actions\SubscriptionAction.

```php
use Kirschbaum\Commentions\Filament\Actions\SubscriptionAction;

// In header actions
protected function getHeaderActions(): array
{
    return [
        SubscriptionAction::make(),
    ];
}
```

--------------------------------

### Enable ratings globally in config/commentions.php

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Ratings are disabled by default. Set 'enabled' to true via the COMMENTIONS_RATINGS_ENABLED environment variable and optionally adjust the maximum rating with COMMENTIONS_RATINGS_MAX.

```php
    'ratings' => [
        'enabled' => env('COMMENTIONS_RATINGS_ENABLED', false),

        'max' => (int) env('COMMENTIONS_RATINGS_MAX', 5),
    ],
```

--------------------------------

### Customized label/icon/color example

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/filament-subscription-actions.md

Customizes the subscription action's label, icon, and color for subscribed and unsubscribed states.

```php
SubscriptionAction::make()
    ->subscribeLabel('Follow')
    ->unsubscribeLabel('Unfollow')
    ->subscribeIcon('heroicon-o-bell')
    ->unsubscribeIcon('heroicon-s-bell-slash')
    ->subscribeColor('primary')
    ->unsubscribeColor('danger');
```

--------------------------------

### packageBooted method

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/plugin-and-provider.md

Registers Livewire components, shares component prefix, registers assets, binds gate policy, publishes translations, and listens for mention events.

```php
public function packageBooted(): void   // src/CommentionsServiceProvider.php:63
```

--------------------------------

### Publish Commentions config and language files

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/plugin-and-provider.md

Run these Artisan commands to publish the package's configuration and language files.

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

--------------------------------

### Catch exceptions when saving comments and resolving users

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/errors.md

Wrap SaveComment::run and Config::resolveAuthenticatedUser in try-catch blocks to handle AuthorizationException for policy denials and InvalidArgumentException for non-Commenter resolvers. The example shows catching both exceptions separately.

```php
use Illuminate\Auth\Access\AuthorizationException;
use InvalidArgumentException;
use Kirschbaum\Commentions\Config;
use Kirschbaum\Commentions\Actions\SaveComment;

try {
    $comment = SaveComment::run($project, $user, '<p>hi</p>');
} catch (AuthorizationException $e) {
    // policy denied create — show a friendly error
}

try {
    $user = Config::resolveAuthenticatedUser();
} catch (InvalidArgumentException $e) {
    // resolver returned a non-Commenter — fix the resolver
}
```

--------------------------------

### mount(Model $record, ?bool $showSubscribers = null): void

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/livewire-subscription-sidebar.md

Initializes the sidebar component with the commentable model and optional override for showing subscribers. Calls mountHasSidebar with config defaults.

```APIDOC
## mount(Model $record, ?bool $showSubscribers = null): void

### Description
Initializes the sidebar component with the commentable model and optional override for showing subscribers. Calls mountHasSidebar with config defaults.

### Method
mount

### Parameters
- `$record` (Model) - Required - The commentable model
- `$showSubscribers` (?bool) - Optional - Overrides `commentions.subscriptions.show_subscribers` for the subscribers list; `null` uses the config value

### Source
`src/Livewire/SubscriptionSidebar.php:16`
```

--------------------------------

### Disable subscription sidebar on CommentsAction

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Disable the subscription sidebar on a CommentsAction by chaining disableSidebar(). Requires importing Kirschbaum\Commentions\Filament\Actions\CommentsAction.

```php
use Kirschbaum\Commentions\Filament\Actions\CommentsAction;

->recordActions([
    CommentsAction::make()
        ->mentionables(User::all())
        ->disableSidebar()
])
```

--------------------------------

### mount method signature

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/livewire-subscription-sidebar.md

Initializes the sidebar with the commentable model and optional override for showing subscribers. Calls mountHasSidebar with config values.

```php
public function mount(Model $record, ?bool $showSubscribers = null): void
```

--------------------------------

### getTipTapCssClasses

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/config.md

Runs the registered callback or returns the built-in default CSS classes string.

```APIDOC
## getTipTapCssClasses

### Description
Runs the registered callback or returns the built-in default CSS classes string.

### Method
`public static function getTipTapCssClasses(): ?string`

### Returns
- `?string` - The CSS classes string or null.
```

--------------------------------

### Override record for CommentsEntry

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Override the default record to comment on a different model, such as a pivot or related record in a table modal.

```php
CommentsEntry::make('comments')
    ->record(fn () => $pivot)
    ->mentionables(User::all());
```

--------------------------------

### Register built-in notification via configuration

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/events.md

Configuration snippet for config/commentions.php to enable mention notifications via mail and database channels.

```php
// config/commentions.php
'notifications' => [
    'mentions' => [
        'enabled' => true,
        'channels' => ['mail', 'database'],
    ],
],
```

--------------------------------

### Use CommentsTableAction in Filament 3 table actions

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Add a comments action to your Filament 3 table's actions array.

```php
use Kirschbaum\Commentions\Filament\Actions\CommentsTableAction;

->actions([
    CommentsTableAction::make()
        ->mentionables(User::all())
])
```

--------------------------------

### render()

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/livewire-subscription-sidebar.md

Returns the commentions::subscription-sidebar view.

```APIDOC
## render()

### Description
Returns the commentions::subscription-sidebar view.

### Method
render

### Source
`src/Livewire/SubscriptionSidebar.php:28`
```

--------------------------------

### getComponentPrefix(): string

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/config.md

Returns the component prefix used for Livewire components. Returns 'commentions.' on Livewire 4+ and 'commentions::' otherwise.

```APIDOC
## getComponentPrefix(): string

### Description
Returns the component prefix used for Livewire components. Returns `'commentions.'` on Livewire 4+ and `'commentions::'` otherwise.

### Method
`getComponentPrefix`

### Parameters
None

### Return Value
`string` - The component prefix.

### Example
```php
$prefix = Commentions::getComponentPrefix();
```
```

--------------------------------

### Feature flags and model resolution methods

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/config.md

Provides configuration values for ratings, models, reactions, avatars, and avatar provider. Defaults are false for ratings, 5 for max rating, Comment::class for comment model, and ['👍'] for allowed reactions.

```php
public static function ratingsAreEnabled(): bool               // src/Config.php:57 — 'commentions.ratings.enabled', default false
public static function getMaxRating(): int                     // src/Config.php:62 — 'commentions.ratings.max', default 5
public static function getCommentModel(): string               // src/Config.php:90 — 'commentions.comment.model', default Comment::class
public static function getCommenterModel(): string             // src/Config.php:95 — 'commentions.commenter.model' (no default)
public static function getAllowedReactions(): array            // src/Config.php:100 — 'commentions.reactions.allowed', default ['👍']
public static function reactionsAreEnabled(): bool             // src/Config.php:105 — 'commentions.reactions.enabled', default true
public static function avatarsAreEnabled(): bool               // src/Config.php:110 — 'commentions.avatars.enabled', default true
public static function getAvatarProvider(): ?string            // src/Config.php:115 — 'commentions.avatar_provider' (default null)
```

--------------------------------

### Override toolbar buttons on CommentsEntry component

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use this to override the toolbar buttons for a specific CommentsEntry component. The method `toolbarButtons()` accepts an array of button names or groups.

```php
use Kirschbaum\Commentions\Filament\Infolists\Components\CommentsEntry;

CommentsEntry::make('comments')
    ->mentionables(fn (Model $record) => User::all())
    ->toolbarButtons([['bold', 'italic'], ['link']])
```

--------------------------------

### Override TipTap CSS classes on CommentsAction component

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use this to override the TipTap CSS classes for a CommentsAction component. The method `tipTapCssClasses()` accepts a string of CSS classes.

```php
use Kirschbaum\Commentions\Filament\Actions\CommentsAction;

CommentsAction::make()
    ->mentionables(User::all())
    ->tipTapCssClasses('prose max-w-none focus:outline-none p-4')
```

--------------------------------

### render() method

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/livewire-comment-list.md

Returns the commentions::comment-list view.

```php
public function render()
```

--------------------------------

### Override TipTap CSS classes on CommentsEntry component

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use this to override the TipTap CSS classes for a specific CommentsEntry component. The method `tipTapCssClasses()` accepts a string of CSS classes.

```php
use Kirschbaum\Commentions\Filament\Infolists\Components\CommentsEntry;

CommentsEntry::make('comments')
    ->mentionables(fn (Model $record) => User::all())
    ->tipTapCssClasses('prose max-w-none focus:outline-none p-4')
```

--------------------------------

### Toggle attachments per component with enableAttachments() and disableAttachments()

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Overrides the global attachments config for a specific component. The same methods are available on CommentsAction and CommentsTableAction. The condition can be a closure, as shown for admin-only enabling.

```php
use Kirschbaum\Commentions\Filament\Infolists\Components\CommentsEntry;

CommentsEntry::make('comments')->mentionables(User::all())->enableAttachments();
CommentsEntry::make('comments')->mentionables(User::all())->enableAttachments(fn () => auth()->user()->isAdmin());
CommentsEntry::make('comments')->mentionables(User::all())->disableAttachments();
```

--------------------------------

### Make comments readonly with readonly() method

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Chain the readonly() method on CommentsEntry, CommentsAction, or CommentsTableAction to make comments readonly. In readonly mode, users cannot add, edit, delete, or react to comments.

```php
// Make comments readonly
CommentsEntry::make()
    ->readonly()
    ->mentionables(User::all())

CommentsAction::make()
    ->readonly()
    ->mentionables(User::all())

CommentsTableAction::make()
    ->readonly()
    ->mentionables(User::all())

// You can also conditionally enable readonly mode
CommentsAction::make()
    ->readonly(auth()->user()->cannot('create', Comment::class))
    ->mentionables(User::all())
```

--------------------------------

### Register new assets: php artisan filament:upgrade

Source: https://github.com/kirschbaum-development/commentions/blob/main/UPGRADE.md

Run this command to register new assets after upgrading Commentions.

```bash
php artisan filament:upgrade
```

--------------------------------

### Override toolbar buttons on CommentsAction component

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Use this to override the toolbar buttons for a CommentsAction component. The method `toolbarButtons()` accepts an array of button names or groups. Pass an empty array to hide the toolbar for that component.

```php
use Kirschbaum\Commentions\Filament\Actions\CommentsAction;

CommentsAction::make()
    ->mentionables(User::all())
    ->toolbarButtons(['bold', 'italic', 'link'])
```

--------------------------------

### render(): View

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/livewire-reactions.md

Renders the reactions view for the comment. It passes the allowed reactions from the configuration to the view.

```APIDOC
## render(): View

### Description
Renders the reactions view for the comment. It passes the allowed reactions from the configuration to the view.

### Method
render

### Returns
- **View** - The `commentions::reactions` view

### Parameters
None

### Behavior
- Returns the `commentions::reactions` view.
- Passes `allowedReactions => Config::getAllowedReactions()` to the view.

### Source
`src/Livewire/Reactions.php:37`
```

--------------------------------

### Create a CommentSubscription

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/support-models.md

Creates a subscription for a project and user using firstOrCreate. The subscribable can be any morphable model. Access the subscribed project and subscriber user via the relationship methods.

```php
$subscription = CommentSubscription::query()->firstOrCreate([
    'subscribable_type' => $project->getMorphClass(),
    'subscribable_id' => $project->getKey(),
    'subscriber_type' => $user->getMorphClass(),
    'subscriber_id' => $user->getKey(),
]);

$subscription->subscribable(); // the project
$subscription->subscriber();   // the user
```

--------------------------------

### packageRegistered method

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/plugin-and-provider.md

Calls aliasTableAction() to class-alias Filament\Tables\Actions\Action to TableAction on Filament 3.

```php
public function packageRegistered(): void   // src/CommentionsServiceProvider.php:58
```

--------------------------------

### Livewire 4 component properties for subscription sidebar

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Control the subscription sidebar in Livewire 4 by setting sidebar-enabled and show-subscribers properties on the commentions.comments component. sidebar-enabled defaults to true; show-subscribers defaults to config('commentions.subscriptions.show_subscribers', true).

```php
// Hide the sidebar entirely
<livewire:commentions.comments :mentionables="App\Models\User::all()" :record="$record" :sidebar-enabled="false" />
```

```php
// Keep the sidebar, but hide the subscribers list (uses config default if omitted)
<livewire:commentions.comments :mentionables="App\Models\User::all()" :record="$record" :show-subscribers="false" />
```

--------------------------------

### Livewire 3 component properties for subscription sidebar

Source: https://github.com/kirschbaum-development/commentions/blob/main/README.md

Control the subscription sidebar in Livewire 3 by setting sidebar-enabled and show-subscribers properties on the commentions::comments component. sidebar-enabled defaults to true; show-subscribers defaults to config('commentions.subscriptions.show_subscribers', true).

```php
// Hide the sidebar entirely
<livewire:commentions::comments :mentionables="App\Models\User::all()" :record="$record" :sidebar-enabled="false" />
```

```php
// Keep the sidebar, but hide the subscribers list (uses config default if omitted)
<livewire:commentions::comments :mentionables="App\Models\User::all()" :record="$record" :show-subscribers="false" />
```

--------------------------------

### resolveTipTapCssClassesUsing

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/config.md

Registers a callback to resolve TipTap CSS classes.

```APIDOC
## resolveTipTapCssClassesUsing

### Description
Registers a callback to resolve TipTap CSS classes.

### Method
`public static function resolveTipTapCssClassesUsing(Closure $callback): void`

### Parameters
- `$callback` (Closure) - Required - The callback to register.

### Returns
void
```

--------------------------------

### Table name getters

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/config.md

Returns table names from configuration keys with defaults. Used for comments, comment reactions, comment subscriptions, and comment attachments.

```php
public static function getCommentTable(): string               // src/Config.php:42 — 'commentions.tables.comments', default 'comments'
public static function getCommentReactionTable(): string       // src/Config.php:47 — 'commentions.tables.comment_reactions', default 'comment_reactions'
public static function getCommentSubscriptionTable(): string   // src/Config.php:52 — 'commentions.tables.comment_subscriptions', default 'comment_subscriptions'
public static function getCommentAttachmentTable(): string     // src/Config.php:67 — 'commentions.tables.comment_attachments', default 'comment_attachments'
```

--------------------------------

### HasPolling::poll()

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/filament-concerns.md

Enables polling with the given interval string. For example, `poll('10s')`.

```APIDOC
## poll(string|Closure|null $interval = '60s'): static

### Description
Enables polling with the given interval string. For example, `poll('10s')`.

### Method
poll

### Signature
`poll(string|Closure|null $interval = '60s'): static`

### Parameters
- `$interval` (string|Closure|null) - Optional - Default: `'60s'`. The polling interval string.

### Returns
`static` - Returns the component instance for chaining.
```

--------------------------------

### resolveCommentUrl

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/config.md

Returns null for null comments; runs the registered callback, else null.

```APIDOC
## resolveCommentUrl

### Description
Returns null for null comments; runs the registered callback, else null.

### Method
`public static function resolveCommentUrl(?Comment $comment): ?string`

### Parameters
- `$comment` (?Comment) - Required - The comment to resolve URL for.

### Returns
- `?string` - The URL or null.
```

--------------------------------

### HasSidebar state machine properties and methods

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/livewire-concerns.md

Defines the subscription sidebar state machine with properties and methods for enabling the sidebar, showing subscribers, and handling subscription toggling. Includes computed properties for resolved settings and subscription status, plus renderless methods for refreshing and toggling subscriptions.

```php
public ?bool $sidebarEnabled = null;
public ?bool $showSubscribers = null;

public function mountHasSidebar(?bool $sidebarEnabled = null, ?bool $showSubscribers = null): void  // :18
#[Computed] public function resolvedSidebarEnabled(): bool      // :26 — sidebarEnabled ?? true
#[Computed] public function resolvedShowSubscribers(): bool     // :32 — showSubscribers ?? config(..., true)
#[Computed] public function isSubscribed(): bool               // :38 — record->isSubscribed(current user)
#[Computed] public function canSubscribe(): bool                // :50 — current user !== null
#[Computed] public function subscribers(): Collection           // :56 — record->getSubscribers()
#[Renderless] public function refreshSubscribers(): void        // :62
#[Renderless] public function toggleSubscription(): void        // :69 — subscribe/unsubscribe + Notification + dispatch 'commentions:subscription:toggled' to the sidebar component
protected function getCurrentUser(): ?Commenter                 // :103 — Config::resolveAuthenticatedUser()
```

--------------------------------

### mountHasSidebar(?bool $sidebarEnabled = null, ?bool $showSubscribers = null)

Source: https://github.com/kirschbaum-development/commentions/blob/main/_autodocs/api-reference/livewire-subscription-sidebar.md

Initializes sidebarEnabled and showSubscribers from config.

```APIDOC
## mountHasSidebar(?bool $sidebarEnabled = null, ?bool $showSubscribers = null)

### Description
Initializes sidebarEnabled and showSubscribers from config.

### Method
mountHasSidebar

### Parameters
- `$sidebarEnabled` (?bool) - Optional - Default null
- `$showSubscribers` (?bool) - Optional - Default null
```
Tokens:
Raw