Building a Filament integration | laravel-site-search | Spatie

 SPATIE

  Laravel Site Search
======================

spatie.be/open-source

  [Docs](https://spatie.be/docs)  [Laravel-site-search](https://spatie.be/docs/laravel-site-search/v3)  Advanced-usage  Building a Filament integration

 Version   v3   v1

 Other versions for crawler [v3](https://spatie.be/docs/laravel-site-search/v3) [v1](https://spatie.be/docs/laravel-site-search/v1)

- [ Introduction ](https://spatie.be/docs/laravel-site-search/v3/introduction)
- [ Support us ](https://spatie.be/docs/laravel-site-search/v3/support-us)
- [ Requirements ](https://spatie.be/docs/laravel-site-search/v3/requirements)
- [ Installation and setup ](https://spatie.be/docs/laravel-site-search/v3/installation-setup)
- [ About us ](https://spatie.be/docs/laravel-site-search/v3/about-us)
- [ Questions and issues ](https://spatie.be/docs/laravel-site-search/v3/questions-issues)
- [ Changelog ](https://spatie.be/docs/laravel-site-search/v3/changelog)

Basic usage
-----------

- [ High level overview ](https://spatie.be/docs/laravel-site-search/v3/basic-usage/high-level-overview)
- [ Indexing your first site ](https://spatie.be/docs/laravel-site-search/v3/basic-usage/indexing-your-first-site)
- [ Retrieving results ](https://spatie.be/docs/laravel-site-search/v3/basic-usage/retrieving-results)
- [ Preventing content from being indexed ](https://spatie.be/docs/laravel-site-search/v3/basic-usage/preventing-content-from-being-indexed)
- [ Using a search profile ](https://spatie.be/docs/laravel-site-search/v3/basic-usage/using-a-search-profile)
- [ Listing indexes ](https://spatie.be/docs/laravel-site-search/v3/basic-usage/listing-indexes)
- [ Troubleshooting ](https://spatie.be/docs/laravel-site-search/v3/basic-usage/troubleshooting)

Advanced usage
--------------

- [ Creating multiple search indexes ](https://spatie.be/docs/laravel-site-search/v3/advanced-usage/creating-multiple-search-indexes)
- [ Using a custom indexer ](https://spatie.be/docs/laravel-site-search/v3/advanced-usage/using-a-custom-indexer)
- [ Indexing extra properties ](https://spatie.be/docs/laravel-site-search/v3/advanced-usage/indexing-extra-properties)
- [ Available events ](https://spatie.be/docs/laravel-site-search/v3/advanced-usage/available-events)
- [ Using the database driver ](https://spatie.be/docs/laravel-site-search/v3/advanced-usage/using-the-database-driver)
- [ Using the Meilisearch driver ](https://spatie.be/docs/laravel-site-search/v3/advanced-usage/using-the-meilisearch-driver)
- [ Building a Filament integration ](https://spatie.be/docs/laravel-site-search/v3/advanced-usage/filament-integration)

 Building a Filament integration
===============================

###  On this page

1. [ The resource class ](#content-the-resource-class)
2. [ The list page ](#content-the-list-page)
3. [ The view page ](#content-the-view-page)
4. [ The view template ](#content-the-view-template)

This package does not ship with a Filament integration, but it's straightforward to build one yourself. Below is a complete example of a Filament resource that lets you browse your search indexes and test queries from the admin panel.

The resource class
--------------------------------------------------------------------------------------------------------------

Create a `SiteSearchConfigResource` that provides a read-only overview of all configured search indexes.

```
namespace App\Filament\Resources;

use Exception;
use Filament\Resources\Resource;
use Filament\Tables;
use Filament\Tables\Table;
use Spatie\SiteSearch\Models\SiteSearchConfig;

class SiteSearchConfigResource extends Resource
{
    protected static ?string $model = SiteSearchConfig::class;

    protected static ?string $navigationIcon = 'heroicon-o-magnifying-glass';

    protected static ?string $navigationLabel = 'Site Search';

    protected static ?string $slug = 'site-search';

    public static function canCreate(): bool
    {
        return false;
    }

    public static function table(Table $table): Table
    {
        return $table
            ->columns([
                Tables\Columns\TextColumn::make('name')
                    ->searchable(),
                Tables\Columns\TextColumn::make('crawl_url')
                    ->label('Crawl URL')
                    ->limit(50),
                Tables\Columns\TextColumn::make('status')
                    ->badge()
                    ->getStateUsing(fn (SiteSearchConfig $record) => static::getStatus($record))
                    ->color(fn (string $state) => match ($state) {
                        'OK' => 'success',
                        'Crawling...' => 'info',
                        'Processing...' => 'warning',
                        'Waiting on first crawl' => 'warning',
                        'Did not find index' => 'danger',
                        default => 'gray',
                    }),
                Tables\Columns\IconColumn::make('enabled')
                    ->boolean(),
                Tables\Columns\TextColumn::make('document_count')
                    ->label('Documents'),
                Tables\Columns\TextColumn::make('number_of_urls_indexed')
                    ->label('URLs indexed'),
                Tables\Columns\TextColumn::make('urls_failed')
                    ->label('Failed'),
                Tables\Columns\TextColumn::make('crawling_ended_at')
                    ->label('Last crawl')
                    ->since(),
            ])
            ->actions([
                Tables\Actions\ViewAction::make(),
            ]);
    }

    public static function getStatus(SiteSearchConfig $config): string
    {
        if (! $config->index_name) {
            return 'Waiting on first crawl';
        }

        if ($config->pending_index_name) {
            return 'Crawling...';
        }

        try {
            if ($config->getDriver()->isProcessing($config->index_name)) {
                return 'Processing...';
            }
        } catch (Exception) {
            return 'Did not find index';
        }

        return 'OK';
    }

    public static function getPages(): array
    {
        return [
            'index' => Pages\ListSiteSearchConfigs::route('/'),
            'view' => Pages\ViewSiteSearchConfig::route('/{record}'),
        ];
    }
}
```

The list page
-----------------------------------------------------------------------------------------------

The list page is a standard Filament `ListRecords` page.

```
namespace App\Filament\Resources\SiteSearchConfigResource\Pages;

use App\Filament\Resources\SiteSearchConfigResource;
use Filament\Resources\Pages\ListRecords;

class ListSiteSearchConfigs extends ListRecords
{
    protected static string $resource = SiteSearchConfigResource::class;
}
```

The view page
-----------------------------------------------------------------------------------------------

The view page shows detailed information about a search index and includes a search form to test queries.

```
namespace App\Filament\Resources\SiteSearchConfigResource\Pages;

use App\Filament\Resources\SiteSearchConfigResource;
use Filament\Infolists\Components\Section;
use Filament\Infolists\Components\TextEntry;
use Filament\Infolists\Infolist;
use Filament\Resources\Pages\ViewRecord;
use Livewire\Attributes\Url;
use Spatie\SiteSearch\Models\SiteSearchConfig;
use Spatie\SiteSearch\SearchResults\SearchResults;

class ViewSiteSearchConfig extends ViewRecord
{
    protected static string $resource = SiteSearchConfigResource::class;

    protected static string $view = 'filament.resources.site-search-config.view';

    #[Url]
    public string $query = '';

    public function infolist(Infolist $infolist): Infolist
    {
        return $infolist
            ->schema([
                Section::make('General')
                    ->columns(3)
                    ->schema([
                        TextEntry::make('name'),
                        TextEntry::make('crawl_url')->label('Crawl URL'),
                        TextEntry::make('index_name')->label('Index name'),
                        TextEntry::make('status')
                            ->badge()
                            ->getStateUsing(fn (SiteSearchConfig $record) => SiteSearchConfigResource::getStatus($record)),
                        TextEntry::make('driver_class')
                            ->label('Driver')
                            ->default('Default'),
                        TextEntry::make('profile_class')
                            ->label('Profile')
                            ->default('Default'),
                    ]),
                Section::make('Crawl statistics')
                    ->columns(3)
                    ->schema([
                        TextEntry::make('document_count')->label('Documents'),
                        TextEntry::make('number_of_urls_indexed')->label('URLs indexed'),
                        TextEntry::make('urls_found')->label('URLs found'),
                        TextEntry::make('urls_failed')->label('URLs failed'),
                        TextEntry::make('finish_reason')->label('Finish reason'),
                        TextEntry::make('crawling_started_at')->label('Crawl started')->dateTime(),
                        TextEntry::make('crawling_ended_at')->label('Crawl ended')->dateTime(),
                    ]),
            ]);
    }

    public function getSearchResults(): ?SearchResults
    {
        if (blank($this->query)) {
            return null;
        }

        $config = $this->record;

        if (! $config->index_name) {
            return null;
        }

        return $config->getDriver()->search($config->index_name, $this->query);
    }
}
```

The view template
-----------------------------------------------------------------------------------------------------------

Create a Blade view at `resources/views/filament/resources/site-search-config/view.blade.php`.

```

    {{ $this->infolistAction }}

            @if ($searchResults = $this->getSearchResults())

                    {{ $searchResults->totalCount }} results in {{ $searchResults->processingTimeInMs }}ms

                    @foreach ($searchResults->hits as $hit)

                                {{ $hit->title() }}

                            @if ($hit->snippet())

                                    {!! $hit->highlightedSnippet() ?? e($hit->snippet()) !!}

                            @endif

                                {{ $hit->url }}
                                @if ($hit->dateModified())
                                    · {{ $hit->dateModified()->diffForHumans() }}
                                @endif

                    @endforeach

            @elseif (filled($this->query))
                No results found.
            @endif

```

These examples give you a working starting point. You can customize the columns, layout, and search result rendering to fit your application.