{"id":13733125,"url":"https://github.com/pxlrbt/filament-spotlight","last_synced_at":"2025-05-15T00:10:05.589Z","repository":{"id":40779712,"uuid":"473199709","full_name":"pxlrbt/filament-spotlight","owner":"pxlrbt","description":"Quickly navigate your Filament pages","archived":false,"fork":false,"pushed_at":"2025-01-23T16:07:19.000Z","size":1538,"stargazers_count":254,"open_issues_count":0,"forks_count":36,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-30T16:08:25.032Z","etag":null,"topics":["filament","filamentadmin","laravel","livewire","php","spotlight"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pxlrbt.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"pxlrbt"}},"created_at":"2022-03-23T13:26:05.000Z","updated_at":"2025-03-30T14:55:34.000Z","dependencies_parsed_at":"2024-06-19T00:17:00.356Z","dependency_job_id":"d62d255b-4eb2-4983-b3ce-000ef9886937","html_url":"https://github.com/pxlrbt/filament-spotlight","commit_stats":{"total_commits":60,"total_committers":12,"mean_commits":5.0,"dds":0.3833333333333333,"last_synced_commit":"2dbc1c53e11cccb34fda62059bf648ddffe86c9d"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pxlrbt%2Ffilament-spotlight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pxlrbt%2Ffilament-spotlight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pxlrbt%2Ffilament-spotlight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pxlrbt%2Ffilament-spotlight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pxlrbt","download_url":"https://codeload.github.com/pxlrbt/filament-spotlight/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247517905,"owners_count":20951718,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["filament","filamentadmin","laravel","livewire","php","spotlight"],"created_at":"2024-08-03T03:00:37.980Z","updated_at":"2025-04-06T17:08:08.277Z","avatar_url":"https://github.com/pxlrbt.png","language":"PHP","funding_links":["https://github.com/sponsors/pxlrbt"],"categories":["Plugins","UI"],"sub_categories":["Administration \u0026 Management"],"readme":"\u003cdiv class=\"filament-hidden\"\u003e\n    \n![header](./.github/resources/pxlrbt-spotlight.png)\n\u003c/div\u003e\n\n# Filament Spotlight\n\n\u003cdiv class=\"filament-hidden\"\u003e\n    \n[![Latest Version on Packagist](https://img.shields.io/packagist/v/pxlrbt/filament-spotlight.svg?include_prereleases)](https://packagist.org/packages/pxlrbt/filament-spotlight)\n[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.md)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/pxlrbt/filament-spotlight/code-style.yml?branch=main\u0026label=Code%20style\u0026style=flat-square)\n[![Total Downloads](https://img.shields.io/packagist/dt/pxlrbt/filament-spotlight.svg)](https://packagist.org/packages/pxlrbt/filament-spotlight)\n\n\u003c/div\u003e\n\nQuickly navigate your Filament Resources with Spotlight functionality.\n\nSupports pages, resources and links from the user menu.\n\n\u003cdiv class=\"filament-hidden\"\u003e\n    \nhttps://user-images.githubusercontent.com/22632550/159757479-ca9c3f46-7638-4889-98ba-6164e5205509.mp4\n\n\u003c/div\u003e\n\n\n## Installation\n\n\n| Plugin Version | Filament Version | PHP Version |\n|----------------|-----------------|-------------|\n| 0.x            | 2.x   | \\\u003e 8.0      |\n| 1.x            | 3.x             | \\\u003e 8.1      |\n\n\n```bash\ncomposer require pxlrbt/filament-spotlight\n```\n\n### Assets\n\nPublish the assets (Filament \u003e 3)\n\n```bash\nphp artisan filament:assets\n```\n\n### Plugin registration\n\nTo use this plugin register it in your panel configuration:\n\n```php\nuse pxlrbt\\FilamentSpotlight\\SpotlightPlugin;\n\n$panel\n    -\u003eplugins([\n        SpotlightPlugin::make(),\n    ]);\n```\n\n## Usage\n\nThere is no configuration needed.\n\n\u003e \"its genius\"\n\n  – Dan Harrin\n\nTo open the Spotlight input bar you can use one of the following shortcuts:\n\nCTRL + K  \nCMD + K  \nCTRL + /  \nCMD + /  \n\n### Setup\n\nThis 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)\n\n#### Excluding pages\n\nIf 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:\n\n```php\npublic static function shouldRegisterSpotlight(): bool\n{\n    return false;\n}\n```\n\nThis can be useful when you have pages that require URL parameters.\n\n## Translation\n\nTo translate or edit the default placeholder, you have to publish the translation file for *wire-element/spotlight*: \n\n```php\nphp artisan vendor:publish --tag=livewire-ui-spotlight-translations\n```\n\n\n\n## Contributing\n\nIf you want to contribute to this packages, you may want to test it in a real Filament project:\n\n- Fork this repository to your GitHub account.\n- Create a Filament app locally.\n- Clone your fork in your Filament app's root directory.\n- In the `/filament-spotlight` directory, create a branch for your fix, e.g. `fix/error-message`.\n\nInstall the packages in your app's `composer.json`:\n\n```json\n\"require\": {\n    \"pxlrbt/filament-spotlight\": \"dev-fix/error-message as main-dev\",\n},\n\"repositories\": [\n    {\n        \"type\": \"path\",\n        \"url\": \"filament-spotlight\"\n    }\n]\n```\n\nNow, run `composer update`.\n\n## Credits\n- [Dennis Koch](https://github.com/pxlrbt)\n- [All Contributors](../../contributors)\n- [Wire Elements Spotlight](https://github.com/wire-elements/spotlight)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpxlrbt%2Ffilament-spotlight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpxlrbt%2Ffilament-spotlight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpxlrbt%2Ffilament-spotlight/lists"}