README

iziToast JavaScript 库的简单 PHP 封装

需求

PHP 7 或更高版本

安装

使用 Composer

composer require tegimus/php-izitoast

手动

由于它没有其他依赖项，您可以直接在项目中使用包的类文件 src/Toast.php。

添加 iziToast 库文件

从 iziToast github 仓库下载最新的 iziToast JavaScript 和 CSS 文件。

将 iziToast CSS 和 JS 文件添加到您的 HTML 中。

<html>
    <head>
        ...
        <link rel="stylesheet" type="text/css" href="/path/to/css/iziToast.min.css">
        ...
    </head>
    <body>
        ...
        <script type="text/javascript" src="/path/to/js/iziToast.min.js"></script>
    </body>
</html>

基本用法

创建 Toast 对象

使用构造函数

use Tegimus\IziToast\Toast;

$toast = new Toast();

或使用静态 make() 方法

$toast = Toast::make();

构造函数参数

构造函数可以可选地接收消息、标题、类型和选项参数。

$title = 'Test';
$message = 'My sample message';
$type = Toast::TYPE_SUCCESS;
$options = ['progressBar' => false];

$toast = new Toast($message);
//or
$toast = Toast:make($message, $title, $type, $options);

显示消息

要显示 toast 消息，只需在 HTML 中的 JavaScript 中对 Toast 对象使用 render() 函数。

<script>
  <?php $toast->render() ?>
</script>

或者在字符串上下文中，您可以简单地 echo Toast 对象

<script>
  <?= $toast ?>
</script>

自定义

消息类型

您可以通过在 Toast 对象上调用 type() 方法来设置消息的类型。

$toast->type(Toast::TYPE_ERROR);

消息选项

默认情况下，Toast 对象将设置以下选项。

'closeOnEscape' : true
'closeOnClick' : true
'position' : 'topCenter'
'progressBar' : false
'transitionIn' : 'bounceInLeft'

要覆盖选项或添加新选项，请使用 option() 方法

$toast->option('timeout', false);

或一次性指定多个选项

$toast->mergeOptions([
  'position' => 'bottomRight',
  'timeout' => 6000,
  'pauseOnHover' => false,
]);

或使用给定的数组替换所有选项。包括消息和标题在内的所有现有选项将被清除。

$toast->options([
  'message' => 'Sample message',
  'title' => 'Replace',
  'position' => 'bottomRight',
  'timeout' => 6000,
  'pauseOnHover' => false,
]);

要清除选项，请使用 clear() 方法。如果未指定参数，则将清除所有选项。

//clear 'position' option
$toast->clear('position');
//clear all options
$toast->clear();

izitoast 库中所有可用类型和选项的文档在这里。

扩展 Toast 类

了解更多关于扩展和自定义 Toast 类的信息

tegimus / php-izitoast

维护者

详细信息