mirror of
https://github.com/php-flasher/php-flasher.git
synced 2026-03-31 15:07:47 +01:00
docs: redesign root README for better first impression
Key improvements: - Strong tagline: "One line of PHP. Beautiful notifications. Zero JavaScript" - Quick Start at the top (installation in 1 command) - "Why PHPFlasher?" comparison table showing advantages - Livewire integration section (previously missing) - Collapsible themes list for better scannability - Cleaner visual hierarchy with horizontal rules - Prominent links to docs, playground, and bug reports - Simplified contributors section using contrib.rocks - Clear calls to action for starring and sharing
This commit is contained in:
Younes ENNAJI
@@ -1,9 +1,3 @@
|
|||||||
<div align="center">
|
|
||||||
<a href="https://github.com/php-flasher/php-flasher/blob/2.x/docs/palestine.md">
|
|
||||||
<img src="https://raw.githubusercontent.com/php-flasher/art/main/palestine-banner-support.svg" width="800px" alt="Help Palestine"/>
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<picture>
|
<picture>
|
||||||
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/php-flasher/art/main/php-flasher-logo-dark.png">
|
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/php-flasher/art/main/php-flasher-logo-dark.png">
|
||||||
@@ -11,316 +5,239 @@
|
|||||||
</picture>
|
</picture>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
<h1 align="center">Elegant Flash Notifications for PHP</h1>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://www.linkedin.com/in/younes--ennaji"><img src="https://img.shields.io/badge/author-@yoeunes-blue.svg" alt="Author Badge"></a>
|
<strong>One line of PHP. Beautiful notifications. Zero JavaScript.</strong>
|
||||||
<a href="https://github.com/php-flasher/php-flasher"><img src="https://img.shields.io/badge/source-php--flasher/php--flasher-blue.svg" alt="Source Code Badge"></a>
|
|
||||||
<a href="https://github.com/php-flasher/php-flasher/releases"><img src="https://img.shields.io/github/tag/php-flasher/flasher.svg" alt="GitHub Release Badge"></a>
|
|
||||||
<a href="https://github.com/php-flasher/flasher/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="License Badge"></a>
|
|
||||||
<a href="https://packagist.org/packages/php-flasher/flasher"><img src="https://img.shields.io/packagist/dt/php-flasher/flasher.svg" alt="Packagist Downloads Badge"></a>
|
|
||||||
<a href="https://github.com/php-flasher/php-flasher"><img src="https://img.shields.io/github/stars/php-flasher/php-flasher.svg" alt="GitHub Stars Badge"></a>
|
|
||||||
<a href="https://packagist.org/packages/php-flasher/flasher"><img src="https://img.shields.io/packagist/php-v/php-flasher/flasher.svg" alt="Supported PHP Version Badge"></a>
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
# PHPFlasher: Beautiful Notifications Made Simple
|
<p align="center">
|
||||||
|
<a href="https://packagist.org/packages/php-flasher/flasher"><img src="https://img.shields.io/packagist/dt/php-flasher/flasher.svg?style=flat-square&label=downloads" alt="Downloads"></a>
|
||||||
|
<a href="https://github.com/php-flasher/php-flasher"><img src="https://img.shields.io/github/stars/php-flasher/php-flasher.svg?style=flat-square&label=stars" alt="Stars"></a>
|
||||||
|
<a href="https://github.com/php-flasher/php-flasher/releases"><img src="https://img.shields.io/github/v/release/php-flasher/flasher.svg?style=flat-square" alt="Release"></a>
|
||||||
|
<a href="https://packagist.org/packages/php-flasher/flasher"><img src="https://img.shields.io/packagist/php-v/php-flasher/flasher.svg?style=flat-square" alt="PHP Version"></a>
|
||||||
|
<a href="https://github.com/php-flasher/flasher/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square" alt="License"></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
## 🚀 See It In Action
|
<p align="center">
|
||||||
|
<a href="https://php-flasher.io"><strong>Documentation</strong></a> ·
|
||||||
|
<a href="https://php-flasher.io/playground"><strong>Live Playground</strong></a> ·
|
||||||
|
<a href="https://github.com/php-flasher/php-flasher/issues"><strong>Report Bug</strong></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
**Laravel:**
|
||||||
|
```bash
|
||||||
|
composer require php-flasher/flasher-laravel && php artisan flasher:install
|
||||||
|
```
|
||||||
|
|
||||||
|
**Symfony:**
|
||||||
|
```bash
|
||||||
|
composer require php-flasher/flasher-symfony && php bin/console flasher:install
|
||||||
|
```
|
||||||
|
|
||||||
|
**That's it!** Now use it:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
// In your controller
|
flash()->success('Welcome aboard! Your account is ready.');
|
||||||
public function updateProfile(Request $request)
|
|
||||||
{
|
|
||||||
// Process form submission
|
|
||||||
$user = Auth::user();
|
|
||||||
$user->update($request->validated());
|
|
||||||
|
|
||||||
// Show a beautiful notification to the user
|
|
||||||
flash()->success('Your profile has been updated successfully!');
|
|
||||||
|
|
||||||
return redirect()->back();
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
That's it! PHPFlasher will display an elegant success notification to your user. No JavaScript to write, no frontend setup needed.
|
---
|
||||||
|
|
||||||
## 🔄 Compatibility
|
## Why PHPFlasher?
|
||||||
|
|
||||||
| Requirements | Version |
|
| | PHPFlasher | Others |
|
||||||
|--------------|---------|
|
|---|:---:|:---:|
|
||||||
| PHP | ≥ 8.2 |
|
| **Zero JavaScript** | Write PHP only, frontend handled automatically | Requires manual JS setup |
|
||||||
| Laravel | ≥ 11.0 |
|
| **Auto Asset Injection** | CSS/JS injected automatically | Manual script tags needed |
|
||||||
| Symfony | ≥ 7.0 |
|
| **26 Built-in Themes** | Amazon, iOS, Slack, Material & more | Limited or no themes |
|
||||||
|
| **4 Notification Libraries** | Toastr, SweetAlert, Noty, Notyf | Single library only |
|
||||||
|
| **Livewire Integration** | Full event system support | Limited or none |
|
||||||
|
| **RTL Support** | Built-in right-to-left | Often missing |
|
||||||
|
| **Framework Agnostic** | Laravel, Symfony, or vanilla PHP | Framework-specific |
|
||||||
|
|
||||||
## 📑 Table of Contents
|
---
|
||||||
|
|
||||||
- [Introduction](#-introduction)
|
## Notification Types
|
||||||
- [Features](#-key-features)
|
|
||||||
- [Installation](#-installation)
|
|
||||||
- [Usage Examples](#-usage-examples)
|
|
||||||
- [Themes](#-themes)
|
|
||||||
- [Adapters](#-adapters)
|
|
||||||
- [Advanced Configuration](#-advanced-configuration)
|
|
||||||
- [Adapter Documentation Example](#-adapter-documentation-example)
|
|
||||||
- [Community & Support](#-community--support)
|
|
||||||
- [Contributors](#-contributors-and-sponsors)
|
|
||||||
- [License](#-license)
|
|
||||||
|
|
||||||
## 🌟 Introduction
|
|
||||||
|
|
||||||
PHPFlasher is a powerful, framework-agnostic library that makes it simple to add beautiful flash messages to your web applications. It provides a consistent API for displaying notifications across your PHP applications, whether you're using Laravel, Symfony, or any other PHP framework.
|
|
||||||
|
|
||||||
Flash messages are short-lived notifications that appear after a user performs an action, such as submitting a form. PHPFlasher helps you create these notifications with minimal effort while ensuring they look great and behave consistently.
|
|
||||||
|
|
||||||
## ✨ Key Features
|
|
||||||
|
|
||||||
- **Zero JavaScript Required**: Write only PHP code - frontend functionality is handled automatically
|
|
||||||
- **Framework Support**: First-class Laravel and Symfony integration
|
|
||||||
- **Beautiful Themes**: Multiple built-in themes ready to use out of the box
|
|
||||||
- **Multiple Notification Types**: Success, error, warning, and info notifications
|
|
||||||
- **Highly Customizable**: Positions, timeouts, animations, and more
|
|
||||||
- **Third-Party Adapters**: Integration with popular libraries like Toastr, SweetAlert, and more
|
|
||||||
- **API Response Support**: Works with AJAX and API responses
|
|
||||||
- **TypeScript Support**: Full TypeScript definitions for frontend customization
|
|
||||||
- **Lightweight**: Minimal performance impact
|
|
||||||
|
|
||||||
## 📦 Installation
|
|
||||||
|
|
||||||
### For Laravel Projects
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install the Laravel adapter
|
|
||||||
composer require php-flasher/flasher-laravel
|
|
||||||
|
|
||||||
# Set up assets automatically
|
|
||||||
php artisan flasher:install
|
|
||||||
```
|
|
||||||
|
|
||||||
PHPFlasher automatically injects the necessary JavaScript and CSS assets into your Blade templates. No additional setup required!
|
|
||||||
|
|
||||||
### For Symfony Projects
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install the Symfony adapter
|
|
||||||
composer require php-flasher/flasher-symfony
|
|
||||||
|
|
||||||
# Set up assets automatically
|
|
||||||
php bin/console flasher:install
|
|
||||||
```
|
|
||||||
|
|
||||||
PHPFlasher automatically injects the necessary JavaScript and CSS assets into your Twig templates.
|
|
||||||
|
|
||||||
## 📚 Usage Examples
|
|
||||||
|
|
||||||
### Basic Notifications
|
|
||||||
|
|
||||||
```php
|
```php
|
||||||
// Success notification
|
|
||||||
flash()->success('Operation completed successfully!');
|
flash()->success('Operation completed successfully!');
|
||||||
|
flash()->error('Oops! Something went wrong.');
|
||||||
// Error notification
|
|
||||||
flash()->error('An error occurred. Please try again.');
|
|
||||||
|
|
||||||
// Info notification
|
|
||||||
flash()->info('Your account will expire in 10 days.');
|
|
||||||
|
|
||||||
// Warning notification
|
|
||||||
flash()->warning('Please backup your data before continuing.');
|
flash()->warning('Please backup your data before continuing.');
|
||||||
|
flash()->info('A new version is available for download.');
|
||||||
```
|
```
|
||||||
|
|
||||||
### With Custom Titles
|
### With Titles
|
||||||
|
|
||||||
```php
|
```php
|
||||||
flash()->success('Your changes have been saved!', 'Update Successful');
|
flash()->success('Your changes have been saved.', 'Update Complete');
|
||||||
flash()->error('Unable to connect to the server.', 'Connection Error');
|
flash()->error('Unable to connect to server.', 'Connection Failed');
|
||||||
```
|
```
|
||||||
|
|
||||||
### With Custom Options
|
### With Options
|
||||||
|
|
||||||
```php
|
```php
|
||||||
flash()->success('Profile updated successfully!', [
|
flash()->success('Profile updated!', [
|
||||||
'timeout' => 10000, // Display for 10 seconds
|
|
||||||
'position' => 'bottom-right',
|
'position' => 'bottom-right',
|
||||||
'closeButton' => true,
|
'timeout' => 10000,
|
||||||
]);
|
|
||||||
|
|
||||||
flash()->error('Failed to submit form.', 'Error', [
|
|
||||||
'timeout' => 0, // No timeout (stay until dismissed)
|
|
||||||
'position' => 'center',
|
|
||||||
]);
|
]);
|
||||||
```
|
```
|
||||||
|
|
||||||
### In Controllers
|
---
|
||||||
|
|
||||||
|
## 26 Beautiful Themes
|
||||||
|
|
||||||
|
PHPFlasher includes **26 professionally designed themes** ready to use:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
// Laravel
|
flash()->success('Welcome!', ['theme' => 'amazon']);
|
||||||
public function store(Request $request)
|
flash()->success('Welcome!', ['theme' => 'ios']);
|
||||||
|
flash()->success('Welcome!', ['theme' => 'slack']);
|
||||||
|
flash()->success('Welcome!', ['theme' => 'material']);
|
||||||
|
```
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary><strong>View All Themes</strong></summary>
|
||||||
|
|
||||||
|
| Theme | Style |
|
||||||
|
|-------|-------|
|
||||||
|
| `flasher` | Default clean design |
|
||||||
|
| `amazon` | Amazon-inspired |
|
||||||
|
| `bootstrap` | Bootstrap style |
|
||||||
|
| `ios` | Apple iOS notifications |
|
||||||
|
| `slack` | Slack messaging style |
|
||||||
|
| `material` | Google Material Design |
|
||||||
|
| `tailwind` | Tailwind CSS inspired |
|
||||||
|
| `google` | Google notifications |
|
||||||
|
| `facebook` | Facebook style |
|
||||||
|
| `minimal` | Ultra-clean minimal |
|
||||||
|
| `amber` | Warm amber tones |
|
||||||
|
| `aurora` | Gradient effects |
|
||||||
|
| `crystal` | Transparent design |
|
||||||
|
| `emerald` | Modern green palette |
|
||||||
|
| `jade` | Soft jade colors |
|
||||||
|
| `neon` | Bright attention-grabbing |
|
||||||
|
| `onyx` | Dark mode sleek |
|
||||||
|
| `ruby` | Bold ruby accents |
|
||||||
|
| `sapphire` | Elegant blue style |
|
||||||
|
| `shadow` | Soft shadow effects |
|
||||||
|
| `spectrum` | Colorful spectrum |
|
||||||
|
| `sunset` | Warm sunset colors |
|
||||||
|
| `zen` | Calm minimal design |
|
||||||
|
|
||||||
|
[**See all themes with live demos →**](https://php-flasher.io/themes)
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notification Libraries
|
||||||
|
|
||||||
|
Need more features? Use popular notification libraries:
|
||||||
|
|
||||||
|
### Toastr
|
||||||
|
|
||||||
|
```bash
|
||||||
|
composer require php-flasher/flasher-toastr-laravel
|
||||||
|
```
|
||||||
|
|
||||||
|
```php
|
||||||
|
toastr()->success('Profile saved!', [
|
||||||
|
'positionClass' => 'toast-bottom-right',
|
||||||
|
'progressBar' => true,
|
||||||
|
]);
|
||||||
|
```
|
||||||
|
|
||||||
|
### SweetAlert
|
||||||
|
|
||||||
|
```bash
|
||||||
|
composer require php-flasher/flasher-sweetalert-laravel
|
||||||
|
```
|
||||||
|
|
||||||
|
```php
|
||||||
|
sweetalert()
|
||||||
|
->showDenyButton()
|
||||||
|
->showCancelButton()
|
||||||
|
->warning('Do you want to save changes?');
|
||||||
|
```
|
||||||
|
|
||||||
|
### Noty
|
||||||
|
|
||||||
|
```bash
|
||||||
|
composer require php-flasher/flasher-noty-laravel
|
||||||
|
```
|
||||||
|
|
||||||
|
```php
|
||||||
|
noty()->success('Data synchronized!', [
|
||||||
|
'layout' => 'topCenter',
|
||||||
|
'timeout' => 3000,
|
||||||
|
]);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Notyf
|
||||||
|
|
||||||
|
```bash
|
||||||
|
composer require php-flasher/flasher-notyf-laravel
|
||||||
|
```
|
||||||
|
|
||||||
|
```php
|
||||||
|
notyf()->success('Upload complete!', [
|
||||||
|
'dismissible' => true,
|
||||||
|
'ripple' => true,
|
||||||
|
]);
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Livewire Integration
|
||||||
|
|
||||||
|
PHPFlasher integrates seamlessly with Laravel Livewire:
|
||||||
|
|
||||||
|
```php
|
||||||
|
use Livewire\Attributes\On;
|
||||||
|
|
||||||
|
class UserProfile extends Component
|
||||||
{
|
{
|
||||||
// Process form...
|
public function save()
|
||||||
|
{
|
||||||
flash()->success('Product created successfully!');
|
// Save logic...
|
||||||
return redirect()->route('products.index');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Symfony
|
sweetalert()
|
||||||
public function store(Request $request, FlasherInterface $flasher)
|
->showDenyButton()
|
||||||
{
|
->success('Save changes?');
|
||||||
// Process form...
|
}
|
||||||
|
|
||||||
$flasher->success('Product created successfully!');
|
#[On('sweetalert:confirmed')]
|
||||||
return $this->redirectToRoute('products.index');
|
public function onConfirmed(array $payload): void
|
||||||
|
{
|
||||||
|
// User clicked confirm
|
||||||
|
$this->user->save();
|
||||||
|
flash()->success('Profile saved!');
|
||||||
|
}
|
||||||
|
|
||||||
|
#[On('sweetalert:denied')]
|
||||||
|
public function onDenied(array $payload): void
|
||||||
|
{
|
||||||
|
// User clicked deny
|
||||||
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Specific Use Cases
|
[**Livewire documentation →**](https://php-flasher.io/livewire)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
### Laravel
|
||||||
|
|
||||||
```php
|
```php
|
||||||
// Form validation errors
|
// config/flasher.php
|
||||||
if ($validator->fails()) {
|
|
||||||
flash()->error('Please fix the errors in your form.');
|
|
||||||
return redirect()->back()->withErrors($validator);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Multi-step process
|
|
||||||
flash()->success('Step 1 completed!');
|
|
||||||
flash()->info('Please complete step 2.');
|
|
||||||
|
|
||||||
// With HTML content (must enable HTML option)
|
|
||||||
flash()->success('Your <strong>account</strong> is ready!', [
|
|
||||||
'escapeHtml' => false
|
|
||||||
]);
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🎨 Themes
|
|
||||||
|
|
||||||
PHPFlasher comes with beautiful built-in themes ready to use immediately:
|
|
||||||
|
|
||||||
### Default Theme (Flasher)
|
|
||||||
|
|
||||||
The default theme provides clean, elegant notifications that work well in any application:
|
|
||||||
|
|
||||||
```php
|
|
||||||
flash()->success('Operation completed!');
|
|
||||||
```
|
|
||||||
|
|
||||||
### Other Built-In Themes
|
|
||||||
|
|
||||||
PHPFlasher includes multiple themes to match your application's design:
|
|
||||||
|
|
||||||
```php
|
|
||||||
// Set the theme in your configuration or per notification
|
|
||||||
flash()->success('Operation completed!', [
|
|
||||||
'theme' => 'amazon' // Amazon-inspired theme
|
|
||||||
]);
|
|
||||||
|
|
||||||
// Other available themes:
|
|
||||||
// - amber: Warm amber styling
|
|
||||||
// - aurora: Subtle gradient effects
|
|
||||||
// - crystal: Clean, transparent design
|
|
||||||
// - emerald: Green-focused modern look
|
|
||||||
// - facebook: Facebook notification style
|
|
||||||
// - google: Google Material Design inspired
|
|
||||||
// - ios: iOS notification style
|
|
||||||
// - jade: Soft jade color palette
|
|
||||||
// - material: Material Design implementation
|
|
||||||
// - minimal: Extremely clean and simple
|
|
||||||
// - neon: Bright, attention-grabbing
|
|
||||||
// - onyx: Dark mode sleek design
|
|
||||||
// - ruby: Bold ruby red accents
|
|
||||||
// - sapphire: Blue-focused elegant style
|
|
||||||
// - slack: Slack-inspired notifications
|
|
||||||
```
|
|
||||||
|
|
||||||
### Theme Configuration
|
|
||||||
|
|
||||||
You can configure theme defaults in your configuration file:
|
|
||||||
|
|
||||||
```php
|
|
||||||
// Laravel: config/flasher.php
|
|
||||||
return [
|
return [
|
||||||
'themes' => [
|
|
||||||
'flasher' => [
|
|
||||||
'options' => [
|
|
||||||
'timeout' => 5000,
|
|
||||||
'position' => 'top-right',
|
|
||||||
],
|
|
||||||
],
|
|
||||||
'amazon' => [
|
|
||||||
'options' => [
|
|
||||||
'timeout' => 3000,
|
|
||||||
'position' => 'bottom-right',
|
|
||||||
],
|
|
||||||
],
|
|
||||||
],
|
|
||||||
];
|
|
||||||
```
|
|
||||||
|
|
||||||
## 🧩 Adapters
|
|
||||||
|
|
||||||
Beyond PHPFlasher's built-in themes, you can use third-party notification libraries:
|
|
||||||
|
|
||||||
### Available Adapters
|
|
||||||
|
|
||||||
#### Toastr
|
|
||||||
|
|
||||||
```bash
|
|
||||||
composer require php-flasher/flasher-toastr-laravel # For Laravel
|
|
||||||
composer require php-flasher/flasher-toastr-symfony # For Symfony
|
|
||||||
```
|
|
||||||
|
|
||||||
```php
|
|
||||||
flash('toastr')->success('Message with Toastr!');
|
|
||||||
```
|
|
||||||
|
|
||||||
#### SweetAlert
|
|
||||||
|
|
||||||
```bash
|
|
||||||
composer require php-flasher/flasher-sweetalert-laravel # For Laravel
|
|
||||||
composer require php-flasher/flasher-sweetalert-symfony # For Symfony
|
|
||||||
```
|
|
||||||
|
|
||||||
```php
|
|
||||||
flash('sweetalert')->success('Message with SweetAlert!');
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Noty
|
|
||||||
|
|
||||||
```bash
|
|
||||||
composer require php-flasher/flasher-noty-laravel # For Laravel
|
|
||||||
composer require php-flasher/flasher-noty-symfony # For Symfony
|
|
||||||
```
|
|
||||||
|
|
||||||
```php
|
|
||||||
flash('noty')->success('Message with Noty!');
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Notyf
|
|
||||||
|
|
||||||
```bash
|
|
||||||
composer require php-flasher/flasher-notyf-laravel # For Laravel
|
|
||||||
composer require php-flasher/flasher-notyf-symfony # For Symfony
|
|
||||||
```
|
|
||||||
|
|
||||||
```php
|
|
||||||
flash('notyf')->success('Message with Notyf!');
|
|
||||||
```
|
|
||||||
|
|
||||||
## ⚙️ Advanced Configuration
|
|
||||||
|
|
||||||
### Laravel Configuration
|
|
||||||
|
|
||||||
Publish and customize the configuration:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
php artisan vendor:publish --tag=flasher-config
|
|
||||||
```
|
|
||||||
|
|
||||||
This creates `config/flasher.php` where you can configure:
|
|
||||||
|
|
||||||
```php
|
|
||||||
return [
|
|
||||||
// Default adapter to use
|
|
||||||
'default' => 'flasher',
|
'default' => 'flasher',
|
||||||
|
|
||||||
// Theme configuration
|
|
||||||
'themes' => [
|
'themes' => [
|
||||||
'flasher' => [
|
'flasher' => [
|
||||||
'options' => [
|
'options' => [
|
||||||
@@ -329,257 +246,87 @@ return [
|
|||||||
],
|
],
|
||||||
],
|
],
|
||||||
],
|
],
|
||||||
|
|
||||||
// Auto-convert Laravel session flash messages
|
|
||||||
'auto_create_from_session' => true,
|
|
||||||
|
|
||||||
// Automatically render notifications
|
|
||||||
'auto_render' => true,
|
|
||||||
|
|
||||||
// Type mappings for Laravel notifications
|
|
||||||
'types_mapping' => [
|
|
||||||
'success' => 'success',
|
|
||||||
'error' => 'error',
|
|
||||||
'warning' => 'warning',
|
|
||||||
'info' => 'info',
|
|
||||||
],
|
|
||||||
];
|
];
|
||||||
```
|
```
|
||||||
|
|
||||||
### Symfony Configuration
|
### Symfony
|
||||||
|
|
||||||
Create or edit `config/packages/flasher.yaml`:
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
# config/packages/flasher.yaml
|
||||||
flasher:
|
flasher:
|
||||||
default: flasher
|
default: flasher
|
||||||
|
|
||||||
themes:
|
themes:
|
||||||
flasher:
|
flasher:
|
||||||
options:
|
options:
|
||||||
timeout: 5000
|
timeout: 5000
|
||||||
position: top-right
|
position: top-right
|
||||||
|
|
||||||
auto_create_from_session: true
|
|
||||||
auto_render: true
|
|
||||||
|
|
||||||
types_mapping:
|
|
||||||
success: success
|
|
||||||
error: error
|
|
||||||
warning: warning
|
|
||||||
info: info
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Notification Options
|
### Common Options
|
||||||
|
|
||||||
Common options you can customize:
|
| Option | Type | Default | Description |
|
||||||
|
|--------|------|---------|-------------|
|
||||||
|
| `timeout` | int | `5000` | Auto-dismiss delay in ms (0 = sticky) |
|
||||||
|
| `position` | string | `top-right` | `top-right`, `top-left`, `bottom-right`, `bottom-left`, `top-center`, `bottom-center` |
|
||||||
|
| `closeButton` | bool | `true` | Show close button |
|
||||||
|
| `progressBar` | bool | `true` | Show timeout progress bar |
|
||||||
|
| `rtl` | bool | `false` | Right-to-left text direction |
|
||||||
|
| `escapeHtml` | bool | `true` | Escape HTML in messages |
|
||||||
|
|
||||||
```php
|
---
|
||||||
flash()->success('Message', [
|
|
||||||
// Display duration in milliseconds (0 = until dismissed)
|
|
||||||
'timeout' => 5000,
|
|
||||||
|
|
||||||
// Notification position
|
|
||||||
'position' => 'top-right', // top-right, top-left, bottom-right, bottom-left, top-center, bottom-center
|
|
||||||
|
|
||||||
// Display a close button
|
|
||||||
'closeButton' => true,
|
|
||||||
|
|
||||||
// Show progress bar during timeout
|
|
||||||
'progressBar' => true,
|
|
||||||
|
|
||||||
// Right-to-left text direction
|
|
||||||
'rtl' => false,
|
|
||||||
|
|
||||||
// Allow HTML content in notifications
|
|
||||||
'escapeHtml' => false,
|
|
||||||
|
|
||||||
// Custom CSS class
|
|
||||||
'class' => 'my-custom-notification',
|
|
||||||
]);
|
|
||||||
```
|
|
||||||
|
|
||||||
## 📘 Adapter Documentation Example
|
## Requirements
|
||||||
|
|
||||||
Here's a detailed example of using the Toastr adapter with PHPFlasher:
|
| Requirement | Version |
|
||||||
|
|-------------|---------|
|
||||||
|
| PHP | >= 8.2 |
|
||||||
|
| Laravel | >= 11.0 |
|
||||||
|
| Symfony | >= 7.0 |
|
||||||
|
|
||||||
### Installation
|
---
|
||||||
|
|
||||||
```bash
|
## Documentation
|
||||||
composer require php-flasher/flasher-toastr
|
|
||||||
```
|
|
||||||
|
|
||||||
For Laravel:
|
For complete documentation, visit **[php-flasher.io](https://php-flasher.io)**
|
||||||
```bash
|
|
||||||
composer require php-flasher/flasher-toastr-laravel
|
|
||||||
```
|
|
||||||
|
|
||||||
For Symfony:
|
- [Installation Guide](https://php-flasher.io/installation)
|
||||||
```bash
|
- [Usage & Examples](https://php-flasher.io/usage)
|
||||||
composer require php-flasher/flasher-toastr-symfony
|
- [Themes Gallery](https://php-flasher.io/themes)
|
||||||
```
|
- [Livewire Integration](https://php-flasher.io/livewire)
|
||||||
|
- [Configuration Reference](https://php-flasher.io/configuration)
|
||||||
|
- [API Reference](https://php-flasher.io/api)
|
||||||
|
|
||||||
### Usage
|
---
|
||||||
|
|
||||||
#### Basic Usage
|
## Contributing
|
||||||
|
|
||||||
```php
|
Contributions are welcome! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
|
||||||
use Flasher\Toastr\Prime\ToastrFactory;
|
|
||||||
|
|
||||||
// Inject the factory
|
## Contributors
|
||||||
public function __construct(private ToastrFactory $toastr)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
public function index()
|
<a href="https://github.com/php-flasher/php-flasher/graphs/contributors">
|
||||||
{
|
<img src="https://contrib.rocks/image?repo=php-flasher/php-flasher" alt="Contributors" />
|
||||||
$this->toastr->success('Toastr is working!');
|
</a>
|
||||||
|
|
||||||
// Or using the global helper with the specified adapter
|
|
||||||
flash('toastr')->success('Toastr is awesome!');
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### With Options
|
---
|
||||||
|
|
||||||
```php
|
## Support the Project
|
||||||
flash('toastr')->success('Success message', 'Success Title', [
|
|
||||||
'timeOut' => 5000,
|
|
||||||
'closeButton' => true,
|
|
||||||
'newestOnTop' => true,
|
|
||||||
'progressBar' => true,
|
|
||||||
'positionClass' => 'toast-top-right',
|
|
||||||
]);
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Available Methods
|
If PHPFlasher helps you build better applications, please consider:
|
||||||
|
|
||||||
```php
|
- **[Star this repository](https://github.com/php-flasher/php-flasher)** to show your support
|
||||||
// Standard notification types
|
- **[Report bugs](https://github.com/php-flasher/php-flasher/issues)** to help improve the library
|
||||||
flash('toastr')->success('Success message');
|
- **[Share on Twitter](https://twitter.com/intent/tweet?text=Check%20out%20PHPFlasher%20-%20beautiful%20flash%20notifications%20for%20PHP!&url=https://github.com/php-flasher/php-flasher)** to spread the word
|
||||||
flash('toastr')->info('Information message');
|
|
||||||
flash('toastr')->warning('Warning message');
|
|
||||||
flash('toastr')->error('Error message');
|
|
||||||
|
|
||||||
// Custom notification
|
---
|
||||||
flash('toastr')->flash('custom-type', 'Custom message');
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Toastr Specific Options
|
## License
|
||||||
|
|
||||||
| Option | Type | Default | Description |
|
PHPFlasher is open-source software licensed under the [MIT license](LICENSE).
|
||||||
|------------------|---------|----------------|--------------------------------------------|
|
|
||||||
| closeButton | Boolean | false | Display a close button |
|
|
||||||
| closeClass | String | 'toast-close-button' | CSS class for close button |
|
|
||||||
| newestOnTop | Boolean | true | Add notifications to the top of the stack |
|
|
||||||
| progressBar | Boolean | true | Display progress bar |
|
|
||||||
| positionClass | String | 'toast-top-right' | Position of the notification |
|
|
||||||
| preventDuplicates | Boolean | false | Prevent duplicates |
|
|
||||||
| showDuration | Number | 300 | Show animation duration in ms |
|
|
||||||
| hideDuration | Number | 1000 | Hide animation duration in ms |
|
|
||||||
| timeOut | Number | 5000 | Auto-close duration (0 = disable) |
|
|
||||||
| extendedTimeOut | Number | 1000 | Duration after hover |
|
|
||||||
| showEasing | String | 'swing' | Show animation easing |
|
|
||||||
| hideEasing | String | 'linear' | Hide animation easing |
|
|
||||||
| showMethod | String | 'fadeIn' | Show animation method |
|
|
||||||
| hideMethod | String | 'fadeOut' | Hide animation method |
|
|
||||||
|
|
||||||
### Advanced Configuration
|
|
||||||
|
|
||||||
#### Laravel Configuration
|
|
||||||
|
|
||||||
Publish the configuration file:
|
|
||||||
```bash
|
|
||||||
php artisan vendor:publish --tag=flasher-toastr-config
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Symfony Configuration
|
|
||||||
|
|
||||||
Edit your `config/packages/flasher.yaml`:
|
|
||||||
```yaml
|
|
||||||
flasher:
|
|
||||||
toastr:
|
|
||||||
options:
|
|
||||||
timeOut: 5000
|
|
||||||
progressBar: true
|
|
||||||
```
|
|
||||||
|
|
||||||
## Learn More
|
|
||||||
|
|
||||||
For additional information, see the [PHPFlasher documentation](https://php-flasher.io).
|
|
||||||
|
|
||||||
## 👥 Community & Support
|
|
||||||
|
|
||||||
### Getting Help
|
|
||||||
|
|
||||||
- **Documentation**: Visit [https://php-flasher.io](https://php-flasher.io)
|
|
||||||
- **GitHub Issues**: [Report bugs or request features](https://github.com/php-flasher/php-flasher/issues)
|
|
||||||
- **Stack Overflow**: Ask questions with the `php-flasher` tag
|
|
||||||
|
|
||||||
### Common Use Cases
|
|
||||||
|
|
||||||
- Form submission feedback
|
|
||||||
- AJAX request notifications
|
|
||||||
- Authentication messages
|
|
||||||
- Error reporting
|
|
||||||
- Success confirmations
|
|
||||||
- System alerts
|
|
||||||
|
|
||||||
## 🌟 Contributors and Sponsors
|
|
||||||
|
|
||||||
Join our team of contributors and make a lasting impact on our project!
|
|
||||||
|
|
||||||
We are always looking for passionate individuals who want to contribute their skills and ideas.
|
|
||||||
Whether you're a developer, designer, or simply have a great idea, we welcome your participation and collaboration.
|
|
||||||
|
|
||||||
Shining stars of our community:
|
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-LIST:START -->
|
|
||||||
<!-- prettier-ignore-start -->
|
|
||||||
<!-- markdownlint-disable -->
|
|
||||||
<table>
|
|
||||||
<tbody>
|
|
||||||
<tr>
|
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/younes--ennaji/"><img src="https://avatars.githubusercontent.com/u/10859693?v=4?s=100" width="100px;" alt="Younes ENNAJI"/><br /><sub><b>Younes ENNAJI</b></sub></a><br /><a href="https://github.com/php-flasher/php-flasher/commits?author=yoeunes" title="Code">💻</a> <a href="https://github.com/php-flasher/php-flasher/commits?author=yoeunes" title="Documentation">📖</a> <a href="#maintenance-yoeunes" title="Maintenance">🚧</a></td>
|
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/salmayno"><img src="https://avatars.githubusercontent.com/u/27933199?v=4?s=100" width="100px;" alt="Salma Mourad"/><br /><sub><b>Salma Mourad</b></sub></a><br /><a href="#financial-salmayno" title="Financial">💵</a></td>
|
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://www.youtube.com/rstacode"><img src="https://avatars.githubusercontent.com/u/35005761?v=4?s=100" width="100px;" alt="Nashwan Abdullah"/><br /><sub><b>Nashwan Abdullah</b></sub></a><br /><a href="#financial-codenashwan" title="Financial">💵</a></td>
|
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://darvis.nl/"><img src="https://avatars.githubusercontent.com/u/7394837?v=4?s=100" width="100px;" alt="Arvid de Jong"/><br /><sub><b>Arvid de Jong</b></sub></a><br /><a href="#financial-darviscommerce" title="Financial">💵</a></td>
|
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://ashallendesign.co.uk/"><img src="https://avatars.githubusercontent.com/u/39652331?v=4?s=100" width="100px;" alt="Ash Allen"/><br /><sub><b>Ash Allen</b></sub></a><br /><a href="#design-ash-jc-allen" title="Design">🎨</a></td>
|
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://about.me/murrant"><img src="https://avatars.githubusercontent.com/u/39462?v=4?s=100" width="100px;" alt="Tony Murray"/><br /><sub><b>Tony Murray</b></sub></a><br /><a href="https://github.com/php-flasher/php-flasher/commits?author=murrant" title="Code">💻</a></td>
|
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/n3wborn"><img src="https://avatars.githubusercontent.com/u/10246722?v=4?s=100" width="100px;" alt="Stéphane P"/><br /><sub><b>Stéphane P</b></sub></a><br /><a href="https://github.com/php-flasher/php-flasher/commits?author=n3wborn" title="Documentation">📖</a></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://www.instagram.com/lucas.maciel_z"><img src="https://avatars.githubusercontent.com/u/80225404?v=4?s=100" width="100px;" alt="Lucas Maciel"/><br /><sub><b>Lucas Maciel</b></sub></a><br /><a href="#design-LucasStorm" title="Design">🎨</a></td>
|
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/AhmedGamal"><img src="https://avatars.githubusercontent.com/u/11786167?v=4?s=100" width="100px;" alt="Ahmed Gamal"/><br /><sub><b>Ahmed Gamal</b></sub></a><br /><a href="https://github.com/php-flasher/php-flasher/commits?author=AhmedGamal" title="Code">💻</a> <a href="https://github.com/php-flasher/php-flasher/commits?author=AhmedGamal" title="Documentation">📖</a></td>
|
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/BrookeDot"><img src="https://avatars.githubusercontent.com/u/150348?v=4?s=100" width="100px;" alt="Brooke."/><br /><sub><b>Brooke.</b></sub></a><br /><a href="https://github.com/php-flasher/php-flasher/commits?author=BrookeDot" title="Documentation">📖</a></td>
|
|
||||||
</tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<!-- markdownlint-restore -->
|
|
||||||
<!-- prettier-ignore-end -->
|
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
||||||
|
|
||||||
## 📬 Contact
|
|
||||||
|
|
||||||
PHPFlasher is being actively developed by <a href="https://github.com/yoeunes">yoeunes</a>.
|
|
||||||
You can reach out with questions, bug reports, or feature requests on any of the following:
|
|
||||||
|
|
||||||
- [Github Issues](https://github.com/php-flasher/php-flasher/issues)
|
|
||||||
- [Github](https://github.com/yoeunes)
|
|
||||||
- [Twitter](https://twitter.com/yoeunes)
|
|
||||||
- [Linkedin](https://www.linkedin.com/in/younes--ennaji/)
|
|
||||||
- [Email me directly](mailto:younes.ennaji.pro@gmail.com)
|
|
||||||
|
|
||||||
## 📝 License
|
|
||||||
|
|
||||||
PHPFlasher is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
|
||||||
|
|
||||||
<p align="center"> <b>Made with ❤️ by <a href="https://www.linkedin.com/in/younes--ennaji/">Younes ENNAJI</a> </b> </p>
|
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://github.com/php-flasher/php-flasher/stargazers">
|
<br>
|
||||||
⭐ Star if you found this useful ⭐
|
<strong>Made with ❤️ by <a href="https://github.com/yoeunes">Younes ENNAJI</a></strong>
|
||||||
</a>
|
<br><br>
|
||||||
|
<a href="https://github.com/php-flasher/php-flasher/stargazers">⭐ Star if you find this useful!</a>
|
||||||
</p>
|
</p>
|
||||||
|
|||||||
Reference in New Issue
Block a user