Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/howdu/filament-record-switcher
Resource title search with dropdown navigation for Filament
https://github.com/howdu/filament-record-switcher
filament filamentphp filamentphp-plugin laravel livewire php
Last synced: 3 months ago
JSON representation
Resource title search with dropdown navigation for Filament
- Host: GitHub
- URL: https://github.com/howdu/filament-record-switcher
- Owner: howdu
- License: mit
- Created: 2024-06-25T16:05:27.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-14T19:46:14.000Z (5 months ago)
- Last Synced: 2024-10-01T09:22:01.999Z (3 months ago)
- Topics: filament, filamentphp, filamentphp-plugin, laravel, livewire, php
- Language: PHP
- Homepage: https://filamentphp.com/plugins/howdu-record-switcher
- Size: 137 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
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
# Resource title navigation dropdown with search for Filament
[](https://packagist.org/packages/howdu/filament-record-switcher)
[](https://github.com/howdu/filament-record-switcher/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://packagist.org/packages/howdu/filament-record-switcher)
Subtly convert the page title into a dropdown navigation that's displayed on click.
It works similar to Filament's global search but only shows results for the current resource.
## Installation
You can install the package via composer:
```bash
composer require howdu/filament-record-switcher
```
Optionally, you can publish the views using
```bash
php artisan vendor:publish --tag="filament-record-switcher-views"
```
## Usage
1. Register plugin inside your PanelProvider(s).
E.g `app/Filament/Providers/AdminPanelProvider.php`
```php
use Howdu\FilamentRecordSwitcher\FilamentRecordSwitcherPlugin;
class AdminPanelProvider extends PanelProvider
{
public function panel(Panel $panel): Panel
{
return $panel
// ...
->plugin(
FilamentRecordSwitcherPlugin::make(),
);
}
}
```
2. Add the `HasRecordSwitcher` trait to each of your edit record Page.
E.g `app/Filament/Resources/Category/Pages/EditCategory.php`
```php
use Howdu\FilamentRecordSwitcher\Filament\Concerns\HasRecordSwitcher;
class EditCategory extends EditRecord
{
use HasRecordSwitcher;
}
```
Note: this trail will overwrite the `getHeading()` method if you've overwritten it in your Page you need to
overwrite `getRecordTitle()` instead.
3. Check your Resource class e.g CategoryResource has the record title attribute set which's used as the label in the select dropdown.
```php
protected static ?string $recordTitleAttribute = 'title';
```
4. Finally publish plugin assets.
```bash
php artisan filament:assets
```
## 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
- [Ben J](https://github.com/howdu)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.