asmitta-01 / toast-bundle
UX Toast display for your Symfony project.
Package info
github.com/Asmitta-01/toast-bundle
Type:symfony-bundle
pkg:composer/asmitta-01/toast-bundle
Requires
- php: >=8.1
- symfony/config: ^6.0 || ^7.0 || ^8.0
- symfony/dependency-injection: ^6.0 || ^7.0 || ^8.0
- symfony/event-dispatcher: ^6.0 || ^7.0 || ^8.0
- symfony/framework-bundle: ^6.0 || ^7.0 || ^8.0
- symfony/http-foundation: ^6.0 || ^7.0 || ^8.0
- symfony/http-kernel: ^6.0 || ^7.0 || ^8.0
- symfony/options-resolver: ^6.0 || ^7.0 || ^8.0
- symfony/security-core: ^6.0 || ^7.0 || ^8.0
- symfony/translation: ^6.0 || ^7.0 || ^8.0
- symfony/validator: ^6.0 || ^7.0 || ^8.0
- symfony/yaml: ^6.0 || ^7.0 || ^8.0
Requires (Dev)
- phpstan/extension-installer: ^1.1
- phpstan/phpstan: ^1.12
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-strict-rules: ^1.1
- phpstan/phpstan-symfony: ^1.4
- phpunit/phpunit: ^9.5 || ^10.0 || ^11.0
- symfony/browser-kit: ^6.0 || ^7.0 || ^8.0
- symfony/css-selector: ^6.0 || ^7.0 || ^8.0
- symfony/mime: ^6.0 || ^7.0 || ^8.0
- symfony/phpunit-bridge: ^7.0 || ^8.0
- symfony/security-bundle: ^6.0 || ^7.0 || ^8.0
- symfony/twig-bundle: ^6.0 || ^7.0 || ^8.0
README
A Symfony bundle for displaying toast notifications from flash messages, with no Bootstrap CSS or JavaScript dependency.
Installation
Make sure Composer is installed globally, as explained in the installation chapter of the Composer documentation.
Open a command console, enter your project directory and execute:
composer require asmitta-01/toast-bundle
The bundle is compatible with Symfony 6, 7 and 8.
If your application exposes bundle assets through the public directory, install them after requiring the package:
php bin/console assets:install
Configuration
If your application doesn't use Symfony Flex, enable the bundle in config/bundles.php:
return [ // ... Asmitta\ToastBundle\AsmittaToastBundle::class => ['all' => true], ];
Create a configuration file at config/packages/asmitta_toast.yaml, see docs/config.md.
Usage
1. Add flash messages in your controller
use Asmitta\ToastBundle\Enum\ToastType; public function someAction(Request $request): Response { $this->addFlash('success', 'Operation completed successfully!'); // 'success' or ToastType::SUCCESS->value $this->addFlash('warning', 'Please check your input.'); $this->addFlash('error', 'Something went wrong.'); $this->addFlash('info', 'Here is some information.'); return $this->render('your_template.html.twig'); }
2. Include the bundle CSS assets in your template
<link href="{{ asset('bundles/asmittaToast/css/toast.css') }}" rel="stylesheet"> <link href="{{ asset('bundles/asmittaToast/css/spacing.css') }}" rel="stylesheet">
If you use the progress bar option, also include:
<link href="{{ asset('bundles/asmittaToast/css/toast-progress-bar.css') }}" rel="stylesheet">
The bundle ships its own toast behavior, so no Bootstrap JavaScript include is required.
If you use the with_icon or colored_icon templates, include Bootstrap Icons in your page:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css">
3. Add the toast function to your template
{{ render_toasts() }}
Toast Types
The bundle supports these flash message types:
success→ Green toastwarning→ Yellow toasterrorordanger→ Red toastinfo(default) → Light Blue toast
Features
- Automatic mapping of flash message types to toast variants
- Configurable auto-hide timer (default: 5 seconds)
- Flexible positioning (7 positions available, see ToastPosition Enum)
- Limit maximum toasts per type
- Optional progress bar showing remaining time
- Dismissible toasts with close button
- Responsive design
- Twig template-based rendering
- Full configuration support
- No Bootstrap CSS or JavaScript dependency
- Symfony 6, 7 and 8 compatibility
Breaking Changes In 0.4.0
- The root toast class changed from
toasttoasmitta-toast - Bootstrap toast classes and utility classes were replaced by
asmitta-prefixed classes - Bootstrap JavaScript is no longer used or required for rendering toasts