README

安装

您可以使用以下命令使用 composer 安装此包

composer require skyraptor/sweet-alert

Laravel < 5.5

如果使用Laravel < 5.5，请在 config/app.php 中包含服务提供者和别名。

'providers' => [
    UxWeb\SweetAlert\SweetAlertServiceProvider::class,
];

'aliases' => [
    'Alert' => UxWeb\SweetAlert\SweetAlert::class,
];

安装前端依赖

为了使此包正常工作，您必须在您的客户端中包含SweetAlert JavaScript库和样式表。

使用CDN

<!DOCTYPE html>
<html lang="en">
  <head>
    <!-- Include this in your blade layout -->
    <script src="https://unpkg.com/sweetalert/dist/sweetalert.min.js"></script>
  </head>
  <body>
    @include('sweet::alert')
  </body>
</html>

使用Laravel Mix

使用Yarn安装

yarn add sweetalert --dev

使用NPM安装

npm install sweetalert --save-dev

在您的 resources/js/bootstrap.js 文件中要求sweetalert。

// ...

require("sweetalert");

// ...

然后请确保将您的脚本包含在您的blade布局中。如果您的脚本标签中包含 defer 属性，请删除它，因为 defer 将延迟脚本的执行，这会导致错误，因为浏览器首先将 sweet::alert blade模板作为HTML渲染。

<!DOCTYPE html>
<html lang="en">
  <head>
    <!-- Scripts -->
    <script src="{{ asset('js/app.js') }}"></script>
  </head>
  <body>
    @include('sweet::alert')
  </body>
</html>

最后使用Mix编译您的资源

npm run dev

用法

使用外观

首先在控制器中导入SweetAlert外观。

use SweetAlert;

在您的控制器中，在执行重定向之前...

public function store()
{
    SweetAlert::message('Robots are working!');

    return Redirect::home();
}

以下是一些如何使用外观的示例

SweetAlert::message('Message', 'Optional Title');

SweetAlert::basic('Basic Message', 'Mandatory Title');

SweetAlert::info('Info Message', 'Optional Title');

SweetAlert::success('Success Message', 'Optional Title');

SweetAlert::error('Error Message', 'Optional Title');

SweetAlert::warning('Warning Message', 'Optional Title');

使用辅助函数

alert($message = null, $title = '')

除了前面列出的方法外，您还可以直接使用辅助函数而不指定任何消息类型。这样做类似于

alert()->message('Message', 'Optional Title')

与外观一样，我们可以使用相同的辅助方法使用辅助函数

alert()->message('Message', 'Optional Title');

alert()->basic('Basic Message', 'Mandatory Title');

alert()->info('Info Message', 'Optional Title');

alert()->success('Success Message', 'Optional Title');

alert()->error('Error Message', 'Optional Title');

alert()->warning('Warning Message', 'Optional Title');

alert()->basic('Basic Message', 'Mandatory Title')->autoclose(3500);

alert()->error('Error Message', 'Optional Title')->persistent('Close');

在您的控制器中，在执行重定向之前...

/**
 * Destroy the user's session (logout).
 *
 * @return Response
 */
public function destroy()
{
    Auth::logout();

    alert()->success('You have been logged out.', 'Good bye!');

    return home();
}

对于一般信息提示，只需执行： alert('Some message');（等同于 alert()->message('Some message');）。

使用中间件

中间件组

首先通过将中间件类 UxWeb\SweetAlert\ConvertMessagesIntoSweetAlert::class 添加到您的 app/Http/Kernel.php 类的 $middlewareGroups 中来在web中间件组中注册中间件。

protected $middlewareGroups = [
    'web' => [
        \App\Http\Middleware\EncryptCookies::class,
        ...
        \UxWeb\SweetAlert\ConvertMessagesIntoSweetAlert::class,
    ],

    'api' => [
        'throttle:60,1',
    ],
];

请确保您只在该 'web' 组中注册中间件。

路由中间件

或者，如果您只想将中间件分配给特定的路由，您应将中间件添加到 app/Http/Kernel.php 文件中的 $routeMiddleware。

protected $routeMiddleware = [
    'auth' => \App\Http\Middleware\Authenticate::class,
    ....
    'sweetalert' => \UxWeb\SweetAlert\ConvertMessagesIntoSweetAlert::class,
];

下一步：在您的控制器中，设置您的返回消息（使用 with()），并发送正确消息和正确类型。

return redirect('dashboard')->with('success', 'Profile updated!');

或

return redirect()->back()->with('error', 'Profile updated!');

注意：当使用中间件时，如果检测到会话中闪存的以下任何键： error、success、warning、info、message、basic，它将显示一个警告。

最终考虑

默认情况下，所有警告将在合理的默认时间后关闭。

但不用担心，如果您需要指定不同的时间，您可以使用

// -> Remember!, the number is set in milliseconds
alert('Hello World!')->autoclose(3000);

此外，如果您需要警告在页面上持续存在，直到用户通过按下警告确认按钮将其关闭

// -> The text will appear in the button
alert('Hello World!')->persistent("Close this");

您可以使用html()方法在消息中渲染HTML，如下所示

// -> html will be evaluated
alert('<a href="#">Click me</a>')->html()->persistent("No, thanks");

自定义

配置

如果您需要自定义此包的默认配置选项，请导出配置文件

php artisan vendor:publish --provider "UxWeb\SweetAlert\SweetAlertServiceProvider" --tag=config

一个 sweet-alert.php 配置文件将被发布到您的 config 目录。到目前为止，可以更改的唯一配置是所有自动关闭警告的计时器。

查看

如果您需要自定义包含的警告信息视图，请运行

php artisan vendor:publish --provider "UxWeb\SweetAlert\SweetAlertServiceProvider" --tag=views

包视图位于 resources/views/vendor/sweet/ 目录。

您可以根据需要自定义此视图。

配置选项

您可以使用以下配置选项来构建自定义视图

Session::get('sweet_alert.text')
Session::get('sweet_alert.title')
Session::get('sweet_alert.icon')
Session::get('sweet_alert.closeOnClickOutside')
Session::get('sweet_alert.buttons')
Session::get('sweet_alert.timer')

请查看网站的配置部分，了解所有其他可用的选项。

默认视图

sweet_alert.alert 会话密钥包含一个用于直接传递给 Sweet Alert 的 JSON 配置对象。

@if (Session::has('sweet_alert.alert'))
<script>
  swal({!! Session::get('sweet_alert.alert') !!});
</script>
@endif

注意，使用 {!! !!} 来输出未转义的 JSON 配置对象，它不适用于使用 {{ }} 转义输出标签。

自定义视图

这是一个如何根据您的需求自定义视图的示例

@if (Session::has('sweet_alert.alert'))
<script>
  swal({
      text: "{!! Session::get('sweet_alert.text') !!}",
      title: "{!! Session::get('sweet_alert.title') !!}",
      timer: {!! Session::get('sweet_alert.timer') !!},
      icon: "{!! Session::get('sweet_alert.type') !!}",
      buttons: "{!! Session::get('sweet_alert.buttons') !!}",

      // more options
  });
</script>
@endif

请注意，除了计时器选项外，您必须使用 ""（双引号）来包装值。

测试

要运行包含的测试套件

vendor/bin/phpunit

演示

SweetAlert::message('Welcome back!');

return Redirect::home();

SweetAlert::message('Your profile is up to date', 'Wonderful!');

return Redirect::home();

SweetAlert::message('Thanks for comment!')->persistent('Close');

return Redirect::home();

SweetAlert::info('Email was sent!');

return Redirect::home();

SweetAlert::error('Something went wrong', 'Oops!');

return Redirect::home();

SweetAlert::success('Good job!');

return Redirect::home();

SweetAlert::info('Random lorempixel.com : <img src="http://lorempixel.com/150/150/">')->html();

return Redirect::home();

SweetAlert::success('Good job!')->persistent("Close");

return Redirect::home();

许可证

Sweet Alert for Laravel 是开源软件，许可协议为 MIT 协议。

skyraptor / sweet-alert

维护者

详细信息