Configuration

Scoutify is highly configurable. Most settings can be adjusted in the config/scoutify.php file.

Theme

You can control the theme of the search modal:

'theme' => 'system', // 'light' | 'dark' | 'system'

i18n

Scoutify ships with support for English, Portuguese (Brazil), and Spanish.

'i18n' => [
    'locales' => ['en', 'pt_BR', 'es'],
    'fallback' => 'en',
],

Behavior

Fine-tune how the search modal behaves:

'behavior' => [
    'recent_searches' => [
        'enabled' => true,
        'limit' => 5,
        'storage' => 'session',
    ],
    'debounce_ms' => 250,
    'min_query_length' => 2,
],

recent_searches: Persists the last few searches to the user’s session.
debounce_ms: Delay in milliseconds before triggering a search request.
min_query_length: Minimum characters required to start a search.

Authorization

Configure the default visibility for searchable models:

'authorization' => [
    'default' => 'secure', // 'secure' | 'permissive' | 'gate-only'
    'gate_ability' => 'view',
],

secure: Guests are denied, authenticated users must pass a policy check (if one exists).
permissive: Everyone is allowed.
gate-only: Everyone must pass a gate check.

Discovery

Specify where Scoutify should look for Eloquent models:

'discovery' => [
    'paths' => [
        app_path('Models'),
    ],
],

Appearance

Customize icons and colors:

'appearance' => [
    'icon_prefix' => 'heroicon-o-',
],