mercuryseries/flashy

Easy flash notifications
58,096 444
Install
composer require mercuryseries/flashy
Latest Version:v1.0.5
PHP:>=5.4.0
License:MIT
Last Updated:Mar 2, 2024
Links: GitHub  ·  Packagist
Maintainer: mercuryseries

Easy Flash Messages

Example of Error Notification

Copyright

Inspired by Jeffrey Way's Flash Package. Added following Jeffrey Ωmega's request.

Installation

Video Tutorial

Watch a Video Tutorial here

You like text ?

First, pull in the package through Composer.

Run composer require mercuryseries/flashy

And then, if using Laravel 5, include the service provider within config/app.php.

'providers' => [
    MercurySeries\Flashy\FlashyServiceProvider::class,
];

And, for convenience, add a facade alias to this same file at the bottom:

'aliases' => [
    'Flashy' => MercurySeries\Flashy\Flashy::class,
];

Usage

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

public function store()
{
    Flashy::message('Welcome Aboard!', 'http://your-awesome-link.com');

    return Redirect::home();
}

You may also do:

  • Flashy::info('Message', 'http://your-awesome-link.com')
  • Flashy::success('Message', 'http://your-awesome-link.com')
  • Flashy::error('Message', 'http://your-awesome-link.com')
  • Flashy::warning('Message', 'http://your-awesome-link.com')
  • Flashy::primary('Message', 'http://your-awesome-link.com')
  • Flashy::primaryDark('Message', 'http://your-awesome-link.com')
  • Flashy::muted('Message', 'http://your-awesome-link.com')
  • Flashy::mutedDark('Message', 'http://your-awesome-link.com')

Again, if using Laravel, this will set a few keys in the session:

  • 'flashy_notification.message' - The message you're flashing
  • 'flashy_notification.type' - A string that represents the type of notification (good for applying HTML class names)
  • 'flashy_notification.link' - The URL to redirect to on click

Alternatively, again, if you're using Laravel, you may reference the flashy() helper function, instead of the facade. Here's an example:

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

    flashy()->success('You have been logged out.', 'http://your-awesome-link.com');

    return home();
}

Or, for a general information flash, just do: flashy('Some message', 'http://your-awesome-link.com');.

With this message flashed to the session, you may now display it in your view(s). Maybe something like:

@if(Session::has('flashy_notification.message'))
<script id="flashy-template" type="text/template">
    <div class="flashy flashy--{{ Session::get('flashy_notification.type') }}">
        <i class="material-icons">speaker_notes</i>
        <a href="#" class="flashy__body" target="_blank"></a>
    </div>
</script>

<script>
    flashy("{{ Session::get('flashy_notification.message') }}", "{{ Session::get('flashy_notification.link') }}");
</script>
@endif

Because flash messages are so common, if you want, you may use (or modify) the views that are included with this package. Simply append to your layout view:

@include('flashy::message')

Note that this package has jQuery has dependency. It's also better to load flashy before your body close tag.

Example

<!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="//code.jquery.com/jquery.js"></script>
@include('flashy::message')
</body>
</html>

If you need to modify the flash message partials, you can run:

php artisan vendor:publish

The two package views will now be located in the app/views/packages/mercuryseries/flashy/ directory.

Flashy::message('Welcome aboard!', 'http://your-awesome-link.com');

return Redirect::home();

Flashy::error('Sorry! Please try again.', 'http://your-awesome-link.com');

return Redirect::home();

Nice rendering

For a nice rendering you may include these lines in your head:

<link href="//fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700' rel='stylesheet'>

and override the following sections of the default flashy view:

<style type="text/css">
.flashy {
    font-family: "Source Sans Pro", Arial, sans-serif;
    padding: 11px 30px;
    border-radius: 4px;
    font-weight: 400;
    position: fixed;
    bottom: 20px;
    right: 20px;
    font-size: 16px;
    color: #fff;
}
</style>

<script id="flashy-template" type="text/template">
    <div class="flashy flashy--{{ Session::get('flashy_notification.type') }}">
        <i class="material-icons">speaker_notes</i>
        <a href="#" class="flashy__body" target="_blank"></a>
    </div>
</script>

Related Packages

doctrine/dbal

Powerful PHP database abstraction layer (DBAL) with many features for database s...

637,827,751 9,703
abstraction database db2 dbal mariadb mssql mysql oci8 oracle pdo pgsql postgresql queryobject sasql sql sqlite sqlserver sqlsrv
laravel/framework

The Laravel Framework.

589,172,971 34,950
framework laravel
laravel/tinker

Powerful REPL for the Laravel framework.

498,216,183 7,442
laravel psysh repl tinker
laravel/serializable-closure

Laravel Serializable Closure provides an easy and secure way to serialize closur...

413,412,504 609
closure laravel serializable
nunomaduro/collision

Cli error handling for console/command-line PHP applications.

394,964,158 4,660
artisan cli command-line console dev error handling laravel laravel-zero php symfony

Version History

Version Released PHP Laravel License
v1.0.5 >=5.4.0 ~5.0|~6.0|~7.0|~8.0|~9.0|~10.0 MIT
1.0.4 >=5.4.0 ~5.0|~6.0|~7.0|~8.0 MIT
1.0.3 >=5.4.0 ~5.0|~6.0 MIT
1.0.2 >=5.4.0 ~5.0 MIT
1.0.1 >=5.4.0 ~5.0 MIT