thijmenkort/filament-favourites

此插件允许您为Filament Admin用户添加全局书签菜单

dev-main 2023-01-08 14:55 UTC

This package is not auto-updated.

Last update: 2024-09-29 23:33:26 UTC


README

Latest Version on Packagist Total Downloads

Screen shot of Filament Bookmarks Menu

Screen shot of Filament User Menu

此Filament插件将向您的Filament Admin应用程序添加书签菜单。您可以在该菜单中设置全局项目,或者允许用户添加自己的项目。插件将在您希望显示的地方的所有页面上渲染添加和删除书签的图标。

安装

您可以通过composer安装此包

composer require stafe-group-ab/filament-bookmarks-menu

您可以使用以下命令发布并运行迁移

php artisan vendor:publish --tag="filament-bookmarks-menu-migrations"
php artisan migrate

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="filament-bookmarks-menu-config"

这是已发布配置文件的内容,在这里您可以轻松地更改图标、颜色等。

return [
    'bookmark_icon' => 'heroicon-o-bookmark',
    'bookmark_class' => 'w-5 h-5 cursor-pointer text-gray-700 dark:text-gray-200',
    'add_bookmark_icon' => 'heroicon-o-bookmark',
    'remove_bookmark_icon' => 'heroicon-s-bookmark',
    'add_bookmark_class' => 'w-6 h-6 cursor-pointer text-danger-700 dark:text-gray-200',
    'remove_bookmark_class' => 'w-6 h-6 cursor-pointer text-danger-700 dark:text-gray-200',
    'add_bookmarks_by_users' => true,
    'exclude_pages' => ['admin', 'bookmarks-menus'],
    'notification_add_icon' => 'heroicon-o-bookmark',
    'notification_remove_icon' => 'heroicon-o-bookmark',
    'notification_add_color' => 'success',
    'notification_remove_color' => 'danger',
];

可选地,您可以使用以下命令发布视图

php artisan vendor:publish --tag="filament-bookmarks-menu-views"

可选地,您可以发布翻译文件,我们将只提供英文版本

php artisan vendor:publish --tag="filament-bookmarks-menu-translations"

使用方法

要为已登录用户提供添加个人书签菜单中收藏夹的功能,请确保您进入配置文件并设置以下内容。这将使插件在所有页面上渲染添加/删除书签图标功能。

 'add_bookmarks_by_users' => true,

在几乎所有情况下,您都会希望排除某些页面不使用此插件。配置文件中有一个数组,您可以在其中添加您希望排除的项。它将在您的Filament Admin中的所有URL的末尾排除。因此,如果您排除编辑以下内容,则插件中将不可用编辑页面。

'exclude_pages' => ['admin', 'bookmarks-menus'],

测试

composer test

变更日志

有关最近更改的更多信息,请参阅变更日志

贡献

有关详细信息,请参阅贡献指南

安全漏洞

有关如何报告安全漏洞的信息,请参阅我们的安全策略

致谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件