Skip to content
Snippets Groups Projects
Commit 9954d1c4 authored by Bertrand Gauthier's avatar Bertrand Gauthier
Browse files

Doc

parent 3d838769
No related branches found
No related tags found
No related merge requests found
Pipeline #15710 passed
......@@ -5,3 +5,6 @@ CHANGELOG
-----
- Première version
1.1.0
-----
- Nouveau format d'affichage : Modal Bootstrap.
Module UnicaenAlerte
====================
Ce module permet d'afficher des alertes sur une page de votre application, sous la forme :
- d'un Toast Bootstrap,
- ou d'une Alerte Bootstrap,
- d'une `alert` Javascript.
Ce module permet d'afficher des alertes sur une page de votre application, sous la forme de :
- Toasts Bootstrap :
- Recommandé.
- Positionnement fixe par défaut : en haut à droite ; empilés.
- Cf. https://getbootstrap.com/docs/5.2/components/toasts/
- Alerts Bootstrap :
- Affichage en place.
- Cf. https://getbootstrap.com/docs/5.2/components/alerts/
- Modals Bootstrap :
- En cas d'alertes multiples, un bouton permet de naviguer d'une alerte à l'autre.
- Cf. https://getbootstrap.com/docs/5.2/components/modal/#toggle-between-modals
- Alertes Javascript :
- pas de HTML possible dans ce format évidemment.
Pour l'instant :
- le module puise les alertes uniquement dans une base de données ;
- le module ne propose pas de formulaire pour ajouter/modifier/supprimer des alertes en base de données.
- le module ne propose pas d'IHM pour ajouter/modifier/supprimer des alertes en base de données.
Le module fournit une aide de vue `alertes` (cf. `UnicaenAlerte\View\Helper\AlerteViewHelper`).
Exemples
--------
Le module fournit une aide de vue `alertes` (cf. `UnicaenAlerte\View\Helper\AlerteViewHelper`).
```php
// Affichage de toutes les alertes, sous forme d'un Toast Bootstrap à condition que leur planning
// Affichage de toutes les alertes, sous forme de Toasts Bootstrap, à condition que leur planning
// d'affichage inclue la date du jour :
echo $this->alertes()->withMatchingPlanning()->renderAsBootstrapToasts();
// Affichage d'une alerte identifiée par son code, sous forme d'un Toast Bootstrap à condition que son planning
// Idem, sous forme d'Alerts Bootstrap classiques :
echo $this->alertes()->withMatchingPlanning()->renderAsBootstrapAlerts();
// Idem, sous forme de Modals Bootstrap chaînées :
echo $this->alertes()->withMatchingPlanning()->renderAsBootstrapModals();
// Idem, sous forme d'alertes Javascript :
echo $this->alertes()->withMatchingPlanning()->renderAsJavascriptAlerts();
// Affichage d'une alerte identifiée par son code, sous forme d'un Toast Bootstrap, à condition que son planning
// d'affichage inclue la date du jour :
echo $this->alertes()->withCode('ALERTE_SOUTENANCE')->withMatchingPlanning()->renderAsBootstrapToasts();
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment