diff --git a/docs/pages/laravel.md b/docs/pages/laravel.md index 828c5770..58046781 100644 --- a/docs/pages/laravel.md +++ b/docs/pages/laravel.md @@ -8,9 +8,9 @@ framework: laravel ## Requirements -PHPFlasher offers a seamless way to incorporate flash notifications in Laravel projects, enhancing user feedback with minimal setup. +**PHPFlasher** helps you easily add flash notifications to your ** Laravel** projects, improving user feedback with minimal setup. -Requirements for using PHPFlasher with Laravel: +To use **PHPFlasher** with Laravel, you need: > **PHP** v8.2 or higher > **Laravel** v11.0 or higher @@ -19,13 +19,15 @@ Requirements for using PHP Installation -PHPFlasher's modular design lets you select and install only the components your project needs. +**PHPFlasher** is modular, so you can install only the parts you need. + +Run this command to install it: ```shell composer require php-flasher/flasher-laravel ``` -After installation, you need to run another command to set up the necessary assets for PHPFlasher: +After installing, run this command to set up the required assets: ```shell php artisan flasher:install @@ -39,13 +41,13 @@ php artisan flasher:install ## Configuration -As optional, if you want to modify the default configuration, you can publish the configuration file: +If you want to change the default settings, you can publish the configuration file: ```bash php artisan flasher:install --config ``` -The configuration file will be located at `config/flasher.php` and will have the following content: +This will create a file at `config/flasher.php` with the following content: ```php [ 'timeout' => 5000, // in milliseconds 'position' => 'top-right', + 'escapeHtml' => false, ], // Configuration for the flash bag (converting Laravel flash messages) @@ -94,11 +97,11 @@ return [ ## Presets -You can create a preset for a custom notification that you want to reuse in multiple places by adding a presets entry in the configuration file. +You can create a preset for a custom notification that you want to reuse in multiple places by adding a `presets` entry in the configuration file. -> You can think of a preset as a pre-defined message that you can use in multiple locations.
+> A preset is like a pre-defined message you can use in many places. -For example, you can create a preset named `entity_saved` in the configuration file and then use +For example, create a preset named `entity_saved`: {% assign id = '#/ laravel preset' %} {% assign type = 'success' %} @@ -121,7 +124,7 @@ return [ ]; ``` -To use the preset, you can call the `preset()` method and pass the name of the preset as the first argument: +To use the preset, call the `preset()` method and pass the name of the preset: ```php {{ id }} @@ -145,7 +148,7 @@ class BookController

Variables

-Presets can also contain variables that can be substituted by using the translation system. Take the following example where you have a preset showing a personalised welcome message to the user. +Presets can also have variables that you can replace using the translation system. For example, you can have a preset that shows a personalized welcome message. ```php RTL support -PHPFlasher makes it easy to incorporate **right-to-left** languages like `Arabic` or `Hebrew`. -it automatically detects the text direction and handles the necessary adjustments for you. +PHPFlasher makes it easy to use **right-to-left** languages like `Arabic` or `Hebrew`. It automatically detects the text direction and adjusts accordingly. -Simply make sure the translation service is enabled and let PHPFlasher handle the rest. +Just make sure the translation service is enabled, and PHPFlasher will handle the rest. {% assign id = '#/ phpflasher rtl' %} {% assign type = 'success' %} @@ -210,14 +212,13 @@ flash() ## Translation -PHPFlasher allows you to translate your notification `messages` and `presets`, it comes with `Arabic`, `English`, `French`, `German`, `Spanish`, `Portuguese`, `Russian`, and `Chinese` translations out of the box. but you can easily add your own translations. +PHPFlasher lets you translate your notification `messages` and `presets`. It comes with translations for `Arabic`, `English`, `French`, `German`, `Spanish`, `Portuguese`, `Russian`, and `Chinese`. You can also add your own translations. -For example, to override the `English` translation strings for PHPFlasher, you can create a language file at the following location: -**`/resources/lang/vendor/flasher/en/messages.php`**. +To override the `English` translations for PHPFlasher, create a file at `/resources/lang/vendor/flasher/en/messages.php`. -In this file, you should **only** define the translation strings you want to override. Any translation strings that you don't override will still be loaded from PHPFlasher's original language files. +In this file, define only the translation strings you want to change. Any strings you don't override will use PHPFlasher's default translations. -Here are examples of the default translation keys for `Arabic`, `English`, and `French` in PHPFlasher: +Here are examples of the default translation keys for `Arabic`, `English`, and `French`: ```php These translation files facilitate localizing notifications to match user preferences and ensure that your applications can communicate effectively across different linguistic contexts. +> These translation files help you localize notifications to match user preferences, so your application can communicate effectively in different languages. {% assign id = '#/ laravel arabic translations' %} {% assign successMessage = 'تم إنشاء الملف' %} @@ -282,33 +283,33 @@ return [ {% assign infoMessage = 'سيتم تحديث هذه الصفحة في غضون 10 دقائق.' %}