mirror of
https://github.com/php-flasher/php-flasher.git
synced 2026-03-31 15:07:47 +01:00
chore: v2 full rewrite
This commit is contained in:
@@ -0,0 +1,175 @@
|
||||
---
|
||||
permalink: /library/notyf/
|
||||
title: Notyf
|
||||
description: Add lightweight, customizable notification messages to your web projects with Notyf, a popular JavaScript library. With a focus on simplicity and accessibility, Notyf is easy to install and use, making it a great choice for any project that wants to engage and inform users.
|
||||
handler: notyf
|
||||
data-controller: notyf
|
||||
---
|
||||
|
||||
## <i class="fa-duotone fa-list-radio"></i> Installation
|
||||
|
||||
**<i class="fa-brands fa-laravel text-red-900 fa-xl"></i> Laravel**:
|
||||
|
||||
```shell
|
||||
composer require php-flasher/flasher-notyf-laravel
|
||||
```
|
||||
|
||||
<br />
|
||||
|
||||
**<i class="fa-brands fa-symfony text-black fa-xl"></i> Symfony**:
|
||||
|
||||
```shell
|
||||
composer require php-flasher/flasher-notyf-symfony
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## <i class="fa-duotone fa-list-radio"></i> Usage
|
||||
|
||||
{% assign id = '#/ notyf' %}
|
||||
{% assign type = site.data.messages.types | sample %}
|
||||
{% assign message = site.data.messages[type] | sample %}
|
||||
{% assign options = '{}' %}
|
||||
{% include example.html %}
|
||||
|
||||
```php
|
||||
{{ id }}
|
||||
|
||||
namespace App\Controller;
|
||||
|
||||
class AppController
|
||||
{
|
||||
public function save()
|
||||
{
|
||||
notyf()->{{ type }}('{{ message }}');
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## <i class="fa-duotone fa-list-radio"></i> Modifiers
|
||||
|
||||
For more information on Notyf options and usage, please refer to the original documentation at [https://github.com/caroso1222/notyf](https://github.com/caroso1222/notyf)
|
||||
|
||||
---
|
||||
|
||||
> The methods described in the **[Usage](/installation/#-modifiers)** section can also be used with the `notyf` adapter.
|
||||
|
||||
---
|
||||
|
||||
<p id="method-position"><a href="#method-position" class="anchor"><i class="fa-duotone fa-link"></i> position</a></p>
|
||||
|
||||
Viewport location where notifications are rendered
|
||||
|
||||
position x ⇒ `left`, `center`, `right` <br />
|
||||
position y ⇒ `top`, `center`, `bottom`
|
||||
|
||||
Default ⇒ x: `right`, y: `bottom`
|
||||
|
||||
```php
|
||||
notyf()->position(string $position, string $value);
|
||||
```
|
||||
|
||||
{% assign id = '#/ notyf position' %}
|
||||
{% assign type = site.data.messages.types | sample %}
|
||||
{% assign message = site.data.messages[type] | sample %}
|
||||
{% assign options = '{"position": {"x": "center", "y":"top"}}' %}
|
||||
{% include example.html %}
|
||||
|
||||
```php
|
||||
{{ id }}
|
||||
|
||||
notyf()
|
||||
->position('x', 'center')
|
||||
->position('y', 'top')
|
||||
->{{ type }}('{{ message }}');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<p id="method-duration"><a href="#method-duration" class="anchor"><i class="fa-duotone fa-link"></i> duration</a></p>
|
||||
|
||||
Number of milliseconds before hiding the notification. Use 0 for infinite duration.
|
||||
|
||||
```php
|
||||
notyf()->duration(int $duration);
|
||||
```
|
||||
|
||||
{% assign id = '#/ notyf duration' %}
|
||||
{% assign type = site.data.messages.types | sample %}
|
||||
{% assign message = site.data.messages[type] | sample %}
|
||||
{% assign options = '{"duration": 2000}' %}
|
||||
{% include example.html %}
|
||||
|
||||
```php
|
||||
{{ id }}
|
||||
|
||||
notyf()
|
||||
->duration(2000) // 2 seconds
|
||||
->{{ type }}('{{ message }}');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<p id="method-ripple"><a href="#method-ripple" class="anchor"><i class="fa-duotone fa-link"></i> ripple</a></p>
|
||||
|
||||
Whether to show the notification with a ripple effect
|
||||
|
||||
Default ⇒ `true`
|
||||
|
||||
```php
|
||||
notyf()->ripple(bool $ripple);
|
||||
```
|
||||
|
||||
{% assign id = '#/ notyf ripple true' %}
|
||||
{% assign type = site.data.messages.types | sample %}
|
||||
{% assign message = site.data.messages[type] | sample %}
|
||||
{% assign options = '{"ripple": true}' %}
|
||||
{% include example.html %}
|
||||
|
||||
```php
|
||||
{{ id }}
|
||||
|
||||
notyf()
|
||||
->ripple(true)
|
||||
->{{ type }}('{{ message }}');
|
||||
```
|
||||
|
||||
{% assign id = '#/ notyf ripple false' %}
|
||||
{% assign options = '{"ripple": false}' %}
|
||||
{% include example.html %}
|
||||
|
||||
```php
|
||||
{{ id }}
|
||||
|
||||
notyf()
|
||||
->ripple(false)
|
||||
->{{ type }}('{{ message }}');
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<p id="method-dismissible"><a href="#method-dismissible" class="anchor"><i class="fa-duotone fa-link"></i> dismissible</a></p>
|
||||
|
||||
Whether to allow users to dismiss the notification with a button
|
||||
|
||||
Default ⇒ `false`
|
||||
|
||||
```php
|
||||
notyf()->dismissible(bool $dismissible);
|
||||
```
|
||||
|
||||
{% assign id = '#/ notyf dismissible' %}
|
||||
{% assign type = site.data.messages.types | sample %}
|
||||
{% assign message = site.data.messages[type] | sample %}
|
||||
{% assign options = '{"dismissible": true}' %}
|
||||
{% include example.html %}
|
||||
|
||||
```php
|
||||
{{ id }}
|
||||
|
||||
notyf()
|
||||
->dismissible(true)
|
||||
->{{ type }}('{{ message }}');
|
||||
```
|
||||
Reference in New Issue
Block a user