uxweb / sweet-alert by uxweb

A simple PHP package to show Sweet Alerts with the Laravel Framework

1,195,675

830

Package Data
Maintainer Username:	uxweb
Maintainer Contact:	ux.webs@gmail.com (Uziel Bueno)
Package Create Date:	2015-07-11
Package Last Update:	2023-01-07
Home Page:
Language:	PHP
License:	MIT
Last Refreshed:	2024-04-18 15:21:26

Package Statistics
Total Downloads:	1,195,675
Monthly Downloads:	5,686
Daily Downloads:	361
Total Stars:	830
Total Watchers:	30
Total Forks:	208
Total Open Issues:	17

Easy Sweet Alert Messages for Laravel

A success alert

Installation

First, pull in the package through Composer.

composer require uxweb/sweet-alert

If using laravel < 5.5 include the service provider and alias within config/app.php.

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

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

Note that this package works only by using the BEAUTIFUL REPLACEMENT FOR JAVASCRIPT'S "ALERT".

Finally, install the Sweet Alert Javascript library through yarn or npm

Install using Yarn:

yarn add sweetalert@^2.0 --dev

Install using Npm:

npm install sweetalert@^2.0 --save-dev

Note that this version of the package only works with sweetalert v2. If you need v1 please install the last release of version 1 of the PHP package and js library.

Usage

Using the Facade

First import the Alert facade in your controller.

use Alert;

Within your controllers, before you perform a redirect...

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

    return Redirect::home();
}

Here are some examples on how you can use the facade:

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');

Using the helper function

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

In addition to the previous listed methods you can also just use the helper function without specifying any message type. Doing so is similar to:

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

Like with the Facade we can use the helper with the same methods:

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');

Within your controllers, before you perform a redirect...

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

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

    return home();
}

For a general information alert, just do: alert('Some message'); (same as alert()->message('Some message');).

Using the Middleware

Middleware Groups

First register the middleware in web middleware groups by simply adding the middleware class UxWeb\SweetAlert\ConvertMessagesIntoSweetAlert::class into the $middlewareGroups of your app/Http/Kernel.php class:

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

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

Make sure you register the middleware within the 'web' group only.

Route Middleware

Or if you would like to assign the middleware to specific routes only, you should add the middleware to $routeMiddleware in app/Http/Kernel.php file:

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

Next step: within your controllers, set your return message (using with()) and send the proper message and proper type.

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

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

NOTE: When using the middleware it will make an alert to display if it detects any of the following keys flashed into the session: errors, success, warning, info, message, basic.

The View

Finally, to display the alert in the browser, you may use (or modify) the view that is included with this package. Simply include it in your layout view:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Document</title>
</head>
<body>

    <div class="container">
        <p>Welcome to my website...</p>
    </div>

    <script src="js/sweetalert.min.js"></script>

    <!-- Include this after the sweet alert js file -->
    @include('sweet::alert')

</body>
</html>

REMEMBER: Always include the .css and .js files from the sweet-alert library.

Final Considerations

By default, all alerts will dismiss after a sensible default number of seconds.

But not to worry, if you need to specify a different time you can:

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

Also, if you need the alert to be persistent on the page until the user dismiss it by pressing the alert confirmation button:

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

You can render html in your message with the html() method like this:

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

Customize

Config

If you need to customize the default configuration options for this package just export the configuration file:

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

A sweet-alert.php configuration file will be published to your config directory. By now, the only configuration that can be changed is the timer for all autoclose alerts.

View

If you need to customize the included alert message view, run:

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

The package view is located in the resources/views/vendor/sweet/ directory.

You can customize this view to fit your needs.

Configuration Options

You have access to the following configuration options to build a custom view:

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')

Please check the CONFIGURATION section in the website for all other options available.

Default View

The sweet_alert.alert session key contains a JSON configuration object to pass it directly to Sweet Alert.

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

Note that {!! !!} are used to output the json configuration object unescaped, it will not work with {{ }} escaped output tags.

Custom View

This is an example of how you can customize your view to fit your needs:

@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

Note that you must use "" (double quotes) to wrap the values except for the timer option.

Tests

To run the included test suite:

vendor/bin/phpunit

Demo

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

return Redirect::home();

A simple alert

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

return Redirect::home();

A simple alert with title

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

return Redirect::home();

A simple alert with title and button

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

return Redirect::home();

A info alert

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

return Redirect::home();

A error alert

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

return Redirect::home();

A success alert

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

return Redirect::home();

HTML in message

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

return Redirect::home();

A persistent alert