jeremykenedy / filament-spotlight-2
Spotlight for Filament Admin
Fund package maintenance!
jeremykenedy
Installs: 1 791
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 4
Requires
- php: ^8.0
- filament/filament: ^2.14.0
- spatie/laravel-package-tools: ^1.11
- wire-elements/spotlight: ^1.0
Requires (Dev)
- laravel/pint: ^1.10
This package is auto-updated.
Last update: 2024-10-28 04:21:16 UTC
README
Filament Spotlight
Quickly navigate your Filament Resources with Spotlight functionality.
Supports pages, resources and links from the user menu.
demo.mp4
Installation via Composer
Requires PHP > 8.0 and Filament > 2.10.34
composer require jeremykenedy/filament-spotlight
Usage
There is no configuration needed.
"its genius"
– Dan Harrin
To open the Spotlight input bar you can use one of the following shortcuts:
CTRL + K
CMD + K
CTRL + /
CMD + /
Setup
This plugin relies on the same properties and methods used for Filament's global search. For records showing up with the correct name in "Edit/View" you need to set $recordTitleAttribute
. Check the docs for more information
Translation
To translate or edit the default placeholder, you have to publish the translation file for wire-element/spotlight:
php artisan vendor:publish --tag=livewire-ui-spotlight-translations
Contributing
If you want to contribute to this packages, you may want to test it in a real Filament project:
- Fork this repository to your GitHub account.
- Create a Filament app locally.
- Clone your fork in your Filament app's root directory.
- In the
/filament-spotlight
directory, create a branch for your fix, e.g.fix/error-message
.
Install the packages in your app's composer.json
:
"require": { "jeremykenedy/filament-spotlight": "dev-fix/error-message as main-dev", }, "repositories": [ { "type": "path", "url": "filament-spotlight" } ]
Now, run composer update
.