ISSUE-38: Add pagination support for comments (#40)

* Add pagination support for comments

* Add test script to composer.json and update CommentsTest to throw TypeError

* Update perPageIncrement to correctly fallback to perPage

* Style Fix

Author: navneetrai

README.md

@@ -130,6 +130,59 @@ You can publish the configuration file to make changes.
 php artisan vendor:publish --tag="commentions-config"
 ```
 
+#### Pagination (Filament)
+
+Commentions supports built-in pagination for the embedded list of comments and it is enabled by default. You can disable it or control the number of comments shown per page and per click.
+
+- Enabled by default
+- Disable via `disablePagination()`
+- Configure page size
+- Customize the load more label
+- Control how many comments are appended per click (defaults to the page size)
+
+Examples:
+
+Default Usage:
+
+```php
+use Kirschbaum\Commentions\Filament\Actions\CommentsAction;
+
+->recordActions([
+    CommentsAction::make()
+        ->mentionables(User::all())
+        ->perPage(10)
+        
+])
+```
+Without Pagination:
+
+```php
+use Kirschbaum\Commentions\Filament\Actions\CommentsAction;
+
+->recordActions([
+    CommentsAction::make()
+        ->mentionables(User::all())
+        ->disablePagination();
+        
+])
+```
+Advanced Usage:
+
+```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'),
+    ])
+```
+
+When pagination is enabled, a "Show more" button is displayed to load additional comments incrementally.
+
 #### Configuring the User model and the mentionables
 
 If your `User` model lives in a different namespace than `App\Models\User`, you can configure it in `config/commentions.php`:

composer.json

@@ -52,6 +52,7 @@
         }
     },
     "scripts": {
+        "test": "vendor/bin/pest",
         "fix-style": "./vendor/bin/pint --config pint.json",
         "check-style": "./vendor/bin/pint --config pint.json --test",
         "static-analysis": "./vendor/bin/phpstan analyse -c phpstan.neon"

resources/views/comment-list.blade.php

@@ -21,4 +21,16 @@ class="comm:w-8 comm:h-8 comm:text-gray-400 comm:dark:text-gray-500"
             :mentionables="$mentionables"
         />
     @endforeach
+
+    @if ($this->hasMore)
+        <div class="comm:mt-2">
+            <x-filament::button
+                color="gray"
+                size="sm"
+                wire:click="loadMore"
+                wire:target="loadMore"
+                wire:loading.attr="disabled"
+            >{{ $loadMoreLabel }}</x-filament::button>
+        </div>
+    @endif
 </div>

resources/views/comments-modal.blade.php

@@ -4,5 +4,9 @@
         :record="$record"
         :mentionables="$mentionables"
         :polling-interval="$pollingInterval"
+        :paginate="$paginate ?? true"
+        :per-page="$perPage ?? 5"
+        :load-more-label="$loadMoreLabel ?? 'Show more'"
+        :per-page-increment="$perPageIncrement ?? null"
     />
 </div>

resources/views/comments.blade.php

@@ -34,5 +34,9 @@
         :record="$record"
         :mentionables="$this->mentions"
         :polling-interval="$pollingInterval"
+        :paginate="$paginate ?? true"
+        :per-page="$perPage ?? 5"
+        :load-more-label="$loadMoreLabel ?? 'Show more'"
+        :per-page-increment="$perPageIncrement ?? null"
     />
 </div>

resources/views/filament/infolists/components/comments-entry.blade.php

@@ -3,5 +3,9 @@
         :record="$getRecord()"
         :mentionables="$getMentionables()"
         :polling-interval="$getPollingInterval()"
+        :paginate="$isPaginated()"
+        :per-page="$getPerPage()"
+        :load-more-label="$getLoadMoreLabel()"
+        :per-page-increment="$getPerPageIncrement()"
     />
 </x-dynamic-component>

src/Filament/Actions/CommentsAction.php

@@ -5,11 +5,13 @@
 use Filament\Actions\Action;
 use Illuminate\Database\Eloquent\Model;
 use Kirschbaum\Commentions\Filament\Concerns\HasMentionables;
+use Kirschbaum\Commentions\Filament\Concerns\HasPagination;
 use Kirschbaum\Commentions\Filament\Concerns\HasPolling;
 
 class CommentsAction extends Action
 {
     use HasMentionables;
+    use HasPagination;
     use HasPolling;
 
     protected function setUp(): void
@@ -22,6 +24,10 @@ protected function setUp(): void
                 'record' => $record,
                 'mentionables' => $this->getMentionables(),
                 'pollingInterval' => $this->getPollingInterval(),
+                'paginate' => $this->isPaginated(),
+                'perPage' => $this->getPerPage(),
+                'loadMoreLabel' => $this->getLoadMoreLabel(),
+                'perPageIncrement' => $this->getPerPageIncrement() ?: $this->getPerPage(),
             ]))
             ->modalWidth('xl')
             ->label('Comments')

src/Filament/Concerns/HasPagination.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Kirschbaum\Commentions\Filament\Concerns;
+
+use Closure;
+
+trait HasPagination
+{
+    protected bool|Closure $paginate = true;
+
+    protected int|Closure $perPage = 5;
+
+    protected string|Closure $loadMoreLabel = 'Show more';
+
+    protected int|Closure|null $perPageIncrement = null;
+
+    public function paginate(bool|Closure $enabled = true): static
+    {
+        $this->paginate = $enabled;
+
+        return $this;
+    }
+
+    public function disablePagination(): static
+    {
+        return $this->paginate(false);
+    }
+
+    public function perPage(int|Closure $perPage): static
+    {
+        $this->perPage = $perPage;
+
+        return $this;
+    }
+
+    public function loadMoreLabel(string|Closure $label): static
+    {
+        $this->loadMoreLabel = $label;
+
+        return $this;
+    }
+
+    public function loadMoreIncrementsBy(int|Closure $increment): static
+    {
+        $this->perPageIncrement = $increment;
+
+        return $this;
+    }
+
+    public function isPaginated(): bool
+    {
+        return (bool) $this->evaluate($this->paginate);
+    }
+
+    public function getPerPage(): int
+    {
+        return (int) $this->evaluate($this->perPage);
+    }
+
+    public function getLoadMoreLabel(): string
+    {
+        return (string) $this->evaluate($this->loadMoreLabel);
+    }
+
+    public function getPerPageIncrement(): int
+    {
+        $value = $this->evaluate($this->perPageIncrement);
+
+        return (int) ($value ?? $this->getPerPage());
+    }
+}

src/Filament/Infolists/Components/CommentsEntry.php

@@ -4,11 +4,13 @@
 
 use Filament\Infolists\Components\Entry;
 use Kirschbaum\Commentions\Filament\Concerns\HasMentionables;
+use Kirschbaum\Commentions\Filament\Concerns\HasPagination;
 use Kirschbaum\Commentions\Filament\Concerns\HasPolling;
 
 class CommentsEntry extends Entry
 {
     use HasMentionables;
+    use HasPagination;
     use HasPolling;
 
     protected string $view = 'commentions::filament.infolists.components.comments-entry';

src/HasComments.php

@@ -14,16 +14,20 @@ public function comments(): MorphMany
         return $this->morphMany(Config::getCommentModel(), 'commentable');
     }
 
+    public function commentsQuery(): MorphMany
+    {
+        return $this->comments()
+            ->latest()
+            ->with(['author', 'reactions.reactor']);
+    }
+
     public function comment(string $body, ?Commenter $author): Comment
     {
         return SaveComment::run($this, $author, $body);
     }
 
     public function getComments(): Collection
     {
-        return $this->comments()
-            ->latest()
-            ->with(['author', 'reactions.reactor'])
-            ->get();
+        return $this->commentsQuery()->get();
     }
 }