Skip to content

Latest commit

 

History

History
131 lines (89 loc) · 3.6 KB

readme.md

File metadata and controls

131 lines (89 loc) · 3.6 KB
Raw

Easy Flash Messages for Your Laravel App

This composer package offers a Twitter Bootstrap optimized flash messaging setup for your Laravel applications.

Installation

Begin by pulling in the package through Composer.

composer require laracasts/flash

Next, as noted above, the default CSS classes for your flash message are optimized for Twitter Bootstrap. As such, either pull in the Bootstrap's CSS within your HTML or layout file, or write your own CSS based on these classes.

<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">

Usage

Within your controllers, before you perform a redirect, make a call to the flash() function.

public function store()
{
    flash('Welcome Aboard!');

    return home();
}

You may also do:

  • flash('Message')->success(): Set the flash theme to "success".
  • flash('Message')->error(): Set the flash theme to "danger".
  • flash('Message')->warning(): Set the flash theme to "warning".
  • flash('Message')->overlay(): Render the message as an overlay.
  • flash()->overlay('Modal Message', 'Modal Title'): Display a modal overlay with a title.
  • flash('Message')->important(): Add a close button to the flash message.
  • flash('Message')->error()->important(): Render a "danger" flash message that must be dismissed.

With this message flashed to the session, you may now display it in your view(s). Because flash messages and overlays are so common, we provide a template out of the box to get you started. You're free to use - and even modify to your needs - this template how you see fit.

@include('flash::message')

Example

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Document</title>
    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
</head>
<body>

<div class="container">
    @include('flash::message')

    <p>Welcome to my website...</p>
</div>

<!-- If using flash()->important() or flash()->overlay(), you'll need to pull in the JS for Twitter Bootstrap. -->
<script src="//code.jquery.com/jquery.js"></script>
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>

<script>
    $('#flash-overlay-modal').modal();
</script>

</body>
</html>

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

php artisan vendor:publish --provider="Laracasts\Flash\FlashServiceProvider"

The two package views will now be located in the resources/views/vendor/flash/ directory.

flash('Welcome Aboard!');

return home();
flash('Sorry! Please try again.')->error();

return home();
flash()->overlay('You are now a Laracasts member!', 'Yay');

return home();

Learn exactly how to build this very package on Laracasts!

Hiding Flash Messages

A common desire is to display a flash message for a few seconds, and then hide it. To handle this, write a simple bit of JavaScript. For example, using jQuery, you might add the following snippet just before the closing </body> tag.

<script>
$('div.alert').not('.alert-important').delay(3000).fadeOut(350);
</script>

This will find any alerts - excluding the important ones, which should remain until manually closed by the user - wait three seconds, and then fade them out.

Multiple Flash Messages

Need to flash multiple flash messages to the session? No problem.

flash('Message 1');
flash('Message 2')->important();

return redirect('somewhere');

Done! You'll now see two flash messages upon redirect.