Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pxlrbt/filament-spotlight
Quickly navigate your Filament pages
https://github.com/pxlrbt/filament-spotlight
filament filamentadmin laravel livewire php spotlight
Last synced: 4 days ago
JSON representation
Quickly navigate your Filament pages
- Host: GitHub
- URL: https://github.com/pxlrbt/filament-spotlight
- Owner: pxlrbt
- License: mit
- Created: 2022-03-23T13:26:05.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-18T14:19:12.000Z (about 1 month ago)
- Last Synced: 2024-12-20T08:02:57.287Z (11 days ago)
- Topics: filament, filamentadmin, laravel, livewire, php, spotlight
- Language: PHP
- Homepage:
- Size: 1.46 MB
- Stars: 243
- Watchers: 4
- Forks: 31
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-filament - pxlrbt/filament-spotlight - Quickly navigate your Filament pages. (UI)
README
# Filament Spotlight
[](https://packagist.org/packages/pxlrbt/filament-spotlight)
[](LICENSE.md)
[](https://packagist.org/packages/pxlrbt/filament-spotlight)
Quickly navigate your Filament Resources with Spotlight functionality.
Supports pages, resources and links from the user menu.
https://user-images.githubusercontent.com/22632550/159757479-ca9c3f46-7638-4889-98ba-6164e5205509.mp4
## Installation
| Plugin Version | Filament Version | PHP Version |
|----------------|-----------------|-------------|
| 0.x | 2.x | \> 8.0 |
| 1.x | 3.x | \> 8.1 |
```bash
composer require pxlrbt/filament-spotlight
```
### Assets
Publish the assets (Filament > 3)
```bash
php artisan filament:assets
```
### Plugin registration
To use this plugin register it in your panel configuration:
```php
use pxlrbt\FilamentSpotlight\SpotlightPlugin;
$panel
->plugins([
SpotlightPlugin::make(),
]);
```
## 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](https://filamentphp.com/docs/3.x/panels/resources/global-search)
#### Excluding pages
If you need to exclude a page from the spotlight results you may do so by adding a static `shouldRegisterSpotlight` method to the page and return false:
```php
public static function shouldRegisterSpotlight(): bool
{
return false;
}
```
This can be useful when you have pages that require URL parameters.
## Translation
To translate or edit the default placeholder, you have to publish the translation file for *wire-element/spotlight*:
```php
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`:
```json
"require": {
"pxlrbt/filament-spotlight": "dev-fix/error-message as main-dev",
},
"repositories": [
{
"type": "path",
"url": "filament-spotlight"
}
]
```
Now, run `composer update`.
## Credits
- [Dennis Koch](https://github.com/pxlrbt)
- [All Contributors](../../contributors)
- [Wire Elements Spotlight](https://github.com/wire-elements/spotlight)