michalsn / codeigniter-htmx-alerts

为CodeIgniter 4框架提供的警报功能

dev-develop 2024-10-03 07:38 UTC

This package is auto-updated.

Last update: 2024-10-03 07:38:21 UTC


README

一个简单的Alerts类,与htmxAlpine.js集成,适用于CodeIgniter 4框架。

PHPUnit PHPStan Deptrac Coverage Status

PHP CodeIgniter

安装

composer require michalsn/codeigniter-htmx-alerts

配置

首先您需要发布配置文件

php spark alerts:publish

现在您可以更改

$key

在视图和会话中使用的警报键名。

$displayTime

默认警报显示时间(毫秒)。

$types

消息类型数组,其中数组键是CSS类,值是警报类型的标题。

数组键也用于确定我们想要设置的警报类型,即

alerts()->set('success', 'Success message goes here.');

$htmlWrapperId

包装器id名称,用于视图文件。

$views

此库使用的视图文件。您可以根据当前使用的样式/主题进行更改。

默认视图文件是为与Tabler主题一起设计的。

使用方法

在您的布局中放置代码(通常是在</body>标签之前)

<?= alerts()->container(); ?>

这就完成了。您已准备好开始。无论是htmx请求还是传统请求,您的警报都会每次都正确放置。

添加警报

您可以在控制器中添加警报。

// success alert
alerts()->set('success', 'Success message');
// error message
alerts()->set('danger', 'Error message');
// custom display time - 1 sec (in milliseconds)
alerts()->set('success', 'Message', 1000);

移除警报

您也可以按类型移除警报。

// will remove all success alerts
alerts()->clear('success');
// will remove all alerts
alerts()->clear();