Skip to content

Commit 77c77b1

Browse files
author
KHOUBZA Younes
committed
add symfony doc
1 parent 2a25986 commit 77c77b1

File tree

19 files changed

+631
-218
lines changed

19 files changed

+631
-218
lines changed

‎_data/entrypoints.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"/dist/homepage.11d1d76a.js"
77
],
88
"css": [
9-
"/dist/857.6650c424.css",
9+
"/dist/857.ca534bf8.css",
1010
"/dist/homepage.daa70971.css"
1111
]
1212
},
@@ -16,10 +16,10 @@
1616
"/dist/245.f9644c9e.js",
1717
"/dist/383.82e9b159.js",
1818
"/dist/814.47265ca3.js",
19-
"/dist/main.774bb773.js"
19+
"/dist/main.94d8f03a.js"
2020
],
2121
"css": [
22-
"/dist/857.6650c424.css",
22+
"/dist/857.ca534bf8.css",
2323
"/dist/main.35f80290.css"
2424
]
2525
},

‎_data/manifest.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"dist/homepage.css": "/dist/homepage.daa70971.css",
33
"dist/homepage.js": "/dist/homepage.11d1d76a.js",
44
"dist/main.css": "/dist/main.35f80290.css",
5-
"dist/main.js": "/dist/main.774bb773.js",
5+
"dist/main.js": "/dist/main.94d8f03a.js",
66
"dist/adapter-flasher.js": "/dist/adapter-flasher.9e83994a.js",
77
"dist/adapter-noty.js": "/dist/adapter-noty.6ec70878.js",
88
"dist/adapter-notyf.js": "/dist/adapter-notyf.db901ffb.js",
@@ -32,7 +32,7 @@
3232
"dist/383.82e9b159.js": "/dist/383.82e9b159.js",
3333
"dist/814.47265ca3.js": "/dist/814.47265ca3.js",
3434
"dist/874.ec7ba3fe.js": "/dist/874.ec7ba3fe.js",
35-
"dist/857.6650c424.css": "/dist/857.6650c424.css",
35+
"dist/857.ca534bf8.css": "/dist/857.ca534bf8.css",
3636
"dist/fonts/fa-duotone-900.ttf": "/dist/fonts/fa-duotone-900.7aaed888.ttf",
3737
"dist/fonts/fa-thin-100.ttf": "/dist/fonts/fa-thin-100.e979819d.ttf",
3838
"dist/fonts/fa-light-300.ttf": "/dist/fonts/fa-light-300.c92b45dd.ttf",

‎_data/menu.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<i class="fa-duotone fa-rocket"></i> Getting Started:
22
<i class="fa-duotone fa-book text-indigo-900 mr-1 fa-lg"></i> Introduction: '/'
33
# <i class="fa-duotone fa-download text-indigo-900 mr-1 fa-lg"></i> Installation: '/installation/'
4-
# <i class="fa-brands fa-symfony fa-lg text-black mr-1"></i> Symfony: '/symfony/'
4+
<i class="fa-brands fa-symfony fa-lg text-black mr-1"></i> Symfony: '/symfony/'
55
<i class="fa-brands fa-laravel fa-lg text-red-900 mr-1"></i> Laravel: '/laravel/'
66
<i class="fa-duotone fa-ghost fa-lg text-pink-800 mr-1"></i> Livewire: '/livewire/'
77
<i class="fa-duotone fa-angles-right fa-lg text-indigo-900 mr-1"></i> Inertia: '/inertia/'

‎_includes/_installation.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ composer require php-flasher/flasher-symfony
2626

2727
**<span class="text-indigo-900">PHP<span class="text-indigo-500">Flasher</span></span>** includes a default notification style <i class="fa-duotone fa-comment-captions text-yellow-600"></i>, but users can also install additional adapters to customize the appearance of notifications within their projects such as :
2828

29-
* **[Toastr](/docs/adapter/toastr/)**
30-
* **[Noty](/docs/adapter/noty/)**
31-
* **[Notyf](/docs/adapter/notyf/)**
32-
* **[Sweet Alert](/docs/adapter/sweetalert/)**
33-
* **[Pnotify](/docs/adapter/pnotify/)**
29+
* **[Toastr](/library/toastr/)**
30+
* **[Noty](/library/noty/)**
31+
* **[Notyf](/library/notyf/)**
32+
* **[Sweet Alert](/library/sweetalert/)**
33+
* **[Pnotify](/library/pnotify/)**
3434

3535
---
3636

‎_includes/_usage.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
To display a notification message, you can either use the `flash()` helper method or obtain an instance of `flasher` from the service container.
44
Then, before returning a view or redirecting, call the `addSuccess()` method and pass in the desired message to be displayed.
55

6-
{% assign id = '# PHPFlasher' %}
6+
{% assign id = '#/ PHPFlasher' %}
77
{% assign type = 'success' %}
88
{% assign message = site.data.messages[type] | sample %}
99
{% assign options = '{}' %}
@@ -53,7 +53,7 @@ but you may want to tailor it to fit the specific context and language of your a
5353

5454
> Using this package is actually pretty easy. Adding notifications to your application actually require only one line of code.
5555
56-
{% assign id = '# usage addSuccess' %}
56+
{% assign id = '#/ usage addSuccess' %}
5757
{% assign type = 'success' %}
5858
{% assign message = site.data.messages[type] | sample %}
5959
{% assign options = '{}' %}
@@ -65,7 +65,7 @@ but you may want to tailor it to fit the specific context and language of your a
6565
flash()->add{{ type | capitalize }}('{{ message }}');
6666
```
6767

68-
{% assign id = '# usage addError' %}
68+
{% assign id = '#/ usage addError' %}
6969
{% assign type = 'error' %}
7070
{% assign message = site.data.messages[type] | sample %}
7171
{% assign options = '{}' %}
@@ -77,7 +77,7 @@ flash()->add{{ type | capitalize }}('{{ message }}');
7777
flash()->add{{ type | capitalize }}('{{ message }}');
7878
```
7979

80-
{% assign id = '# usage addWarning' %}
80+
{% assign id = '#/ usage addWarning' %}
8181
{% assign type = 'warning' %}
8282
{% assign message = site.data.messages[type] | sample %}
8383
{% assign options = '{}' %}
@@ -89,7 +89,7 @@ flash()->add{{ type | capitalize }}('{{ message }}');
8989
flash()->add{{ type | capitalize }}('{{ message }}');
9090
```
9191

92-
{% assign id = '# usage addInfo' %}
92+
{% assign id = '#/ usage addInfo' %}
9393
{% assign type = 'info' %}
9494
{% assign message = site.data.messages[type] | sample %}
9595
{% assign options = '{}' %}
@@ -103,14 +103,14 @@ flash()->add{{ type | capitalize }}('{{ message }}');
103103

104104
---
105105

106-
These four methods (`addSuccess`, `addError`, `addWarning`, `addInfo`) are simply convenience shortcuts for the `addFlash` method,
107-
allowing you to specify the `type` and `message` in a single method call rather than having to pass both as separate arguments to the `addFlash` method.
106+
These four methods `addSuccess()`, `addError()`, `addWarning()`, `addInfo()` are simply convenience shortcuts for the `addFlash()` method,
107+
allowing you to specify the `type` and `message` in a single method call rather than having to pass both as separate arguments to the `addFlash()` method.
108108

109109
```php
110110
flash()->addFlash(string $type, string $message, string $title = null, array $options = [])
111111
```
112112

113-
{% assign id = '# usage addFlash' %}
113+
{% assign id = '#/ usage addFlash' %}
114114
{% assign type = site.data.messages.types | sample %}
115115
{% assign message = site.data.messages[type] | sample %}
116116
{% assign options = '{}' %}
@@ -148,7 +148,7 @@ flash()->options(array $options, bool $merge = true);
148148

149149
> Refer to the documentation for your chosen JavaScript library to see which options are available and how they should be formatted.
150150
151-
{% assign id = '# usage options' %}
151+
{% assign id = '#/ usage options' %}
152152
{% assign type = site.data.messages.types | sample %}
153153
{% assign message = site.data.messages[type] | sample %}
154154
{% assign options = '{"timeout": 3000, "position": "top-center"}' %}
@@ -180,7 +180,7 @@ Set a single option by specifying its name and value as separate arguments.
180180
flash()->option(string $option, mixed $value);
181181
```
182182

183-
{% assign id = '# usage option' %}
183+
{% assign id = '#/ usage option' %}
184184
{% assign type = site.data.messages.types | sample %}
185185
{% assign message = site.data.messages[type] | sample %}
186186
{% assign options = '{"timeout": 3000, "position": "top-center"}' %}
@@ -210,7 +210,7 @@ Sets the priority of a flash message, the highest priority will be displayed fir
210210
flash()->priority(int $priority);
211211
```
212212

213-
{% assign id = '# usage priority' %}
213+
{% assign id = '#/ usage priority' %}
214214
{% assign successMessage = site.data.messages['success'] | sample | prepend: 'Priority 3 → ' %}
215215
{% assign errorMessage = site.data.messages['error'] | sample | prepend: 'Priority 1 → ' %}
216216
{% assign warningMessage = site.data.messages['warning'] | sample | prepend: 'Priority 4 → ' %}
@@ -277,7 +277,7 @@ This method sets the number of requests that the flash message should persist fo
277277

278278
As an example, with a multi-page form, you may want to store messages until all pages have been filled.
279279

280-
{% assign id = '# usage hops' %}
280+
{% assign id = '#/ usage hops' %}
281281
{% assign type = site.data.messages.types | sample %}
282282
{% assign message = site.data.messages[type] | sample %}
283283
{% assign options = '{}' %}
@@ -308,7 +308,7 @@ the flash message will be translated into the specified language. If null is pro
308308
flash()->translate(string $locale = null);
309309
```
310310

311-
{% assign id = '# usage translate' %}
311+
{% assign id = '#/ usage translate' %}
312312
{% assign type = 'success' %}
313313
{% assign message = 'تمت العملية بنجاح.' %}
314314
{% assign title = 'تهانينا' %}
@@ -323,7 +323,7 @@ flash()
323323
->add{{ type | capitalize }}('Your request was processed successfully.', 'Congratulations!');
324324
```
325325

326-
{% assign id = '# usage translate with position' %}
326+
{% assign id = '#/ usage translate with position' %}
327327
{% assign type = 'success' %}
328328
{% assign message = 'تمت العملية بنجاح.' %}
329329
{% assign title = 'تهانينا' %}

‎assets/js/_tryit.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ const codeBlocks = document.querySelectorAll("pre > code");
3232

3333
codeBlocks.forEach(function (codeBlock) {
3434
const code = codeBlock.innerText.trim();
35-
if (!code.startsWith("#")) {
35+
if (!code.startsWith("#/")) {
3636
return;
3737
}
3838

‎dist/857.6650c424.css‎ renamed to ‎dist/857.ca534bf8.css‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/main.774bb773.js‎ renamed to ‎dist/main.94d8f03a.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/concepts/usage.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: Usage
77

88
Using this package is actually pretty easy. Adding notifications to your application actually require only one line of code.
99

10-
{% assign id = '# usage addSuccess' %}
10+
{% assign id = '#/ usage addSuccess' %}
1111
{% assign type = 'success' %}
1212
{% assign message = site.data.messages[type] | sample %}
1313
{% assign options = '{}' %}
@@ -19,7 +19,7 @@ Using this package is actually pretty easy. Adding notifications to your applica
1919
flash()->add{{ type | capitalize }}('{{ message }}');
2020
```
2121

22-
{% assign id = '# usage addError' %}
22+
{% assign id = '#/ usage addError' %}
2323
{% assign type = 'error' %}
2424
{% assign message = site.data.messages[type] | sample %}
2525
{% assign options = '{}' %}
@@ -31,7 +31,7 @@ flash()->add{{ type | capitalize }}('{{ message }}');
3131
flash()->add{{ type | capitalize }}('{{ message }}');
3232
```
3333

34-
{% assign id = '# usage addWarning' %}
34+
{% assign id = '#/ usage addWarning' %}
3535
{% assign type = 'warning' %}
3636
{% assign message = site.data.messages[type] | sample %}
3737
{% assign options = '{}' %}
@@ -43,7 +43,7 @@ flash()->add{{ type | capitalize }}('{{ message }}');
4343
flash()->add{{ type | capitalize }}('{{ message }}');
4444
```
4545

46-
{% assign id = '# usage addInfo' %}
46+
{% assign id = '#/ usage addInfo' %}
4747
{% assign type = 'info' %}
4848
{% assign message = site.data.messages[type] | sample %}
4949
{% assign options = '{}' %}
@@ -64,7 +64,7 @@ allowing you to specify the `type` and `message` in a single method call rather
6464
flash()->addFlash(string $type, string $message, string $title = null, array $options = [])
6565
```
6666

67-
{% assign id = '# usage addFlash' %}
67+
{% assign id = '#/ usage addFlash' %}
6868
{% assign type = site.data.messages.types | sample %}
6969
{% assign message = site.data.messages[type] | sample %}
7070
{% assign options = '{}' %}
@@ -102,7 +102,7 @@ flash()->options(array $options, bool $merge = true);
102102

103103
> Refer to the documentation for your chosen JavaScript library to see which options are available and how they should be formatted.
104104
105-
{% assign id = '# usage options' %}
105+
{% assign id = '#/ usage options' %}
106106
{% assign type = site.data.messages.types | sample %}
107107
{% assign message = site.data.messages[type] | sample %}
108108
{% assign options = '{"timeout": 3000, "position": "top-center"}' %}
@@ -134,7 +134,7 @@ Set a single option by specifying its name and value as separate arguments.
134134
flash()->option(string $option, mixed $value);
135135
```
136136

137-
{% assign id = '# usage option' %}
137+
{% assign id = '#/ usage option' %}
138138
{% assign type = site.data.messages.types | sample %}
139139
{% assign message = site.data.messages[type] | sample %}
140140
{% assign options = '{"timeout": 3000, "position": "top-center"}' %}
@@ -162,7 +162,7 @@ flash()
162162
flash()->priority(int $priority);
163163
```
164164

165-
{% assign id = '# usage priority' %}
165+
{% assign id = '#/ usage priority' %}
166166
{% assign successMessage = site.data.messages['success'] | sample | prepend: 'Priority 3 → ' %}
167167
{% assign errorMessage = site.data.messages['error'] | sample | prepend: 'Priority 1 → ' %}
168168
{% assign warningMessage = site.data.messages['warning'] | sample | prepend: 'Priority 4 → ' %}
@@ -227,7 +227,7 @@ flash()
227227

228228
Sometimes you may want a flash message to persist for longer than a single request. As an example, with a multi-page form, you may want to store messages until all pages have been filled.
229229

230-
{% assign id = '# usage hops' %}
230+
{% assign id = '#/ usage hops' %}
231231
{% assign type = site.data.messages.types | sample %}
232232
{% assign message = site.data.messages[type] | sample %}
233233
{% assign options = '{}' %}
@@ -255,7 +255,7 @@ flash()
255255
flash()->keep();
256256
```
257257

258-
{% assign id = '# usage keep' %}
258+
{% assign id = '#/ usage keep' %}
259259
{% assign type = site.data.messages.types | sample %}
260260
{% assign message = site.data.messages[type] | sample %}
261261
{% assign options = '{}' %}
@@ -279,7 +279,7 @@ flash()
279279
flash()->delay(int $delay);
280280
```
281281

282-
{% assign id = '# usage delay' %}
282+
{% assign id = '#/ usage delay' %}
283283
{% assign type = site.data.messages.types | sample %}
284284
{% assign message = site.data.messages[type] | sample %}
285285
{% assign options = '{}' %}
@@ -303,7 +303,7 @@ flash()
303303
flash()->now();
304304
```
305305

306-
{% assign id = '# usage now' %}
306+
{% assign id = '#/ usage now' %}
307307
{% assign type = site.data.messages.types | sample %}
308308
{% assign message = site.data.messages[type] | sample %}
309309
{% assign options = '{}' %}
@@ -327,7 +327,7 @@ flash()
327327
flash()->translate(string $locale = null);
328328
```
329329

330-
{% assign id = '# usage translate' %}
330+
{% assign id = '#/ usage translate' %}
331331
{% assign type = 'success' %}
332332
{% assign message = 'تمت العملية بنجاح.' %}
333333
{% assign title = 'تهانينا' %}
@@ -342,7 +342,7 @@ flash()
342342
->add{{ type | capitalize }}('Your request was processed successfully.', 'Congratulations!');
343343
```
344344

345-
{% assign id = '# usage translate with position' %}
345+
{% assign id = '#/ usage translate with position' %}
346346
{% assign type = 'success' %}
347347
{% assign message = 'تمت العملية بنجاح.' %}
348348
{% assign title = 'تهانينا' %}

‎docs/index.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ Flash notifications serves as a feedback & confirmation mechanism after the user
6161
## <i class="fa-duotone fa-list-radio"></i> Why use **<span class="text-indigo-900">PHP<span class="text-indigo-500">Flasher</span></span>** ?
6262

6363
**<span class="text-indigo-900">PHP<span class="text-indigo-500">Flasher</span></span>** supports popular notification libraries :
64-
<span class="text-indigo-900">[__toastr.js__](/docs/adapter/toastr/)</span>,
65-
<span class="text-indigo-900">[__sweetalert 2__](/docs/adapter/sweetalert/)</span>,
66-
<span class="text-indigo-900">[__pnotify__](/docs/adapter/pnotify/)</span>,
67-
<span class="text-indigo-900">[__noty__](/docs/adapter/noty/)</span>,
68-
<span class="text-indigo-900">[__notyf__](/docs/adapter/notyf/)</span> and even show <span class="text-indigo-900">__desktop__</span> notifications.
64+
<span class="text-indigo-900">[__toastr.js__](/library/toastr/)</span>,
65+
<span class="text-indigo-900">[__sweetalert 2__](/library/sweetalert/)</span>,
66+
<span class="text-indigo-900">[__pnotify__](/library/pnotify/)</span>,
67+
<span class="text-indigo-900">[__noty__](/library/noty/)</span>,
68+
<span class="text-indigo-900">[__notyf__](/library/notyf/)</span> and even show <span class="text-indigo-900">__desktop__</span> notifications.
6969

7070
You have a wide range of options to choose from to suit your specific needs. Whether you want to display simple toast messages or more sophisticated alerts,
7171
**<span class="text-indigo-900">PHP<span class="text-indigo-500">Flasher</span></span>** has you covered.
@@ -87,9 +87,9 @@ Give it a try and see the difference it can make for yourself!
8787

8888
## <i class="fa-duotone fa-list-radio"></i> Getting Started
8989

90-
* **[Installation](/docs/installation/)**
91-
* **[Toastr](/docs/adapter/toastr/)**
92-
* **[Noty](/docs/adapter/noty/)**
93-
* **[Notyf](/docs/adapter/notyf/)**
94-
* **[Sweet Alert](/docs/adapter/sweetalert/)**
95-
* **[Pnotify](/docs/adapter/pnotify/)**
90+
* **[Installation](/installation/)**
91+
* **[Toastr](/library/toastr/)**
92+
* **[Noty](/library/noty/)**
93+
* **[Notyf](/library/notyf/)**
94+
* **[Sweet Alert](/library/sweetalert/)**
95+
* **[Pnotify](/library/pnotify/)**

0 commit comments

Comments
 (0)