> ## Documentation Index > Fetch the complete documentation index at: https://filamentphp.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Testing export const EditOnGitHub = ({version, path}) => { const url = `https://github.com/filamentphp/filament/edit/${version}/${path}`; return
Edit this page on GitHub
; }; export const Footer = () => { const sponsorsByTier = JSON.parse(`{ "agency_partner": [ { "name": "Kirschbaum", "url": "https://kirschbaumdevelopment.com/solutions/filament-development", "filename": "kirschbaum.svg" } ], "gold": [ { "name": "Agiledrop", "url": "https://www.agiledrop.com/laravel?utm_source=filament", "filename": "agiledrop.svg" }, { "name": "Baiz.ai", "url": "https://baiz.ai", "filename": "baiz-ai.svg" }, { "name": "CMS Max", "url": "https://cmsmax.com?ref=filamentphp.com", "filename": "cms-max.svg" }, { "name": "Mailtrap", "url": "https://mailtrap.io/email-sending?utm_source=community&utm_medium=referral&utm_campaign=filament", "filename": "mailtrap.svg" }, { "name": "SerpApi", "url": "https://serpapi.com/?utm_source=filamentphp", "filename": "serpapi.svg" } ] }`); function shuffleArray(items) { const result = [...items]; for (let index = result.length - 1; index > 0; index--) { const randomIndex = Math.floor(Math.random() * (index + 1)); [result[index], result[randomIndex]] = [result[randomIndex], result[index]]; } return result; } const sponsors = Object.entries(sponsorsByTier).flatMap(([, sponsors]) => shuffleArray(sponsors)); return

Sponsored by

{sponsors.map(sponsor => {sponsor.name} )} Your logo here
; }; You are currently viewing the documentation for Filament 2.x, which is a previous version of Filament. Looking for the current stable version? Visit the [5.x documentation](/docs/5.x/tables). All examples in this guide will be written using [Pest](https://pestphp.com). However, you can easily adapt this to PHPUnit. Since the table builder works on Livewire components, you can use the [Livewire testing helpers](https://laravel-livewire.com/docs/testing). However, we have many custom testing helpers that you can use for tables: ## Render To ensure a table component renders, use the `assertSuccessful()` Livewire helper: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can render page', function () { livewire(ListPosts::class)->assertSuccessful(); }); ``` To to test which records are shown, you can use `assertCanSeeTableRecords()`, `assertCanNotSeeTableRecords()` and `assertCountTableRecords()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('cannot display trashed posts by default', function () { $posts = Post::factory()->count(4)->create(); $trashedPosts = Post::factory()->trashed()->count(6)->create(); livewire(PostResource\Pages\ListPosts::class) ->assertCanSeeTableRecords($posts) ->assertCanNotSeeTableRecords($trashedPosts) ->assertCountTableRecords(4); }); ``` > Note that if your table uses pagination, `assertCanSeeTableRecords()` will only check for records on the first page. To switch page, call `set('page', 2)`. > Note that if your table uses `deferLoading()`, you should call `loadTable()` before `assertCanSeeTableRecords()`. ## Columns To ensure that a certain column is rendered, pass the column name to `assertCanRenderTableColumn()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can render post titles', function () { Post::factory()->count(10)->create(); livewire(PostResource\Pages\ListPosts::class) ->assertCanRenderTableColumn('title'); }); ``` This helper will get the HTML for this column, and check that it is present in the table. For testing that a column is not rendered, you can use `assertCanNotRenderTableColumn()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can not render post comments', function () { Post::factory()->count(10)->create() livewire(PostResource\Pages\ListPosts::class) ->assertCanNotRenderTableColumn('comments'); }); ``` This helper will assert that the HTML for this column, is not shown by default in the present table. ### Sorting To sort table records, you can call `sortTable()`, passing the name of the column to sort by. You can use `'desc'` in the second parameter of `sortTable()` to reverse the sorting direction. Once the table is sorted, you can ensure that the table records are rendered in order using `assertCanSeeTableRecords()` with the `inOrder` parameter: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can sort posts by title', function () { $posts = Post::factory()->count(10)->create(); livewire(PostResource\Pages\ListPosts::class) ->sortTable('title') ->assertCanSeeTableRecords($posts->sortBy('title'), inOrder: true) ->sortTable('title', 'desc') ->assertCanSeeTableRecords($posts->sortByDesc('title'), inOrder: true); }); ``` ### Searching To search the table, call the `searchTable()` method with your search query. You can then use `assertCanSeeTableRecords()` to check your filtered table records, and use `assertCanNotSeeTableRecords()` to assert that some records are no longer in the table: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can search posts by title', function () { $posts = Post::factory()->count(10)->create(); $title = $posts->first()->title; livewire(PostResource\Pages\ListPosts::class) ->searchTable($title) ->assertCanSeeTableRecords($posts->where('title', $title)) ->assertCanNotSeeTableRecords($posts->where('title', '!=', $title)); }); ``` To search individual columns, you can pass an array of searches to `searchTableColumns()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can search posts by title column', function () { $posts = Post::factory()->count(10)->create(); $title = $posts->first()->title; livewire(PostResource\Pages\ListPosts::class) ->searchTableColumns(['title' => $title]) ->assertCanSeeTableRecords($posts->where('title', $title)) ->assertCanNotSeeTableRecords($posts->where('title', '!=', $title)); }); ``` ### State To assert that a certain column has a state or does not have a state for a record you can use `assertTableColumnStateSet()` and `assertTableColumnStateNotSet()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can get post author names', function () { $posts = Post::factory()->count(10)->create(); $post = $posts->first(); livewire(PostResource\Pages\ListPosts::class) ->assertTableColumnStateSet('author.name', $post->author->name, record: $post) ->assertTableColumnStateNotSet('author.name', 'Anonymous', record: $post); }); ``` To assert that a certain column has a formatted state or does not have a formatted state for a record you can use `assertTableColumnFormattedStateSet()` and `assertTableColumnFormattedStateNotSet()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can get post author names', function () { $post = Post::factory(['name' => 'John Smith'])->create(); livewire(PostResource\Pages\ListPosts::class) ->assertTableColumnFormattedStateSet('author.name', 'Smith, John', record: $post) ->assertTableColumnFormattedStateNotSet('author.name', $post->author->name, record: $post); }); ``` ### Existence To ensure that a column exists, you can use the `assertTableColumnExists()` method: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('has an author column', function () { livewire(PostResource\Pages\ListPosts::class) ->assertTableColumnExists(`author`); }); ``` ### Authorization To ensure that a particular user cannot see a column, you can use the `assertTableColumnVisible()` and `assertTableColumnHidden()` methods: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('shows the correct columns', function () { livewire(PostResource\Pages\ListPosts::class) ->assertTableColumnVisible(`created_at`) ->assertTableColumnHidden(`author`); }); ``` ### Descriptions To ensure a column has the correct description above or below you can use the `assertTableColumnHasDescription()` and `assertTableColumnDoesNotHaveDescription()` methods: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('has the correct descriptions above and below author', function () { $post = Post::factory()->create(); livewire(PostsTable::class) ->assertTableColumnHasDescription('author', 'Author! ↓↓↓', $post, 'above') ->assertTableColumnHasDescription('author', 'Author! ↑↑↑', $post) ->assertTableColumnDoesNotHaveDescription('author', 'Author! ↑↑↑', $post, 'above') ->assertTableColumnDoesNotHaveDescription('author', 'Author! ↓↓↓', $post); }); ``` ### Extra Attributes To ensure that a column has the correct extra attributes you can use the `assertTableColumnHasExtraAttributes()` and `assertTableColumnDoesNotHaveExtraAttributes()` methods: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('displays author in red', function () { $post = Post::factory()->create(); livewire(PostsTable::class) ->assertTableColumnHasExtraAttributes('author', ['class' => 'text-danger-500'], $post) ->assertTableColumnDoesNotHaveExtraAttributes('author', ['class' => 'text-primary-500'], $post); }); ``` ### Select Columns If you have a select column, you can ensure it has the correct options with `assertSelectColumnHasOptions()` and `assertSelectColumnDoesNotHaveOptions()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('has the correct statuses', function () { $post = Post::factory()->create(); livewire(PostsTable::class) ->assertSelectColumnHasOptions('status', ['unpublished' => 'Unpublished', 'published' => 'Published'], $post) ->assertSelectColumnDoesNotHaveOptions('status', ['archived' => 'Archived'], $post); }); ``` ## Filters To filter the table records, you can use the `filterTable()` method, along with `assertCanSeeTableRecords()` and `assertCanNotSeeTableRecords()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can filter posts by `is_published`', function () { $posts = Post::factory()->count(10)->create(); livewire(PostResource\Pages\ListPosts::class) ->assertCanSeeTableRecords($posts) ->filterTable('is_published') ->assertCanSeeTableRecords($posts->where('is_published', true)) ->assertCanNotSeeTableRecords($posts->where('is_published', false)); }); ``` For a simple filter, this will just enable the filter. If you'd like to set the value of a `SelectFilter` or `TernaryFilter`, pass the value as a second argument: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can filter posts by `author_id`', function () { $posts = Post::factory()->count(10)->create(); $authorId = $posts->first()->author_id; livewire(PostResource\Pages\ListPosts::class) ->assertCanSeeTableRecords($posts) ->filterTable('author_id', $authorId) ->assertCanSeeTableRecords($posts->where('author_id', $authorId)) ->assertCanNotSeeTableRecords($posts->where('author_id', '!=', $authorId)); }); ``` ### Resetting filters To reset all filters to their original state, call `resetTableFilters()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can reset table filters`', function () { $posts = Post::factory()->count(10)->create(); livewire(PostResource\Pages\ListPosts::class) ->resetTableFilters(); }); ``` ### Removing Filters To remove a single filter you can use `removeTableFilter()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('filters list by published', function () { $posts = Post::factory()->count(10)->create(); $unpublishedPosts = $posts->where('is_published', false)->get(); livewire(PostsTable::class) ->filterTable('is_published') ->assertCanNotSeeTableRecords($unpublishedPosts) ->removeTableFilter('is_published') ->assertCanSeeTableRecords($posts); }); ``` To remove all filters you can use `removeTableFilters()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can remove all table filters', function () { $posts = Post::factory()->count(10)->forAuthor()->create(); $unpublishedPosts = $posts ->where('is_published', false) ->where('author_id', $posts->first()->author->getKey()); livewire(PostsTable::class) ->filterTable('is_published') ->filterTable('author', $author) ->assertCanNotSeeTableRecords($unpublishedPosts) ->removeTableFilters() ->assertCanSeeTableRecords($posts); }); ``` ## Actions ### Calling actions You can call an action by passing its name or class to `callTableAction()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can delete posts', function () { $post = Post::factory()->create(); livewire(PostResource\Pages\ListPosts::class) ->callTableAction(DeleteAction::class, $post); $this->assertModelMissing($post); }); ``` This example assumes that you have a `DeleteAction` on your table. If you have a custom `Action::make('reorder')`, you may use `callTableAction('reorder')`. For column actions, you may do the same, using `callTableColumnAction()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can copy posts', function () { $post = Post::factory()->create(); livewire(PostResource\Pages\ListPosts::class) ->callTableColumnAction('copy', $post); $this->assertDatabaseCount((new Post)->getTable(), 2); }); ``` For bulk actions, you may do the same, passing in multiple records to execute the bulk action against with `callTableBulkAction()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can bulk delete posts', function () { $posts = Post::factory()->count(10)->create(); livewire(PostResource\Pages\ListPosts::class) ->callTableBulkAction(DeleteBulkAction::class, $posts); foreach ($posts as $post) { $this->assertModelMissing($post); } }); ``` To pass an array of data into an action, use the `data` parameter: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can edit posts', function () { $post = Post::factory()->create(); livewire(PostResource\Pages\ListPosts::class) ->callTableAction(EditAction::class, $post, data: [ 'title' => $title = fake()->words(asText: true), ]) ->assertHasNoTableActionErrors(); expect($post->refresh()) ->title->toBe($title); }); ``` ### Execution To check if an action or bulk action has been halted, you can use `assertTableActionHalted()` / `assertTableBulkActionHalted()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('will halt delete if post is flagged', function () { $posts= Post::factory()->count(2)->flagged()->create(); livewire(PostResource\Pages\ListPosts::class) ->callTableAction('delete', $posts->first()) ->callTableBulkAction('delete', $posts) ->assertTableActionHalted('delete') ->assertTableBulkActionHalted('delete'); $this->assertModelExists($post); }); ``` ### Errors `assertHasNoTableActionErrors()` is used to assert that no validation errors occurred when submitting the action form. To check if a validation error has occurred with the data, use `assertHasTableActionErrors()`, similar to `assertHasErrors()` in Livewire: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can validate edited post data', function () { $post = Post::factory()->create(); livewire(PostResource\Pages\ListPosts::class) ->callTableAction(EditAction::class, $post, data: [ 'title' => null, ]) ->assertHasTableActionErrors(['title' => ['required']]); }); ``` For bulk actions these methods are called `assertHasTableBulkActionErrors()` and `assertHasNoTableBulkActionErrors()`. ### Pre-filled data To check if an action or bulk action is pre-filled with data, you can use the `assertTableActionDataSet()` or `assertTableBulkActionDataSet()` method: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can load existing post data for editing', function () { $post = Post::factory()->create(); livewire(PostResource\Pages\ListPosts::class) ->mountTableAction(EditAction::class, $post) ->assertTableActionDataSet([ 'title' => $post->title, ]) ->setTableActionData([ 'title' => $title = fake()->words(asText: true), ]) ->callMountedTableAction() ->assertHasNoTableActionErrors(); expect($post->refresh()) ->title->toBe($title); }); ``` ### Action state To ensure that an action or bulk action exists or doesn't in a table, you can use the `assertTableActionExists()` / `assertTableActionDoesNotExist()` or `assertTableBulkActionExists()` / `assertTableBulkActionDoesNotExist()` method: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can publish but not unpublish posts', function () { livewire(PostResource\Pages\ListPosts::class) ->assertTableActionExists('publish') ->assertTableActionDoesNotExist('unpublish') ->assertTableBulkActionExists('publish') ->assertTableBulkActionDoesNotExist('unpublish'); }); ``` To ensure different sets of actions exist in the correct order, you can use the various "InOrder" assertions ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('has all actions in expected order', function () { livewire(PostResource\Pages\ListPosts::class) ->assertTableActionsExistInOrder(['edit', 'delete']) ->assertTableBulkActionsExistInOrder(['restore', 'forceDelete']) ->assertTableHeaderActionsExistInOrder(['create', 'attach']) ->assertTableEmptyStateActionsExistInOrder(['create', 'toggle-trashed-filter']) }); ``` To ensure that an action or bulk action is enabled or disabled for a user, you can use the `assertTableActionEnabled()` / `assertTableActionDisabled()` or `assertTableBulkActionEnabled()` / `assertTableBulkActionDisabled()` methods: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can not publish, but can delete posts', function () { $post = Post::factory()->create(); livewire(PostResource\Pages\ListPosts::class) ->assertTableActionDisabled('publish', $post) ->assertTableActionEnabled('delete', $post) ->assertTableBulkActionDisabled('publish') ->assertTableBulkActionEnabled('delete'); }); ``` To ensure that an action or bulk action is visible or hidden for a user, you can use the `assertTableActionVisible()` / `assertTableActionHidden()` or `assertTableBulkActionVisible()` / `assertTableBulkActionHidden()` methods: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('can not publish, but can delete posts', function () { $post = Post::factory()->create(); livewire(PostResource\Pages\ListPosts::class) ->assertTableActionHidden('publish', $post) ->assertTableActionVisible('delete', $post) ->assertTableBulkActionHidden('publish') ->assertTableBulkActionVisible('delete'); }); ``` ### Button Style To ensure an action or bulk action has the correct label, you can use `assertTableActionHasLabel()` / `assertTableBulkActionHasLabel()` and `assertTableActionDoesNotHaveLabel()` / `assertTableBulkActionDoesNotHaveLabel()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('delete actions have correct labels', function () { $post = Post::factory()->create(); livewire(PostResource\Pages\ListPosts::class) ->assertTableActionHasLabel('delete', 'Archive Post') ->assertTableActionDoesNotHaveLabel('delete', 'Delete'); ->assertTableBulkActionHasLabel('delete', 'Archive Post') ->assertTableBulkActionDoesNotHaveLabel('delete', 'Delete'); }); ``` To ensure an action or bulk action's button is showing the correct icon, you can use `assertTableActionHasIcon()` / `assertTableBulkActionHasIcon()` or `assertTableActionDoesNotHaveIcon()` / `assertTableBulkActionDoesNotHaveIcon()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('delete actions have correct icons', function () { $post = Post::factory()->create(); livewire(PostResource\Pages\ListPosts::class) ->assertTableActionHasIcon('delete', 'heroicon-o-archive-box') ->assertTableActionDoesNotHaveIcon('delete', 'heroicon-o-trash'); ->assertTableBulkActionHasIcon('delete', 'heroicon-o-archive-box') ->assertTableBulkActionDoesNotHaveIcon('delete', 'heroicon-o-trash'); }); ``` To ensure an action or bulk action's button is displaying the right color, you can use `assertTableActionHasColor()` / `assertTableBulkActionHasColor()` or `assertTableActionDoesNotHaveColor()` / `assertTableBulkActionDoesNotHaveColor()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('delete actions have correct colors', function () { $post = Post::factory()->create(); livewire(PostResource\Pages\ListPosts::class) ->assertTableActionHasColor('delete', 'warning') ->assertTableActionDoesNotHaveColor('delete', 'danger'); ->assertTableBulkActionHasColor('delete', 'warning') ->assertTableBulkActionDoesNotHaveColor('delete', 'danger'); }); ``` ### URL To ensure an action or bulk action has the correct URL traits, you can use `assertTableActionHasUrl()`, `assertTableActionDoesNotHaveUrl()`, `assertTableActionShouldOpenUrlInNewTab()`, and `assertTableActionShouldNotOpenUrlInNewTab()`: ```php theme={"theme":"gruvbox-dark-hard"} use function Pest\Livewire\livewire; it('links to the correct Filament sites', function () { $post = Post::factory()->create(); livewire(PostResource\Pages\ListPosts::class) ->assertTableActionHasUrl('filament', 'https://filamentphp.com/') ->assertTableActionDoesNotHaveUrl('filament', 'https://github.com/filamentphp/filament') ->assertTableActionShouldOpenUrlInNewTab('filament') ->assertTableActionShouldNotOpenUrlInNewTab('github'); }); ```