PHPFlasher

https://php-flasher.io
Admin
PHPFlasher is a notification library that displays elegant flash notifications in Laravel, Symfony,...
Tokens:56,166
Snippets:600
Trust Score:6.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Basic PHP Flasher Usage (npm)

Source: https://php-flasher.io/javascript

Import and use the flasher object to display different types of notifications. This example assumes installation via npm.

```javascript
import flasher from "@flasher/flasher";

window.flasher = flasher; // only if you want to use it globally

flasher.error("Oops! Something went wrong!");
flasher.warning("Are you sure you want to proceed ?");
flasher.success("Data has been saved successfully!");
flasher.info("Welcome back");
```

--------------------------------

### Installing PHPFlasher for Symfony

Source: https://php-flasher.io/

Install the Symfony bundle via Composer.

```bash
composer require php-flasher/flasher-symfony
```

--------------------------------

### Installing PHPFlasher for Laravel

Source: https://php-flasher.io/

Install the Laravel package via Composer.

```bash
composer require php-flasher/flasher-laravel
```

--------------------------------

### Install JavaScript Dependencies

Source: https://php-flasher.io/inertia

Install the JavaScript package using npm with the force flag to handle local filesystem paths.

```bash
npm install --force__
```

--------------------------------

### Install PHP Flasher

Source: https://php-flasher.io/symfony

Use Composer to install the PHP Flasher package for Symfony. After installation, run the setup command to configure assets.

```bash
composer require php-flasher/flasher-symfony
```

```bash
php bin/console flasher:install
```

--------------------------------

### Install Notification Library Adapters

Source: https://php-flasher.io/blog/2025/03/29/integrating-phpflasher-with-laravel

Install adapters for different notification libraries like SweetAlert, Toastr, or Noty using Composer. These commands are run in the terminal.

```bash
# For SweetAlert
composer require php-flasher/flasher-sweetalert-laravel

# For Toastr
composer require php-flasher/flasher-toastr-laravel

# For Noty
composer require php-flasher/flasher-noty-laravel
```

--------------------------------

### Configure Material Theme

Source: https://php-flasher.io/theme/material

Configuration examples for setting the Material theme as default in PHP and YAML.

```php
// config/flasher.php

return [
    'default' => 'theme.material',

    'themes' => [
        'material' => [
            'scripts' => [
                '/vendor/flasher/flasher.min.css',
                '/vendor/flasher/themes/theme.material.min.js',
            ],
            'styles' => [
                '/vendor/flasher/themes/theme.material.min.css',
            ],
        ],
    ],
];
```

```yaml
# config/packages/flasher.yaml

flasher:
    default: theme.material

    themes:
        material:
            scripts:
                - '/vendor/flasher/themes/theme.material.min.js'
            styles:
                - '/vendor/flasher/themes/theme.material.min.css'
```

--------------------------------

### Configure PHPFlasher Settings

Source: https://php-flasher.io/blog/2025/03/30/phpflasher-configuration-options-for-beginners

Examples for setting up global configuration, including adapters, assets, and flash bag mappings.

```php
return Configuration::from([
    'default' => 'toastr',
    'main_script' => '/vendor/flasher/flasher.min.js',
    'styles' => [
        '/vendor/flasher/flasher.min.css',
    ],
    'options' => [
        'timeout' => 5000,
        'position' => 'top-right',
    ],
    'inject_assets' => true,
    'translate' => true,
    'flash_bag' => [
        'success' => ['success'],
        'error' => ['error', 'danger'],
        'warning' => ['warning'],
        'info' => ['info'],
    ],
]);
```

```php
return Configuration::from([
    'default' => 'sweetalert',
    'main_script' => 'https://cdn.example.com/flasher.min.js',
    'styles' => [
        'https://cdn.example.com/flasher.min.css',
    ],
    'options' => [
        'timeout' => 8000,
        'position' => 'top-center',
    ],
    'inject_assets' => true,
    'translate' => true,
    'excluded_paths' => [
        'api/*',
        'admin/reports/*',
    ],
    'flash_bag' => [
        'success' => ['success', 'ok'],
        'error' => ['error', 'danger', 'fail'],
        'warning' => ['warning', 'caution'],
        'info' => ['info', 'notice', 'note'],
    ],
    'filter' => [
        'limit' => 3,
    ],
    'presets' => [
        'user_created' => [
            'type' => 'success',
            'title' => 'User Created',
            'message' => 'The user has been created successfully',
        ],
        'profile_updated' => [
            'type' => 'success',
            'title' => 'Profile Updated',
            'message' => 'Your profile has been updated successfully',
        ],
        'login_failed' => [
            'type' => 'error',
            'title' => 'Login Failed',
            'message' => 'Invalid username or password',
            'options' => [
                'timeout' => 10000,
            ],
        ],
    ],
]);
```

--------------------------------

### Install PHP Flasher Assets for Symfony

Source: https://php-flasher.io/library/sweetalert

After installing the package, run this console command to publish and set up the required assets for PHP Flasher in your Symfony application.

```bash
php bin/console flasher:install
```

--------------------------------

### Use Multiple Notification Libraries

Source: https://php-flasher.io/blog/2025/03/29/integrating-phpflasher-with-laravel

Examples of using different notification libraries (SweetAlert, Toastr, Noty) directly in your PHP code after installing their respective adapters.

```php
// Using SweetAlert
sweetalert()->success('This is a SweetAlert notification');

// Using Toastr
toastr()->info('This is a Toastr notification');

// Using Noty
noty()->warning('This is a Noty notification');
```

--------------------------------

### Install PHP Flasher Assets for Laravel

Source: https://php-flasher.io/library/sweetalert

After installing the package, run this Artisan command to publish and set up the required assets for PHP Flasher in your Laravel application.

```bash
php artisan flasher:install
```

--------------------------------

### Install Notyf for Laravel

Source: https://php-flasher.io/library/notyf

Install the Notyf package via Composer and publish the necessary assets.

```bash
composer require php-flasher/flasher-notyf-laravel
```

```bash
php artisan flasher:install
```

--------------------------------

### Install PHP Flasher via npm

Source: https://php-flasher.io/javascript

Install the PHP Flasher package using npm for use in your JavaScript projects.

```bash
npm i @flasher/flasher
```

--------------------------------

### Install Notyf for Symfony

Source: https://php-flasher.io/library/notyf

Install the Notyf package via Composer and publish the necessary assets.

```bash
composer require php-flasher/flasher-notyf-symfony
```

```bash
php bin/console flasher:install
```

--------------------------------

### Use Minimal Theme in JavaScript

Source: https://php-flasher.io/theme/minimal

Example of setting the Minimal Theme as the default and displaying a success notification using JavaScript.

```javascript
// Set as default theme
// Then use it
flasher.use('theme.minimal').success('Well done!');
```

--------------------------------

### Complete Livewire Form with Notifications

Source: https://php-flasher.io/livewire

A full example demonstrating form validation, data persistence, and success/error notification handling.

```php
<?php

namespace App\Livewire;

use Livewire\Component;
use App\Models\Contact;

class ContactForm extends Component
{
    public $name = '';
    public $email = '';
    public $message = '';

    protected $rules = [
        'name' => 'required|min:3',
        'email' => 'required|email',
        'message' => 'required|min:10',
    ];

    public function submit()
    {
        $this->validate();

        try {
            Contact::create([
                'name' => $this->name,
                'email' => $this->email,
                'message' => $this->message,
            ]);

            // Success notification
            flash()->success('Your message has been sent!', 'Thank you');

            // Reset form
            $this->reset(['name', 'email', 'message']);

        } catch (\Exception $e) {
            // Error notification
            flash()->error('There was a problem sending your message.');
        }
    }

    public function render()
    {
        return view('livewire.contact-form');
    }
}__
```

--------------------------------

### Set Sapphire Theme as Default (JavaScript)

Source: https://php-flasher.io/theme/sapphire

Example of setting the Sapphire theme as the default and then using it to display a success notification in JavaScript.

```javascript
// Set as default theme
// Then use it
flasher.use('theme.sapphire').success('Well done!');
```

--------------------------------

### Install PHP Flasher via Composer

Source: https://php-flasher.io/livewire

Run this command in your terminal to add the package to your Laravel project.

```bash
composer require php-flasher/flasher-laravel__
```

--------------------------------

### Install PHP Flasher via CDN

Source: https://php-flasher.io/javascript

Include the PHP Flasher library in your project by adding this script tag to your HTML.

```html
<script defer src="https://cdn.jsdelivr.net/npm/@flasher/flasher@2.5.1/dist/flasher.min.js"></script>
```

--------------------------------

### Install Toastr for Laravel

Source: https://php-flasher.io/library/toastr

Use Composer to add the Toastr plugin to a Laravel project.

```bash
composer require php-flasher/flasher-toastr-laravel
```

--------------------------------

### Create User and Flash Message in Controller

Source: https://php-flasher.io/inertia

This example demonstrates creating a new user and then adding a success flash message before redirecting. Ensure flash messages are enabled and configured in your application.

```php
<?php

namespace App\Http\Controllers;

use App\Models\User;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Facades\Redirect;
use Inertia\Inertia;

class UsersController extends Controller
{
    /**
     * Display a listing of users.
     */
    public function index()
    {
        return Inertia::render('Users/Index', [
            'users' => User::all()
        ]);
    }

    /**
     * Show the form for creating a new user.
     */
    public function create()
    {
        return Inertia::render('Users/Create');
    }

    /**
     * Store a newly created user in storage.
     */
    public function store(Request $request)
    {
        $validated = $request->validate([
            'name' => 'required|string|max:255',
            'email' => 'required|string|email|max:255|unique:users',
            'password' => 'required|string|min:8|confirmed',
        ]);

        User::create([
            'name' => $validated['name'],
            'email' => $validated['email'],
            'password' => Hash::make($validated['password']),
        ]);

        // Add a success notification
        flash()->success('User created successfully!');

        // Redirect back, and Inertia will handle passing the flash message
        return Redirect::route('users.index');
    }

    /**
     * Display the specified user.
     */
    public function show(User $user)
    {
        return Inertia::render('Users/Show', [
            'user' => $user
        ]);
    }

    /**
     * Show the form for editing the specified user.
     */
    public function edit(User $user)
    {
        return Inertia::render('Users/Edit', [
            'user' => $user
        ]);
    }

    /**
     * Update the specified user in storage.
     */
    public function update(Request $request, User $user)
    {
        $validated = $request->validate([
            'name' => 'required|string|max:255',
            'email' => 'required|string|email|max:255|unique:users,email,' . $user->id,
        ]);

        $user->update($validated);

        flash()->success('User updated successfully!');

        return Redirect::route('users.index');
    }

    /**
     * Remove the specified user from storage.
     */
    public function destroy(User $user)
    {
        $user->delete();

        flash()->info('User has been deleted.');

        return Redirect::route('users.index');
    }
}

```

--------------------------------

### Create Product with Success Notification

Source: https://php-flasher.io/laravel

Example of creating a product in a Laravel controller and adding a success notification using the helper function.

```php
<?php

namespace App\Http\Controllers;

use App\Models\Product;
use Illuminate\Http\Request;

class ProductController extends Controller
{
    public function store(Request $request)
    {
        // Validate the request
        $validated = $request->validate([
            'name' => 'required|string|max:255',
            'price' => 'required|numeric',
        ]);

        // Create the product
        Product::create($validated);

        // Add a success notification
        flash()->success('Product created successfully!');

        return redirect()->route('products.index');
    }
}
```

--------------------------------

### Compare Laravel native flash vs PHPFlasher

Source: https://php-flasher.io/blog/2025/03/29/integrating-phpflasher-with-laravel

Examples showing the difference between manual session-based flash messaging and the simplified PHPFlasher API.

```php
// Controller
public function update(Request $request, $id)
{
    $user = User::findOrFail($id);
    $user->update($request->validated());

    session()->flash('message', 'User updated successfully!');
    session()->flash('alert-type', 'success');

    return redirect()->route('users.index');
}
```

```blade
@if (session('message'))
    <div class="alert alert-{{ session('alert-type') ?? 'info' }}">
        {{ session('message') }}
    </div>
@endif
```

```php
// Controller
public function update(Request $request, $id)
{
    $user = User::findOrFail($id);
    $user->update($request->validated());

    flash()->success('User updated successfully!');

    return redirect()->route('users.index');
}
```

```blade
// Nothing needed! PHPFlasher v2 auto-injects everything
```

--------------------------------

### Use Neon Theme in JavaScript

Source: https://php-flasher.io/theme/neon

Example of using the Neon theme in JavaScript after setting it as the default. Displays a success notification.

```javascript
// Set as default theme
// Then use it
flasher.use('theme.neon').success('Well done!');
```

--------------------------------

### Displaying Notification Types

Source: https://php-flasher.io/library/noty

Examples of triggering info, warning, and error notifications.

```php
#/ usage info

noty()->info('Your form has been submitted and is being processed.');
```

```php
#/ usage warning

noty()->warning('Your review may not have been submitted.');
```

```php
#/ usage error

noty()->error('There was an issue saving your information.');
```

--------------------------------

### Use Google Theme in JavaScript

Source: https://php-flasher.io/theme/google

Example of how to use the Google theme in JavaScript after setting it as the default. This sends a success notification.

```javascript
// Set as default theme
// Then use it
flasher.use('theme.google').success('Well done!');
```

--------------------------------

### Set Multiple Notification Options

Source: https://php-flasher.io/inertia

Configure multiple notification settings at once using the `options()` method. This example sets the position to 'top-center', a timeout of 3000ms, and disables the close button.

```php
flash()
    ->options([
        'position' => 'top-center',
        'timeout' => 3000,
        'closeButton' => false
    ])
    ->success('Multiple options at once');
```

--------------------------------

### Install PHP Flasher SweetAlert for Laravel

Source: https://php-flasher.io/library/sweetalert

Use Composer to install the PHP Flasher SweetAlert package for Laravel. This command adds the necessary dependencies to your project.

```bash
composer require php-flasher/flasher-sweetalert-laravel
```

--------------------------------

### Install Toastr for Symfony

Source: https://php-flasher.io/library/toastr

Use Composer to add the Toastr plugin to a Symfony project.

```bash
composer require php-flasher/flasher-toastr-symfony
```

--------------------------------

### Install PHP Flasher SweetAlert for Symfony

Source: https://php-flasher.io/library/sweetalert

Use Composer to install the PHP Flasher SweetAlert package for Symfony. This command adds the necessary dependencies to your project.

```bash
composer require php-flasher/flasher-sweetalert-symfony
```

--------------------------------

### Install Noty for Symfony

Source: https://php-flasher.io/library/noty

Use Composer to add the Noty package to your Symfony project.

```bash
composer require php-flasher/flasher-noty-symfony
```

--------------------------------

### Display Specific Notification with Minimal Theme in PHP

Source: https://php-flasher.io/theme/minimal

Example of explicitly using the Minimal Theme to display a success notification in PHP.

```php
flash()->use('theme.minimal')->success('This uses Minimal Theme');
```

--------------------------------

### Install Noty for Laravel

Source: https://php-flasher.io/library/noty

Use Composer to add the Noty package to your Laravel project.

```bash
composer require php-flasher/flasher-noty-laravel
```

--------------------------------

### Trigger Notifications in PHP

Source: https://php-flasher.io/theme/material

Usage examples for triggering notifications in PHP when using the Material theme.

```php
flash()->success('Your changes have been saved!');
```

```php
flash()->use('theme.material')->success('This uses Material Theme');
```

--------------------------------

### Implement CRUD Controller with Flash Messages

Source: https://php-flasher.io/inertia

A complete Laravel controller example showing how to trigger success, info, and error flash messages during resource lifecycle events.

```php
<?php

namespace App\Http\Controllers;

use App\Models\Product;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Redirect;
use Inertia\Inertia;

class ProductController extends Controller
{
    /**
     * Display a listing of products.
     */
    public function index()
    {
        return Inertia::render('Products/Index', [
            'products' => Product::all()
        ]);
    }

    /**
     * Show the form for creating a new product.
     */
    public function create()
    {
        return Inertia::render('Products/Create');
    }

    /**
     * Store a newly created product in storage.
     */
    public function store(Request $request)
    {
        $validated = $request->validate([
            'name' => 'required|string|max:255',
            'price' => 'required|numeric',
            'description' => 'nullable|string|max:1000',
            'category_id' => 'required|exists:categories,id',
        ]);

        Product::create($validated);

        flash()->success('Product created successfully!');

        return Redirect::route('products.index');
    }

    /**
     * Display the specified product.
     */
    public function show(Product $product)
    {
        return Inertia::render('Products/Show', [
            'product' => $product->load('category')
        ]);
    }

    /**
     * Show the form for editing the specified product.
     */
    public function edit(Product $product)
    {
        return Inertia::render('Products/Edit', [
            'product' => $product,
            'categories' => \App\Models\Category::all()
        ]);
    }

    /**
     * Update the specified product in storage.
     */
    public function update(Request $request, Product $product)
    {
        $validated = $request->validate([
            'name' => 'required|string|max:255',
            'price' => 'required|numeric',
            'description' => 'nullable|string|max:1000',
            'category_id' => 'required|exists:categories,id',
        ]);

        $product->update($validated);

        flash()->success('Product updated successfully!');

        return Redirect::route('products.index');
    }

    /**
     * Remove the specified product from storage.
     */
    public function destroy(Product $product)
    {
        try {
            $product->delete();
            flash()->info('Product has been deleted.');
        } catch (\Exception $e) {
            flash()->error('Cannot delete this product. It may be in use.');
        }

        return Redirect::route('products.index');
    }
}
```

--------------------------------

### Display Specific Notification with Minimal Theme in JavaScript

Source: https://php-flasher.io/theme/minimal

Example of explicitly using the Minimal Theme to display a success notification in JavaScript.

```javascript
flasher.use('theme.minimal').success('This uses Minimal Theme');
```

--------------------------------

### Use Aurora Theme in JavaScript

Source: https://php-flasher.io/theme/aurora

Example of using the Aurora theme with a success notification in JavaScript.

```javascript
// Set as default theme
// Then use it
flasher.use('theme.aurora').success('Well done!');
```

--------------------------------

### Integrate PHPFlasher in Laravel Controller

Source: https://php-flasher.io/playground

Example of using the flash() helper within a Laravel controller to display a success notification after a model creation.

```php
// ProductController.php
namespace App\Http\Controllers;

use App\Models\Product;
use App\Http\Requests\ProductRequest;

class ProductController extends Controller
{
    public function store(ProductRequest $request)
    {
        // Create product
        $product = Product::create($request->validated());

        flash()
            ->success('Your product has been created successfully!')
```

```php

        return redirect()->route('products.index');
    }
}
```

--------------------------------

### Set Custom Notification Animations

Source: https://php-flasher.io/inertia

Customize the show and hide animations for notifications using the `option()` method. This example applies 'fadeIn' and 'fadeOut' animations.

```php
flash()
    ->option('showAnimation', 'fadeIn')
    ->option('hideAnimation', 'fadeOut')
    ->success('Custom animations');
```

--------------------------------

### Flash Specific Notification with Neon Theme in PHP

Source: https://php-flasher.io/theme/neon

Example of flashing a notification using the Neon theme specifically, even if it's not the default. Useful for overriding the default theme for a single notification.

```php
flash()->use('theme.neon')->success('This uses Neon Theme');
```

--------------------------------

### Use Onyx Theme in PHP (Laravel/Symfony)

Source: https://php-flasher.io/theme/onyx

Use the Onyx theme for success notifications in PHP. This example assumes Onyx is set as the default theme.

```php
flash()->success('Well done!');
```

--------------------------------

### Customize Sapphire Theme with CSS Variables

Source: https://php-flasher.io/theme/sapphire

Example of customizing the Sapphire Theme's appearance using CSS variables. This allows modification of background colors, text color, border radius, blur, and progress bar colors.

```css
:root {
  /* Base appearance */
  --sapphire-bg-base: rgba(30, 30, 30, 0.9);    /* Base background color */
  --sapphire-text: #f0f0f0;                     /* Text color */
  --sapphire-shadow: rgba(0, 0, 0, 0.15);       /* Shadow color */
  --sapphire-border-radius: 12px;               /* Corner roundness */
  --sapphire-blur: 12px;                        /* Backdrop blur amount */
  
  /* Progress bar colors */
  --sapphire-progress-bg: rgba(255, 255, 255, 0.2);  /* Progress background */
  --sapphire-progress-fill: rgba(255, 255, 255, 0.9); /* Progress fill */
  
  /* Notification type colors */
  --sapphire-success: rgba(16, 185, 129, 0.95); /* Success color */
  --sapphire-error: rgba(239, 68, 68, 0.95);    /* Error color */
  --sapphire-warning: rgba(245, 158, 11, 0.95); /* Warning color */
  --sapphire-info: rgba(59, 130, 246, 0.95);    /* Info color */
}
```

--------------------------------

### Flash Specific Notification with Neon Theme in JavaScript

Source: https://php-flasher.io/theme/neon

Example of flashing a notification using the Neon theme specifically via JavaScript, even if it's not the default. Useful for overriding the default theme for a single notification.

```javascript
flasher.use('theme.neon').success('This uses Neon Theme');
```

--------------------------------

### Configure Jade Theme

Source: https://php-flasher.io/theme/jade

Set up the Jade theme in your PHP Flasher configuration files.

```php
// config/flasher.php

return [
    'default' => 'theme.jade',

    'themes' => [
        'jade' => [
            'scripts' => [
                '/vendor/flasher/flasher.min.css',
                '/vendor/flasher/themes/theme.jade.min.js',
            ],
            'styles' => [
                '/vendor/flasher/themes/theme.jade.min.css',
            ],
        ],
    ],
];
```

```yaml
# config/packages/flasher.yaml

flasher:
    default: theme.jade

    themes:
        jade:
            scripts:
                - '/vendor/flasher/themes/theme.jade.min.js'
            styles:
                - '/vendor/flasher/themes/theme.jade.min.css'
```

--------------------------------

### Publish PHP Flasher Assets

Source: https://php-flasher.io/livewire

Execute this artisan command to publish the necessary assets for the package.

```bash
php artisan flasher:install__
```

--------------------------------

### Trigger Notification Types

Source: https://php-flasher.io/livewire

Examples of triggering standard notification types within Livewire components.

```php
flash()->success('Record updated successfully!')
```

```php
flash()->error('An error occurred while saving.')
```

```php
flash()->warning('Unsaved changes will be lost.')
```

```php
flash()->info('Your session will expire in 5 minutes.')
```

--------------------------------

### Trigger Notifications in JavaScript

Source: https://php-flasher.io/theme/material

Usage examples for triggering notifications in JavaScript when using the Material theme.

```javascript
flasher.success('Your changes have been saved!');
```

```javascript
flasher.use('theme.material').success('This uses Material Theme');
```

--------------------------------

### flash()->preset()

Source: https://php-flasher.io/installation

Triggers a notification based on a pre-defined configuration preset.

```APIDOC
## Method: flash()->preset()

### Description
Triggers a notification using a preset defined in the configuration file, with support for dynamic parameter substitution.

### Parameters
- **$preset** (string) - Required - The name of the preset as defined in your configuration.
- **$parameters** (array) - Optional - Key-value pairs for placeholder substitution in the message.

### Request Example
// Use a preset with parameter substitution
flash()->preset('entity_saved', [':entity' => 'product']);

### Response
- **Envelope** (object) - Returns an Envelope instance representing the notification.
```

--------------------------------

### Set Notification Position

Source: https://php-flasher.io/inertia

Use the `option()` method to set the notification position. This example places the notification at the bottom-right.

```php
flash()
    ->option('position', 'bottom-right')
    ->success('Positioned at the bottom-right');
```

--------------------------------

### Configure PHP Flasher

Source: https://php-flasher.io/laravel

Customize driver settings and presets in the config/flasher.php file.

```php
<?php

return [
    'default' => env('FLASHER_DEFAULT', 'flasher'),

    'drivers' => [
        'flasher' => [
            'root' => env('FLASHER_ROOT', base_path('vendor/flasher')),
            'translate' => env('FLASHER_TRANSLATE', true),
            'inject_assets' => env('FLASHER_INJECT_ASSETS', true),
        ],
    ],

    'presets' => [
        // Your custom presets here
    ],
];
```

--------------------------------

### Configure JavaScript Dependencies

Source: https://php-flasher.io/inertia

Add the local PHP Flasher package to your project's package.json dependencies.

```json
{
    "dependencies": {
        "@flasher/flasher": "file:vendor/php-flasher/flasher/Resources"
    }
}__
```

--------------------------------

### Configure Crystal Theme in PHP

Source: https://php-flasher.io/theme/crystal

Register the Crystal theme assets in your PHP configuration files.

```php
// config/flasher.php

return [
    'default' => 'theme.crystal',

    'themes' => [
        'crystal' => [
            'scripts' => [
                '/vendor/flasher/flasher.min.css',
                '/vendor/flasher/themes/theme.crystal.min.js',
            ],
            'styles' => [
                '/vendor/flasher/themes/theme.crystal.min.css',
            ],
        ],
    ],
];
```

```yaml
# config/packages/flasher.yaml

flasher:
    default: theme.crystal

    themes:
        crystal:
            scripts:
                - '/vendor/flasher/themes/theme.crystal.min.js'
            styles:
                - '/vendor/flasher/themes/theme.crystal.min.css'
```

--------------------------------

### Displaying Success Notifications

Source: https://php-flasher.io/library/sweetalert

Demonstrates how to trigger success notifications using the helper function or dependency injection.

```php
use Flasher\SweetAlert\Prime\SweetAlertInterface;

class BookController
{
    public function saveBook()
    {        
        sweetalert()->success('Your account has been re-verified.');
        
        // or simply 
        
        sweetalert('Your account has been re-verified.');
    }
    
    /**
     * if you prefer to use dependency injection 
     */
    public function register(SweetAlertInterface $sweetalert)
    {
        // ...

        $sweetalert->success('Your account has been re-verified.');

        // ... redirect or render the view
    }
}
```

--------------------------------

### Add Title to PHP Flasher Notification

Source: https://php-flasher.io/laravel

Example of adding a title to a success notification using the flash helper function.

```php
flash()->success('Your profile has been updated successfully.', 'Profile Updated');
```

--------------------------------

### Initialize Jade Theme in JavaScript

Source: https://php-flasher.io/theme/jade

Set the Jade theme as the default or use it for specific notifications via JavaScript.

```javascript
// Set as default theme
// Then use it
flasher.use('theme.jade').success('Well done!');
```

--------------------------------

### Handle SweetAlert Events in Livewire

Source: https://php-flasher.io/livewire

Demonstrates listening for SweetAlert confirmation and denial events using the #[On] attribute.

```php
<?php

namespace App\Livewire;

use Livewire\Attributes\On;
use Livewire\Component;

class UserComponent extends Component
{
    public function render()
    {
        return <<<'HTML'
            <div>
                <button wire:click="deleteUser">Delete User</button>
            </div>
        HTML;
    }

    public function deleteUser()
    {
        sweetalert()
            ->showDenyButton()
            ->info('Are you sure you want to delete the user?');
    }

    #[On('sweetalert:confirmed')]
    public function onConfirmed(array $payload): void
    {
        // Delete the user here

        flash()->info('User successfully deleted.');
    }

    #[On('sweetalert:denied')]
    public function onDeny(array $payload): void
    {
        flash()->info('Deletion cancelled.');
    }
}
```

--------------------------------

### Configure Slack Theme in PHP and YAML

Source: https://php-flasher.io/theme/slack

Define the Slack theme in your configuration files to enable it as the default notification style.

```php
// config/flasher.php

return [
    'default' => 'theme.slack',

    'themes' => [
        'slack' => [
            'scripts' => [
                '/vendor/flasher/flasher.min.css',
                '/vendor/flasher/themes/theme.slack.min.js',
            ],
            'styles' => [
                '/vendor/flasher/themes/theme.slack.min.css',
            ],
        ],
    ],
];
```

```yaml
# config/packages/flasher.yaml

flasher:
    default: theme.slack

    themes:
        slack:
            scripts:
                - '/vendor/flasher/themes/theme.slack.min.js'
            styles:
                - '/vendor/flasher/themes/theme.slack.min.css'
```

--------------------------------

### Configure RTL Mode

Source: https://php-flasher.io/library/toastr

Enable right-to-left text direction.

```php
toastr()->rtl(bool $rtl = true);
```

```php
toastr()
    ->rtl(true)
    ->info('تم قفل حسابك وتم إرسال رسالة تأكيد إلكترونية.');
```

--------------------------------

### Use Aurora Theme in JavaScript (Specific)

Source: https://php-flasher.io/theme/aurora

Example of explicitly using the Aurora theme for a success notification in JavaScript, overriding the default.

```javascript
flasher.use('theme.aurora').success('This uses Aurora Theme');
```

--------------------------------

### Configure Noty sounds

Source: https://php-flasher.io/library/noty

Sets audio sources, volume, and visibility conditions for notification sounds.

```php
noty()->sounds(string $option, mixed $value)
```

```php
noty()
    ->sounds('sources', ['/static/sounds/notification.wav'])
    ->sounds('volume', 0.3)
    ->sounds('conditions', ['docVisible', 'docHidden'])
    ->warning('Exercise caution when performing this action.');
```

--------------------------------

### Configure Progress Bar

Source: https://php-flasher.io/library/toastr

Toggle the visibility of the progress bar.

```php
toastr()->progressBar(bool $progressBar = true);
```

```php
toastr()
    ->progressBar(false)
    ->error('There was a problem submitting your form.');
```

--------------------------------

### Use Aurora Theme in PHP (Specific)

Source: https://php-flasher.io/theme/aurora

Example of explicitly using the Aurora theme for a success notification in PHP, overriding the default.

```php
flash()->use('theme.aurora')->success('This uses Aurora Theme');
```

--------------------------------

### Display Success Flash Message

Source: https://php-flasher.io/inertia

Use this method to display a success notification to the user. Ensure the PHP Flasher library is installed and configured.

```php
flash()->success('Item created successfully!')
```

--------------------------------

### PHP Flasher with Toastr Adapter

Source: https://php-flasher.io/javascript

Integrate and use the Toastr adapter with PHP Flasher. Include both the core flasher CDN and the toastr adapter CDN, then use the factory or direct method.

```html
<script defer src="https://cdn.jsdelivr.net/npm/@flasher/flasher@2.5.1/dist/flasher.min.js"></script>
<script defer src="https://cdn.jsdelivr.net/npm/@flasher/flasher-toastr@2.5.1/dist/flasher-toastr.min.js"></script>
<script>
    const factory = flasher.use('toastr');
    factory.error("Oops! Something went wrong!");
    factory.warning("Are you sure you want to proceed ?");
    factory.success("Data has been saved successfully!");
    factory.info("Welcome back");
    
    // or simply with
    flasher.toastr.error("Oops! Something went wrong!");
    flasher.toastr.warning("Are you sure you want to proceed ?");
    flasher.toastr.success("Data has been saved successfully!");
    flasher.toastr.info("Welcome back");
</script>
```

--------------------------------

### Configuring Notification Themes

Source: https://php-flasher.io/library/noty

Applies different visual themes to notifications. Ensure the corresponding CSS file is loaded.

```php
noty()->theme(string $theme);
```

```php
#/ noty theme mint

noty()
    ->theme('mint')
    ->success('Your account has been reactivated.');

noty()
    ->theme('mint')
    ->error('There was a problem receiving your message.');

noty()
    ->theme('mint')
    ->warning('Your file may not have been uploaded.');

noty()
    ->theme('mint')
    ->info('Your account has been created, but requires verification.');
```

```php
#/ noty theme relax

// don't forget to load the theme css file: https://github.com/needim/noty/blob/master/lib/themes/relax.css

noty()
    ->theme('relax')
    ->success('Your account has been re-activated.');

noty()
    ->theme('relax')
    ->error('There was a problem restoring your account.');

noty()
    ->theme('relax')
    ->warning('Your order may not have been placed.');

noty()
    ->theme('relax')
    ->info('Your address has been updated and a confirmation email has been sent.');
```

```php
#/ noty theme metroui

// Theme: https://github.com/needim/noty/blob/master/lib/themes/metroui.css

noty()
    ->theme('metroui')
    ->success('Your order has been placed.');

noty()
    ->theme('metroui')
    ->error('There was an issue shipping your product.');

noty()
    ->theme('metroui')
    ->warning('Your password may not have been changed.');

noty()
    ->theme('metroui')
    ->info('Your product has been shipped and a tracking number has been sent to your email.');
```

```php
#/ noty theme light

// Theme: https://github.com/needim/noty/blob/master/lib/themes/light.css

noty()
    ->theme('light')
    ->success('Your account has been restored.');

noty()
    ->theme('light')
    ->error('There was an issue deactivating your account.');

noty()
    ->theme('light')
    ->warning('Your order may not have been placed.');

noty()
    ->theme('light')
    ->info('Heads up: This may take a while. Be patient.');
```

```php
#/ noty theme sunset
// Theme: https://github.com/needim/noty/blob/master/lib/themes/sunset.css

noty()
    ->theme('sunset')
    ->success('Your order has been shipped.');

noty()
    ->theme('sunset')
    ->error('There was a problem re-verifying your account.');

noty()
    ->theme('sunset')
    ->warning('Your donation may not have been received.');

noty()
    ->theme('sunset')
    ->info('Your password has been set and a confirmation email has been sent.');
```

--------------------------------

### Configure Flasher Assets and Options

Source: https://php-flasher.io/symfony

Set global options for PHP Flasher, such as asset injection, CSS framework usage, and default notification settings like animation, close button, progress bar, position, and timeout.

```yaml
flasher:
    main:
        filter:
            # Filter flash messages by priority or criteria
            priority: ~

        # Limit the number of flash messages displayed
        limit: ~

        # Map Flash messages to specific criteria
        map: []

        # Automatically inject Flasher scripts into your HTML
        inject_assets: true

        # Use bulma CSS framework
        use_bulma: false

        # Use tailwind CSS framework
        use_tailwind: false

        # Use bootstrap CSS framework
        use_bootstrap: false

        # Default flash notification options
        options:
            # Animation: fade, slide, zoom, flip, bounce, etc.
            animation: true

            # Close button on notifications
            close_button: false

            # Display progress bar
            progress_bar: true

            # Notification position: top-right, top-left, bottom-right, bottom-left, top-center, bottom-center
            position: top-right

            # Right-to-left support
            rtl: false

            # Time before notification auto-hides (in milliseconds)
            timeout: 5000

        # Translate flash messages
        translate: true

        # Flash messages translation domain
        translation_domain: flasher

        # Default rendering context
        default_context: ~

        # Available rendering contexts
        contexts: []
```

--------------------------------

### Use iOS Theme (JavaScript)

Source: https://php-flasher.io/theme/ios

Set the iOS theme as default and display a success message using JavaScript.

```javascript
// Set as default theme
// Then use it
flasher.use('theme.ios').success('Well done!');
```

--------------------------------

### Initialize Emerald Theme in JavaScript

Source: https://php-flasher.io/theme/emerald

Set the Emerald theme as the default or use it for specific notifications via the JavaScript API.

```javascript
// Set as default theme
// Then use it
flasher.use('theme.emerald').success('Well done!');
```

--------------------------------

### Vue Layout Component for Flash Messages

Source: https://php-flasher.io/inertia

Integrates PHPFlasher with Inertia.js by watching for changes in shared Inertia props and rendering flash messages. Requires '@flasher/flasher' to be installed.

```vue
<script setup>
import { computed, watch } from 'vue'
import { usePage } from '@inertiajs/vue3'
import flasher from '@flasher/flasher'

// Access shared data from Inertia
const page = usePage()
const messages = computed(() => page.props.messages)

// Watch for changes in flash messages
watch(
  messages,
  (newMessages) => {
    if (newMessages) {
      flasher.render(newMessages)
    }
  },
  { immediate: true }
)
</script>

<template>
  <div class="min-h-screen bg-gray-100">
    <nav class="bg-white border-b border-gray-100">
      <!-- Navigation content -->
    </nav>

    <!-- Page Content -->
    <main>
      <slot />
    </main>

    <footer class="bg-white border-t border-gray-100 mt-auto">
      <!-- Footer content -->
    </footer>
  </div>
</template>
```

--------------------------------

### Configuration Methods

Source: https://php-flasher.io/library/sweetalert

Methods to customize the appearance and behavior of the SweetAlert popup.

```APIDOC
## Configuration Methods

### Description
Methods to configure popup positioning, timers, images, and button visibility.

### Methods
- imageUrl(string $imageUrl, int $imageWidth, int $imageHeight, string $imageAlt)
- position(string $position)
- toast(bool $toast, string $position, bool $showConfirmButton)
- timer(int $timer)
- timerProgressBar(bool $timerProgressBar)
- backdrop(bool|string $backdrop)
- grow(bool|string $grow)
- showConfirmButton(bool $showConfirmButton, string $confirmButtonText, string $confirmButtonColor, string $confirmButtonAriaLabel)
- showDenyButton(bool $showDenyButton, string $denyButtonText, string $denyButtonColor, string $denyButtonAriaLabel)
- showCancelButton(bool $showCancelButton, string $cancelButtonText, string $cancelButtonColor, string $cancelButtonAriaLabel)
- showCloseButton(bool $showCloseButton)
```

--------------------------------

### Basic Usage in Symfony Controller

Source: https://php-flasher.io/symfony

Add a success notification in a Symfony controller after a successful action. This example shows how to use the helper function `flash()` to display a message.

```php
<?php

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class ProductController extends AbstractController
{
    #[Route('/product/create', name: 'app_product_create')]
    public function create(): Response
    {
        // Your logic to create a product

        // Add a success notification
        flash()->success('Product created successfully!');

        return $this->redirectToRoute('app_product_list');
    }
}
```

--------------------------------

### Display Info Flash Message

Source: https://php-flasher.io/inertia

Use this method to display an informational notification. This is suitable for conveying non-critical updates or reminders. Ensure the PHP Flasher library is installed and configured.

```php
flash()->info('Your session expires in 10 minutes.')
```

--------------------------------

### Set and Use Theme in JavaScript

Source: https://php-flasher.io/theme/flasher

Programmatically set the theme and trigger a success notification.

```javascript
// Set as default theme
// Then use it
flasher.use('theme.flasher').success('Well done!');
```

--------------------------------

### Publish PHPFlasher Configuration

Source: https://php-flasher.io/blog/2025/03/29/integrating-phpflasher-with-laravel

Publish the configuration file to customize PHPFlasher settings. This command is run in the terminal.

```bash
php artisan vendor:publish --tag=flasher-config
```

--------------------------------

### Display Error Flash Message

Source: https://php-flasher.io/inertia

Use this method to display an error notification. This is useful for informing users about issues during operations. Ensure the PHP Flasher library is installed and configured.

```php
flash()->error('An error occurred!')
```

--------------------------------

### Display Notifications

Source: https://php-flasher.io/library/notyf

Use the helper function or dependency injection to trigger success, info, warning, or error notifications.

```php
#/ notyf

use Flasher\Notyf\Prime\NotyfInterface;

class BookController
{
    public function saveBook()
    {        
        notyf()->success('Your subscription has been activated.');
        
        // or simply 
        
        notyf('Your subscription has been activated.');
    }
    
    /**
     * if you prefer to use dependency injection 
     */
    public function register(NotyfInterface $notyf)
    {
        // ...

        $notyf->success('Your feedback has been received.');

        // ... redirect or render the view
    }
}
```

```php
#/ usage info

notyf()->info('Your application has been received and is being reviewed.');
```

```php
#/ usage warning

notyf()->warning('Your application may not have been received.');
```

```php
#/ usage error

notyf()->error('There was an issue generating your report.');
```

--------------------------------

### Initialize Material Theme in JavaScript

Source: https://php-flasher.io/theme/material

Set the Material theme as the default for JavaScript notifications.

```javascript
// Set as default theme
// Then use it
flasher.use('theme.material').success('Well done!');
```

--------------------------------

### Set Notification Timeout

Source: https://php-flasher.io/inertia

Control how long a notification stays visible using the `option()` method with the 'timeout' key. This example sets the timeout to 8000 milliseconds (8 seconds).

```php
flash()
    ->option('timeout', 8000) // 8 seconds
    ->info('This message stays longer');
```

--------------------------------

### Configure Default Notification Library

Source: https://php-flasher.io/blog/2025/03/30/phpflasher-configuration-options-for-beginners

Sets the default adapter used for rendering notifications.

```php
'default' => 'flasher',
```

--------------------------------

### Display Warning Flash Message

Source: https://php-flasher.io/inertia

Use this method to display a warning notification. This can alert users to potential problems or prompt them for review. Ensure the PHP Flasher library is installed and configured.

```php
flash()->warning('Please review your submission.')
```

--------------------------------

### Configure Tap to Dismiss

Source: https://php-flasher.io/library/toastr

Enable dismissing the toast by tapping it.

```php
toastr()->tapToDismiss(bool $tapToDismiss = true);
```

```php
toastr()
    ->tapToDismiss(true)
```

--------------------------------

### Initialize Slack Theme in JavaScript

Source: https://php-flasher.io/theme/slack

Set the Slack theme as the default or apply it to specific notifications using the JavaScript API.

```javascript
// Set as default theme
// Then use it
flasher.use('theme.slack').success('Well done!');
```

--------------------------------

### force

Source: https://php-flasher.io/library/noty

Determines the DOM insertion method. If false, uses append; if true, uses prepend.

```APIDOC
## POST /noty/force

### Description
Determines the DOM insertion method. If false, uses append; if true, uses prepend.

### Method
POST

### Endpoint
/noty/force

### Parameters
#### Query Parameters
- **force** (bool) - Optional - Set to true to prepend, false to append.

### Request Example
```json
{
  "force": false
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Notification force setting updated."
}
```
```

--------------------------------

### Configure Ruby Theme

Source: https://php-flasher.io/theme/ruby

Define the Ruby theme in your configuration files to register the necessary scripts and styles.

```php
// config/flasher.php

return [
    'default' => 'theme.ruby',

    'themes' => [
        'ruby' => [
            'scripts' => [
                '/vendor/flasher/flasher.min.css',
                '/vendor/flasher/themes/theme.ruby.min.js',
            ],
            'styles' => [
                '/vendor/flasher/themes/theme.ruby.min.css',
            ],
        ],
    ],
];
```

```yaml
# config/packages/flasher.yaml

flasher:
    default: theme.ruby

    themes:
        ruby:
            scripts:
                - '/vendor/flasher/themes/theme.ruby.min.js'
            styles:
                - '/vendor/flasher/themes/theme.ruby.min.css'
```

--------------------------------

### Handle Toastr Events in Livewire

Source: https://php-flasher.io/livewire

Demonstrates listening for various Toastr lifecycle events within a Livewire component.

```php
<?php

namespace App\Livewire;

use Livewire\Attributes\On;
use Livewire\Component;

class ToastrEventsComponent extends Component
{
    #[On('toastr:click')]
    public function onToastrClick(array $payload): void
    {
        // Handle notification click
    }

    #[On('toastr:close')]
    public function onToastrClose(array $payload): void
    {
        // Handle notification close
    }

    #[On('toastr:show')]
    public function onToastrShow(array $payload): void
    {
        // Handle notification shown
    }

    #[On('toastr:hidden')]
    public function onToastrHidden(array $payload): void
    {
        // Handle notification hidden
    }
}
```

--------------------------------

### Configure Sapphire Theme in Laravel

Source: https://php-flasher.io/theme/sapphire

Configuration file for setting the Sapphire theme as the default in a Laravel project. Includes paths for CSS and JavaScript assets.

```php
// config/flasher.php

return [
    'default' => 'theme.sapphire',

    'themes' => [
        'sapphire' => [
            'scripts' => [
                '/vendor/flasher/flasher.min.css',
                '/vendor/flasher/themes/theme.sapphire.min.js',
            ],
            'styles' => [
                '/vendor/flasher/themes/theme.sapphire.min.css',
            ],
        ],
    ],
];
```

--------------------------------

### Basic PHP Flasher Usage (CDN)

Source: https://php-flasher.io/javascript

Use the flasher object to display notifications after including the library via CDN. Ensure the script tag is present before this script.

```html
<script defer src="https://cdn.jsdelivr.net/npm/@flasher/flasher@2.5.1/dist/flasher.min.js"></script>
<script>
    flasher.error("Oops! Something went wrong!");
    flasher.warning("Are you sure you want to proceed ?");
    flasher.success("Data has been saved successfully!");
    flasher.info("Welcome back");
</script>
```
Tokens:
Raw