tsfcorp/uifeedback

v0.0.13 2024-05-15 07:24 UTC

This package is auto-updated.

Last update: 2024-09-15 08:10:59 UTC


README

轻松向用户提供视觉反馈

安装

在您的 composer.json 中要求此包。运行以下命令

composer require tsfcorp/uifeedback

更新 composer 后,服务提供程序将自动注册并启用,包括外观,使用自动发现

下一步是运行 artisan 命令以将配置引入您的项目

php artisan vendor:publish --provider="TsfCorp\UiFeedback\UiFeedbackServiceProvider" --tag=config

更新 config/uifeedback.php

使用说明

此库默认与 Bootstrap 4 一起工作。

您可以在应用程序中的任何位置添加新消息,例如

UiFeedback::set(MessageFormat::SUCCESS, 'message');

set 方法有 3 个参数

  • 消息格式:一个表示将添加到 HTML 容器的类的字符串
  • 消息:一个表示将添加到 HTML 容器的类的字符串
  • 关闭按钮(可选,默认:true):是否显示或隐藏警报的关闭按钮

消息格式有以下选项,但您可以在其中指定任何类并自定义应用程序中的 CSS。

便捷方法

您可以使用以下模式设置支持的消息格式的消息

UiFeedback::success('success message');
UiFeedback::danger('error message');

显示消息

为了显示消息,您可以在视图中添加以下行

{!! \TsfCorp\UiFeedback\Facades\UiFeedback::get() !!}

输出消息

如果您想立即显示格式化的消息,您可以在视图中使用以下内容

{!! \TsfCorp\UiFeedback\Facades\UiFeedback::format(\TsfCorp\UiFeedback\MessageFormat::SUCCESS, 'message'); !!}

分组消息

如果您设置多个同类型的消息(例如 SUCCESS),将为每个消息生成一个新的警报。您可以通过将 group_errors 设置为 true 来更改此行为。这样,同类型的消息将显示在同一个警报框中。

会话错误

UiFeedback 可以捕获验证错误并显示这些错误以及您设置的其它消息。这是默认行为。您可以在配置中更改它:capture_validation_errors

更改输出格式

为了更改消息的格式,您需要发布使用的视图

php artisan vendor:publish --provider="TsfCorp\UiFeedback\UiFeedbackServiceProvider" --tag=views

然后您可以在以下位置编辑已发布的视图:resources/views/vendor