https://github.com/kainiklas/filament-scout
Filament Plugin to integrate Laravel Scout into Global Search, Table Search and Select field component
https://github.com/kainiklas/filament-scout
filament filament-plugin filamentphp filamentplugin laravel laravel-scout meilisearch meilisearch-php php
Last synced: 5 months ago
JSON representation
Filament Plugin to integrate Laravel Scout into Global Search, Table Search and Select field component
- Host: GitHub
- URL: https://github.com/kainiklas/filament-scout
- Owner: kainiklas
- License: mit
- Created: 2023-12-13T07:38:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-13T14:41:41.000Z (7 months ago)
- Last Synced: 2025-11-13T15:19:08.771Z (7 months ago)
- Topics: filament, filament-plugin, filamentphp, filamentplugin, laravel, laravel-scout, meilisearch, meilisearch-php, php
- Language: PHP
- Homepage:
- Size: 330 KB
- Stars: 29
- Watchers: 1
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Filament Scout Plugin
[](https://packagist.org/packages/kainiklas/filament-scout)
[](https://github.com/kainiklas/filament-scout/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/kainiklas/filament-scout/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)
[](https://packagist.org/packages/kainiklas/filament-scout)
Plugin to integrate Laravel Scout into Filament **Global Search** and **Table Search**. Plus a **ScoutSelect component** which enhances the standard Select Field with scout search capabilities.
## Pre-Requesites
- [Laravel Scout](https://laravel.com/docs/12.x/scout): Install and configure Laravel Scout as described in the Laravel Docs.
## Supported Filament Versions
| Filament Version | Filament Scout Version |
| --- | --- |
| 3.x | 0.x |
| 4.x | 1.x |
## Installation
You can install the package via composer:
```bash
composer require kainiklas/filament-scout
```
## Table Search
To use Scout Search instead of the default search on a table, add the trait `InteractsWithScout` to any Page which contains a table, e.g. `app\Filament\Resources\MyResource\Pages\ListMyResources.php`:
```php
use Kainiklas\FilamentScout\Traits\InteractsWithScout;
class ListMyResources extends ListRecords
{
use InteractsWithScout;
}
```
The table defined in the resource needs to be `searchable()` as described in the [Filament table docs](https://filamentphp.com/docs/4.x/tables/overview#searching-records-with-laravel-scout).
Making each column searchable is not required anymore, as the content of what is searchable is defined within scout.
### Increase the number of search results
Depending on the scout engine you may have limitations on how many search results you get back.
This can be adjusted in two places:
#### 1. Search Limit
Add the following `env` variable to adjust the limit of search results:
```
SCOUT_SEARCH_LIMIT=100
```
`100` is the default value within this pagacke.
For example meilisearch has a default limit of `20`.
#### 2. Index Settings (Example for meilisearch)
Within meilisearch there is a default limit of `1000` total hits which is also the upper bound for the search limit.
That means if you want to have more than `1000` search results, you need to adapt both: the search limit and the index settings.
The index settings can be adjusted within `config\scout.php`:
```php
'index-settings' => [
MyClass::class => [
'pagination' => [
'maxTotalHits' => 10000
],
],
],
```
Then run the following command to sync the settings: `php artisan scout:sync-index-settings`
## Global Search
1. Check how to enable [Global Search in the Filament Documentation](https://filamentphp.com/docs/4.x/resources/global-search).
- Set a `$recordTitleAttribute` on your resource: [Setting global search result title](https://filamentphp.com/docs/4.x/resources/global-search#setting-global-search-result-titles).
- (Optional) Add details by implementing the method `getGlobalSearchResultDetails(Model $record)` in your Resource: [Adding extra details to global search results](https://filamentphp.com/docs/4.x/resources/global-search#adding-extra-details-to-global-search-results).
```php
class ContractResource extends Resource
{
// required to enable global search
protected static ?string $recordTitleAttribute = 'name';
// optional: details
public static function getGlobalSearchResultDetails(Model $record): array
{
return [
'Category' => $record->category->name,
];
}
}
```
2. Add the Plugin `FilamentScoutPlugin` to your panel configuration, e.g., in `app\Providers\Filament\AdminPanelProvider.php`.
```php
use Kainiklas\FilamentScout\FilamentScoutPlugin;
class AdminPanelProvider extends PanelProvider
{
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
FilamentScoutPlugin::make()
]);
}
}
```
### Meilisearch
If you are using [Meilisearch](https://www.meilisearch.com/), you can activate meilisearch specific features (search context highlighting):
1. Configure the plugin.
```php
use Kainiklas\FilamentScout\FilamentScoutPlugin;
class AdminPanelProvider extends PanelProvider
{
public function panel(Panel $panel): Panel
{
return $panel
->plugins([
FilamentScoutPlugin::make()
->useMeilisearch() // enables meilisearch specific features
]);
}
}
```
2. (Optional) Implement/ Adapt `getGlobalSearchResultDetails()` in your Resource:
```php
public static function getGlobalSearchResultDetails(Model $record): array
{
// change the filament default implementation from this
// return [
// 'AttributeTitle' => $record->attribute_name
// ];
// to this
return [
'scout_attribute_name' => "AttributeTitle"
];
}
```
## Select Form Field
To enable scout search in your select form fields use the provided `ScoutSelect` component:
```php
use Kainiklas\FilamentScout\Forms\Components\ScoutSelect;
ScoutSelect::make('company_id')
->searchable()
->relationship('company', 'name')
->useScout() // must be called after relationship()
```
Technically, the `ScoutSelect` component inherits from `Filament\Forms\Components\Select`. The `useScout()` method sets a new `getSearchResultsUsing()` closure which uses scout.
__Important__: The `useScout()` method needs to be called *after* the relationship method. Otherwise it is overriden by the `relationship()` method.
*Hint*: Only values which are accessible and defined by scout are searchable.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Kai Niklas](https://github.com/kainiklas)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.