suxiaolin/notify

为 Yii2 提供灵活的闪现通知

1.0.1 2015-11-22 08:18 UTC

This package is not auto-updated.

Last update: 2024-09-14 18:26:08 UTC


README

Notify

Build Status Code Climate Issue Count Latest Stable Version Latest Unstable Version Total Downloads License

安装

使用 Composer

composer require suxiaolin/notify

将组件添加到 config/main.php

'notifier' => [
	'class' => 'suxiaolin\notify\Notifier',
]

注意,存在一个 Notifier::instance() 函数,因此您可以通过 Notifier::instance() 来调用,而不是在 config/main.php 中配置。

使用方法

基本用法

从您的应用程序中,通过消息和类型调用 flash 方法。

Notifier::instance()->flash('Welcome back!', 'success');

在视图内,您现在可以检查是否存在闪现消息并将其输出。

<?php if (Notifier::instance()->ready()): ?>
    <div class="alert-box <?= Notifier::instance()->type() ?>">
        <?= Notifier::instance()->message() ?>
    </div>
<?php endif; ?>

Notify 对前端框架无关,因此您可以自由地按照自己的选择轻松实现输出。

选项

您可以将其他选项传递给 flash 方法,然后在您的视图中轻松访问。

Notifier::instance()->flash('Welcome back!', 'success', [
    'timer' => 3000,
    'text' => 'It\'s really great to see you again',
]);

然后在您的视图中。

<?php if (Notifier::instance()->ready()): ?>
    <script>
        swal({
            title: "<?= Notifier::instance()->message() ?>",
            text: "<?= Notifier::instance()->option('text') ?>",
            type: "<?= Notifier::instance()->type() ?>",
            <?php if (Notifier::instance()->option('timer')): ?>
                timer: <?= Notifier::instance()->option('timer') ?>,
                showConfirmButton: false
            <?php endif; ?>
        });
    </script>
<?php endif; ?>

SweetAlert example

上述示例使用 SweetAlert,但 Notify 的灵活性意味着您可以轻松地与任何 JavaScript 弹窗解决方案一起使用。

问题和贡献

只需通过 GitHub 提交一个问题或拉取请求。谢谢!