chifoidriss / laravel-notifer
为 Laravel 提供灵活的闪存通知
Requires
- php: >=7.0
Requires (Dev)
- mockery/mockery: ^1.0
- phpunit/phpunit: ^8.0|^9.0
This package is auto-updated.
Last update: 2024-09-12 04:49:04 UTC
README
简介
Laravel Notifer 是一个允许您向项目添加自定义通知的包。提供了多样化的通知设计。
Android 版本
如果您需要 Android 版本,请尝试此包 Aesthetic Dialogs。快乐的编码 👨🏾💻
安装
您可以使用 composer 安装此包
composer require chifoidriss/laravel-notifer
然后,将服务提供者添加到 config/app.php。在 Laravel 5.5 及以上版本中,如果启用了包自动发现,则可以跳过此步骤。
'providers' => [ ... Chifoidriss\Notifer\LaravelNotiferServiceProvider::class ... ];
您可以通过运行以下命令发布配置文件和资源
php artisan vendor:publish --provider="Chifoidriss\Notifer\LaravelNotiferServiceProvider"
现在我们已经将一些新文件发布到我们的应用程序中,我们需要使用以下命令重新加载它们
composer dump-autoload
用法
- 使用
@notiferCss添加样式链接 - 使用
@notiferJs添加脚本链接 - 在您的控制器中使用
notifer辅助函数设置 toast 通知,包括 info、success、warning 或 error - 将 notifer 部分包含到主布局中
@include('notifer::notifer')
如果您使用的是 Laravel 7 或更高版本,可以使用标签语法。
<x:notifer-messages />
基本
在您的控制器中,在执行重定向之前,调用 notifer 方法并传递一条消息。
public function store() { notifer()->success('Laravel Notifer is awesome!'); // or notifer()->error('Laravel Notifer is awesome!'); // or notifer()->warning('Laravel Notifer is awesome!'); // or notifer()->info('Laravel Notifer is awesome!'); return Redirect::home(); }
一个完整的示例
<!doctype html> <html> <head> <title>Laravel Notifer</title> @notiferCss </head> <body> @include('notifer::notifer') // Laravel 7 or greater <x:notifer-notifer /> @notiferJs </body> </html>
通知类型
Laravel Notifer 实际上显示 5 种类型的通知
toast通知(Laravel Notifer 的默认通知)
notifer()->success('Welcome to Laravel Notifer ⚡️') or notifer()->success('Welcome to Laravel Notifer ⚡️', 'My custom title')
connectifer通知,基本用法示例
connectifer('success', 'Connection Found', 'Success Message Here')
drakifer(😎) 通知,只显示一个警报
drakifer('success') // for success alert or drakifer('error') // for error alert
smilifer通知,使用笑脸 (😊) 表情符号显示一个简单的自定义 toast 通知
smilifer('success', 'You are successfully reconnected')
emotifer通知,使用矢量表情符号显示一个简单的自定义 toast 通知
emotifer('success', 'You are awesome, your data was successfully created')
预设通知
如果您在系统的多个不同位置使用特定的通知,您可以在配置文件中将它定义为预设通知。这使您更容易在一个地方维护常用的通知。在下面的 配置 部分中阅读如何定义预设消息。
例如,要使用名为 'common-notification' 的预设通知,请使用以下内容
notifer()->preset('common-notification')
如果您需要,可以覆盖配置中设置的任何值。例如,如果您有一个通用的通知,但您想在特定位置更改图标,这可能很有用,而无需手动编写一个新的通知。
要这样做,只需传递一个包含您想要覆盖的属性键及其值的数组的数组。
例如,我们可以通过以下方式覆盖 'common-notification' 的 'title':
notifer()->preset('common-notification', ['title' => 'This is the overridden title'])
配置
配置文件位于发布提供者元素后的 config/notifer.php。
一些很酷的功能。要激活 暗黑模式,更新 theme 配置,或在 .env 文件中添加全局变量 NOTIFer_THEME。
'theme' => env('NOTIFER_THEME', 'dark'),
您可以使用以下结构在配置文件中定义预设通知
'preset-messages' => [ 'user-updated' => [ 'message' => 'The user has been updated successfully.', 'type' => 'success', 'model' => 'connect', 'title' => 'User Updated', ], 'user-deleted' => [ 'message' => 'The user has been deleted successfully.', 'type' => 'success', 'model' => 'connect', 'title' => 'User Deleted', ], ],
上面的示例显示了两个预设通知的配置:'user-updated' 和 'user-deleted'。
变更日志
请查看变更日志获取关于最近更改的更多信息。
贡献
请参阅contributing.md了解详细信息以及待办事项清单。
安全
如果您发现任何与安全相关的问题,请通过电子邮件联系作者,而不是使用问题跟踪器。
鸣谢
- Idriss CHIFO
- [所有贡献者][link-contributors]
捐赠 ❤️
如果您使用并喜欢Laravel Notifer,可以通过以下方式鼓励作者:
- 今天捐赠!.
- 为项目点赞 ⭐.
捐赠者名单
- Charlie J - (10,00 美元) -
Charlie来自英国,充满爱心地捐赠- 2020年10月9日
许可证
许可证。请参阅许可证文件获取更多信息。