pxlrbt/filament-spotlight

Filament Admin 的 Spotlight

维护者

详细信息

github.com/pxlrbt/filament-spotlight

源代码

问题

资助包维护！
pxlrbt

安装量: 151 674

依赖项: 2

建议者: 0

安全: 0

星标: 233

关注者: 4

分支: 31

开放性问题: 6

v1.2.2 2024-08-11 17:15 UTC

Requires

Requires (Dev)

MIT 2dbc1c53e11cccb34fda62059bf648ddffe86c9d

  • Dennis Koch <info.woop@pixelarbeit.de>

laravelalfredspotlightfilamentlaravel-filamentwire-elements

This package is auto-updated.

Last update: 2024-09-11 17:25:22 UTC

README

header

Filament Spotlight

Latest Version on Packagist Software License GitHub Workflow Status Total Downloads

使用 Spotlight 功能快速浏览 Filament 资源。

支持从用户菜单中搜索页面、资源和链接。

demo.mp4

安装

composer require pxlrbt/filament-spotlight

资产

发布资产（Filament > 3）

php artisan filament:assets

插件注册

为了使用此插件，请在面板配置中注册它

use pxlrbt\FilamentSpotlight\SpotlightPlugin;

$panel
    ->plugins([
        SpotlightPlugin::make(),
    ]);

使用方法

无需配置。

"它的天才之处"

  – Dan Harrin

要打开 Spotlight 输入栏，可以使用以下快捷键之一

CTRL + K
CMD + K
CTRL + /
CMD + /

设置

此插件依赖于 Filament 全局搜索所使用的相同属性和方法。对于显示正确名称的“编辑/查看”记录，您需要设置 $recordTitleAttribute。 查看文档以获取更多信息

排除页面

如果您需要从 Spotlight 结果中排除页面，可以在页面中添加静态 shouldRegisterSpotlight 方法并返回 false

public static function shouldRegisterSpotlight(): bool
{
    return false;
}

当您有需要 URL 参数的页面时，这可能很有用。

翻译

要翻译或编辑默认占位符，您必须发布 wire-element/spotlight 的翻译文件

php artisan vendor:publish --tag=livewire-ui-spotlight-translations

贡献

如果您想为此包做出贡献，您可能想在一个真实的 Filament 项目中测试它

  • 将此存储库分叉到您的 GitHub 账户
  • 在本地创建 Filament 应用
  • 在 Filament 应用根目录中克隆您的分叉
  • 在 /filament-spotlight 目录中，为您的修复创建一个分支，例如 fix/error-message。

在您的应用的 composer.json 中安装包

"require": {
    "pxlrbt/filament-spotlight": "dev-fix/error-message as main-dev",
},
"repositories": [
    {
        "type": "path",
        "url": "filament-spotlight"
    }
]

现在，运行 composer update。

致谢