flash

Easy flash notifications

2,651

365

2,651

View on GitHub

Top Related Projects

laravel-notify

1,602

Flexible Flash notifications for Laravel

Quick Overview

Laracasts/flash is a PHP package designed for Laravel applications to easily add flash messages to your web application. It provides a simple and expressive API for creating and displaying flash messages, which are temporary messages typically used to show success, error, or informational alerts to users after performing an action.

Pros

Easy to integrate with Laravel applications
Supports multiple message types (success, error, warning, etc.)
Chainable methods for a fluent API
Customizable view for displaying messages

Cons

Limited to Laravel framework
Requires additional setup for non-Laravel PHP projects
May have performance overhead for very high-traffic applications
Limited styling options out of the box

Code Examples

Basic usage:

flash('Welcome Aboard!');

return redirect('home');

This code sets a default flash message and redirects to the home page.

Using different message types:

flash()->success('Task completed successfully!');
flash()->error('Oops! Something went wrong.');
flash()->warning('Are you sure you want to proceed?');

These examples demonstrate how to set different types of flash messages.

Chaining methods:

flash('Welcome Aboard!')
    ->important()
    ->overlay();

This code creates an important overlay flash message.

Getting Started

Install the package via Composer:
```
composer require laracasts/flash
```

Add the service provider to your config/app.php file:

'providers' => [
    // ...
    Laracasts\Flash\FlashServiceProvider::class,
];

Add the Flash facade to your config/app.php file:

'aliases' => [
    // ...
    'Flash' => Laracasts\Flash\Flash::class,
];

Publish the package views:

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

Include the flash message partial in your main layout file:
```
@include('flash::message')
```

Now you can use the flash() helper function or the Flash facade in your controllers to set flash messages.

Competitor Comparisons

laravel-notify

1,602

Flexible Flash notifications for Laravel

Pros of laravel-notify

Offers a wider variety of notification types (success, error, info, warning, drake, connectify, smiley, toast)
Includes pre-styled CSS and JavaScript for easy implementation
Supports customizable notification positions (top, bottom, left, right)

Cons of laravel-notify

More complex setup process compared to flash
Larger file size due to additional features and styles
May require more configuration to match specific design requirements

Code Comparison

flash:

flash('Welcome Aboard!');
flash('Message')->error();
flash('Message')->warning();
flash('Message')->success();

laravel-notify:

notify()->success('Welcome to Laravel Notify ⚡️');
notify()->error('Oops! Something went wrong.');
connectify('success', 'Connection Found', 'Success Message Here');
drakify('success');

Summary

While flash provides a simpler, more lightweight solution for basic flash messages, laravel-notify offers a more comprehensive set of notification options with pre-styled designs. flash is easier to set up and integrate, but laravel-notify provides greater flexibility in terms of notification types and positioning. The choice between the two depends on the specific needs of the project and the desired level of customization.

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

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.

Top Related Projects

laravel-notify

1,602

Flexible Flash notifications for Laravel

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot