Add direction argument to table defaultGroup()

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Author: tanthammar

packages/tables/docs/07-grouping.md

@@ -25,6 +25,20 @@ public function table(Table $table): Table
 
 <AutoScreenshot name="tables/grouping" alt="Table with grouping" version="4.x" />
 
+You may also pass a sort direction to the `defaultGroup()` method:
+
+```php
+use Filament\Tables\Table;
+
+public function table(Table $table): Table
+{
+    return $table
+        ->defaultGroup('status', direction: 'desc');
+}
+```
+
+The second parameter is optional and defaults to `'asc'`.
+
 ## Allowing users to choose between groupings
 
 You may also allow users to pick between different groupings, by passing them in an array to the `groups()` method:

packages/tables/src/Concerns/CanGroupRecords.php

@@ -61,7 +61,7 @@ protected function applyGroupingToTableQuery(Builder $query): Builder
 
         $group->applyEagerLoading($query);
 
-        $group->orderQuery($query, $this->getTableGroupingDirection() ?? 'asc');
+        $group->orderQuery($query, $this->getTableGroupingDirection() ?? $this->getTable()->getDefaultGroupDirection());
 
         return $query;
     }

packages/tables/src/Concerns/InteractsWithTable.php

@@ -92,7 +92,7 @@ public function bootedInteractsWithTable(): void
         }
 
         if ($this->getTable()->isDefaultGroupSelectable()) {
-            $this->tableGrouping = "{$this->getTable()->getDefaultGroup()->getId()}:asc";
+            $this->tableGrouping = "{$this->getTable()->getDefaultGroup()->getId()}:{$this->getTable()->getDefaultGroupDirection()}";
         }
 
         $shouldPersistSearchInSession = $this->getTable()->persistsSearchInSession();

packages/tables/src/Table/Concerns/CanGroupRecords.php

@@ -8,11 +8,14 @@
 use Filament\Support\Icons\Heroicon;
 use Filament\Tables\Grouping\Group;
 use Filament\Tables\View\TablesIconAlias;
+use Illuminate\Support\Str;
 
 trait CanGroupRecords
 {
     protected string | Group | Closure | null $defaultGroup = null;
 
+    protected string | Closure | null $defaultGroupDirection = 'asc';
+
     /**
      * @var array<string, Group>
      */
@@ -80,9 +83,10 @@ public function collapsedGroupsByDefault(bool | Closure $condition = true): stat
         return $this;
     }
 
-    public function defaultGroup(string | Group | Closure | null $group): static
+    public function defaultGroup(string | Group | Closure | null $group, string | Closure | null $direction = 'asc'): static
     {
         $this->defaultGroup = $group;
+        $this->defaultGroupDirection = $direction;
 
         return $this;
     }
@@ -179,6 +183,11 @@ public function getDefaultGroup(): ?Group
             ->table($this);
     }
 
+    public function getDefaultGroupDirection(): string
+    {
+        return Str::lower($this->evaluate($this->defaultGroupDirection) ?? 'asc');
+    }
+
     /**
      * @return array<string, Group>
      */

tests/src/Fixtures/Livewire/DefaultGroupedPostsTable.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Filament\Tests\Fixtures\Livewire;
+
+use Filament\Actions\Concerns\InteractsWithActions;
+use Filament\Actions\Contracts\HasActions;
+use Filament\Schemas\Concerns\InteractsWithSchemas;
+use Filament\Schemas\Contracts\HasSchemas;
+use Filament\Tables;
+use Filament\Tables\Table;
+use Filament\Tests\Fixtures\Models\Post;
+use Illuminate\Contracts\View\View;
+use Livewire\Component;
+
+class DefaultGroupedPostsTable extends Component implements HasActions, HasSchemas, Tables\Contracts\HasTable
+{
+    use InteractsWithActions;
+    use InteractsWithSchemas;
+    use Tables\Concerns\InteractsWithTable;
+
+    public function table(Table $table): Table
+    {
+        return $table
+            ->query(Post::query())
+            ->groups([
+                Tables\Grouping\Group::make('title'),
+            ])
+            ->defaultGroup('title', 'desc')
+            ->columns([
+                Tables\Columns\TextColumn::make('title'),
+            ]);
+    }
+
+    public function render(): View
+    {
+        return view('livewire.table');
+    }
+}

tests/src/Tables/GroupingTest.php

@@ -1,6 +1,7 @@
 <?php
 
 use Filament\Tables\Grouping\Group;
+use Filament\Tests\Fixtures\Livewire\DefaultGroupedPostsTable;
 use Filament\Tests\Fixtures\Livewire\GroupedCustomDataTable;
 use Filament\Tests\Fixtures\Livewire\PostsTable;
 use Filament\Tests\Fixtures\Livewire\PostsTableWithoutSummarizers;
@@ -55,6 +56,32 @@
         });
 });
 
+it('can group records by a default group in descending order', function (): void {
+    Post::factory()->create(['title' => 'Apple Post']);
+    Post::factory()->create(['title' => 'Cherry Post']);
+    Post::factory()->create(['title' => 'Banana Post']);
+
+    $sortedPosts = Post::query()->orderByDesc('title')->orderBy('id')->get();
+
+    livewire(DefaultGroupedPostsTable::class)
+        ->assertSet('tableGrouping', 'title:desc')
+        ->assertCanSeeTableRecords($sortedPosts, inOrder: true);
+});
+
+it('can set a `defaultGroup()` direction and get with `getDefaultGroupDirection()`', function (): void {
+    $livewire = livewire(PostsTable::class)->instance();
+    $table = $livewire->getTable();
+
+    expect($table->defaultGroup('title', 'DESC')->getDefaultGroupDirection())->toBe('desc');
+});
+
+it('defaults the `defaultGroup()` direction to ascending', function (): void {
+    $livewire = livewire(PostsTable::class)->instance();
+    $table = $livewire->getTable();
+
+    expect($table->defaultGroup('title')->getDefaultGroupDirection())->toBe('asc');
+});
+
 it('can group records by column', function (): void {
     // Create posts with different titles to group by
     Post::factory()->create(['title' => 'Apple Post']);