A Statamic Live Search realised with Laravel Livewire.
It's fast to implement, hooks into the Statamic 3 core serach and does add the 'update as you type flavor'.
This Package extends my third-party Statmic 3 Livewire integration.
Check out my Statmic 3 Livewire integration.
Pull in the package with composer
composer require jonassiewertsen/statamic-live-search- PHP 7.4 or 8.0
- Laravel 7 or 8
- Statamic 3
The create your first search does provide a quick start example to get you started.
As the statamic-live-search is extending the statamic-livewire addon, the setup is excactly the same and a deeper understanding might be useful. See the link below for more information.
Statmic 3 Livewire integration Docs
Add the livewire:search component to one of your templates and define your template.
<!--
### If using Antlers ###
-->
<html>
<head>
...
{{ livewire:styles }}
</head>
<body>
{{ livewire:search }}
<!-- Some crazy stuff going -->
...
{{ livewire:scripts }}
</body>
</html>
<!--
### If using Blade ###
-->
<html>
<head>
...
@livewireStyles
</head>
<body>
<livewire:search />
<!-- Some crazy stuff going -->
...
@livewireScripts
</body>
</html>To get you started as fast as possible, we do provide a default template. You can publish it and edit it after your needs.
php artisan vendor:publish --tag=live-search:viewsAfter publishing, you will find the template inside resources/views/vendor/live-search/dropdown.blade.php. It can be edited as you like.
Create your own template and put it somewhere you like. Define the template in the tag and you are ready to go.
If you need augmented values, which is the case for images, it's the easiest way to use Antlers, so you don't need to worry about it.
<!-- If using Antlers -->
{{ livewire:search template='partials.your-own-search-template' }}
<!-- If using Blade -->
<livewire:search :template='partials.your-own-search-template' />If the template name is partials.search, the template is expected at resources\views\partials\search.blade.php or resources\views\partials\search.antlers.php.
This might be a solid starting point for your own template:
<div>
<input wire:model="q" type="search">
<ul>
@forelse($results as $result)
<li>{{ $result['title'] }}</li>
@empty
No matches found
@endforelse
</ul>
</div><div>
<input wire:model="q" type="search">
<ul>
{{ results }}
<li>{{ title }}</li>
{{ /results }}
</ul>
</div>That's the great thing. This addon does hook into Statamic core search. Just configure your indexes in the config/statamic/search.php file.
If you don't provide any index, we will search in all existing. That's great for smaller sites.
A more specific search could look something similar:
'blog' => [
'driver' => 'local',
'searchables' => 'collection:blog',
'fields' => ['title'],
],Remember to define the index in your component:
<!-- If using Antlers -->
{{ livewire:search template='partials.search' index='blog' }}
<!-- If using Blade -->
<livewire:search :template='partials.search' :index='blog' />To update your indexes, run php please search:update More information
See the Statamic docs for more information
The provied parts have been build modular, so you can easily extend those parts.
php artisan make:livewire YourCustomLivewireController
namespace App\Your\Namespace;
use Jonassiewertsen\LiveSearch\Http\Livewire\Search;
class YourCustomLivewireController extends Search
{
public $template;
public $index;
public function mount(string $template, string $index = null)
{
// You can pass those, but they can be hardcoded as well.
$this->template = $template;
$this->index = $index;
}
public function render()
{
// Do something crazy or funny.
return view($this->template, [
'results' => $this->search($this->q, $this->index),
]);
}
}It might be that you want to customize the name of the query string or that you want to use multiple filters.
You can import the SearchFacade trait and write a complete Livewire Controller as you need it.
use Jonassiewertsen\LiveSearch\Traits\SearchFacade;
The provided method does expect the following parameters:
search($query, ?string $index = null, ?int $limit = 10)
Have fun customizing.
Thanks to:
I love to share with the community. Nevertheless, it does take a lot of work, time and effort.
Sponsor me on GitHub to support my work and the support for this addon.
This plugin is published under the MIT license. Feel free to use it and remember to spread love.