Update README and documentation pages

This commit is contained in:
Younes ENNAJI
2026-03-02 02:34:48 +00:00
parent 1f7d884c4d
commit 63b9083782
3 changed files with 11 additions and 8 deletions
+5 -2
View File
@@ -290,15 +290,18 @@ flasher:
For complete documentation, visit **[php-flasher.io](https://php-flasher.io)** For complete documentation, visit **[php-flasher.io](https://php-flasher.io)**
- [Installation Guide](https://php-flasher.io/installation) - [Installation Guide](https://php-flasher.io/installation)
- [Themes Gallery](https://php-flasher.io/themes) - [Laravel Integration](https://php-flasher.io/laravel)
- [Symfony Integration](https://php-flasher.io/symfony)
- [Livewire Integration](https://php-flasher.io/livewire) - [Livewire Integration](https://php-flasher.io/livewire)
- [Inertia.js Integration](https://php-flasher.io/inertia)
- [Themes Gallery](https://php-flasher.io/themes)
- [JavaScript Usage](https://php-flasher.io/javascript) - [JavaScript Usage](https://php-flasher.io/javascript)
--- ---
## Contributing ## Contributing
Contributions are welcome! Please see our [Contributing Guide](CONTRIBUTING.md) for details. Contributions are welcome! Please feel free to submit a [Pull Request](https://github.com/php-flasher/php-flasher/pulls).
## Contributors ## Contributors
+3 -3
View File
@@ -173,10 +173,10 @@ flash()->flash('{{ type }}', '{{ message }}');
| param | description | | param | description |
|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `$type` | Notification type : <span class="text-white bg-green-600 px-2 py-1 rounded">success</span>, <span class="text-white bg-red-600 px-2 py-1 rounded">error</span>, <span class="text-white bg-yellow-600 px-2 py-1 rounded">warning</span>, <span class="text-white bg-blue-600 px-2 py-1 rounded">info</span> ....etc | | `$type` | Notification type : <span class="text-white bg-green-600 px-2 py-1 rounded">success</span>, <span class="text-white bg-red-600 px-2 py-1 rounded">error</span>, <span class="text-white bg-yellow-600 px-2 py-1 rounded">warning</span>, <span class="text-white bg-blue-600 px-2 py-1 rounded">info</span> etc. |
| `$message` | The body of the message you want to deliver to your user. This may contain HTML. If you add links, be sure to add the appropriate classes for the framework you are using. | | `$message` | The body of the message you want to deliver to your user. This may contain HTML. If you add links, be sure to add the appropriate classes for the framework you are using. |
| `$title` | The notification title, Can also include HTML | | `$title` | The notification title, Can also include HTML |
| `$options` | Custom options for javascript libraries (toastr, noty, notyf ...etc) | | | `$options` | Custom options for javascript libraries (toastr, noty, notyf etc.) | |
--- ---
@@ -214,7 +214,7 @@ flash()
| param | description | | param | description |
|------------|--------------------------------------------------------------------------------------| |------------|--------------------------------------------------------------------------------------|
| `$options` | Custom options to be passed to the javascript libraries (toastr, noty, notyf ...etc) | | `$options` | Custom options to be passed to the javascript libraries (toastr, noty, notyf etc.) |
| `$merge` | Merge options if you call the options method multiple times | | `$merge` | Merge options if you call the options method multiple times |
--- ---
+3 -3
View File
@@ -317,7 +317,7 @@ noty()
```php ```php
#/ noty theme relax #/ noty theme relax
// don't the load the theme css file: https://github.com/needim/noty/blob/master/lib/themes/relax.css // don't forget to load the theme css file: https://github.com/needim/noty/blob/master/lib/themes/relax.css
noty() noty()
->theme('relax') ->theme('relax')
@@ -609,8 +609,8 @@ noty()
<p id="method-sounds"><a href="#method-sounds" class="anchor"><i class="fa-duotone fa-link"></i> sounds</a></p> <p id="method-sounds"><a href="#method-sounds" class="anchor"><i class="fa-duotone fa-link"></i> sounds</a></p>
`sources` : Array of audio sources e.g 'some.wav' <br /> `sources` : Array of audio sources e.g. 'some.wav' <br />
`volume` : nteger value between 0-1 e.g 0.5 <br /> `volume` : Integer value between 0-1 e.g. 0.5 <br />
`conditions` : There are two conditions for now: 'docVisible' & 'docHidden'. You can use one of them or both. <br /> `conditions` : There are two conditions for now: 'docVisible' & 'docHidden'. You can use one of them or both. <br />
```php ```php