Templates
HeaderPluginEntryPoint
Composant de header pour les vues de point d'entrée des bundles (le plus souvent des menus).
Génère un Header avec l'icône du bundle et son titre.
Propriété | Description | Statut |
---|---|---|
plugin | la configuration du bundle ciblé | Obligatoire |
HeaderPluginModule
Composant de header pour les pages de modules de bundle.
Génère un header avec le titre du module et un lien de retour arrière vers le point d'entrée du bundle de ce module.
Propriété | Description | Statut |
---|---|---|
plugin | la configuration du bundle ciblé | Obligatoire |
module | la configuration du module ciblé | Obligatoire |
PluginModuleCard
Composant d'une tuile du menu principal (voir Home) (lien)
Propriété | Description | Statut |
---|---|---|
title | le titre de la tuile | Obligatoire |
icon | l'icône à afficher sur la tuile (voir ant-design) | Obligatoire |
link | la route du lien | Obligatoire |
description | la description de la tuile | Facultatif |
className | la classe personnalisée | Facultatif |
style | le style personnalisé | Facultatif |
SubMenuPlugin
Composant de menu d'accès aux différents modules d'un bundle (sous-menu d'un bundle)
Génère automatiquement un menu avec ses liens avec l'icone de chaque module et son titre.
Donne la possibilité d'ajouter une entrée de menu vers un module externe au bundle.
Utilise CreateLinkFromPlugin
.
Propriété | Description | Statut |
---|---|---|
plugin | le titre de la tuile | Obligatoire |
externalModules | la liste des configurations de modules externes au plugin courant que l'on veut voir afficher dans ce sous-menu | Facultatif |
header | déclenche l'affichage ou non du HeaderPluginEntryPoint du menu | Facultatif |
match | props match de react. contiens eventuellement le parametre id pour la construction d'un lien vers un objet particulier | Facultatif |
CreateLinkFromPlugin
En lui passant la clé unique d'un module, ce composant génère automatiquement un lien de navigation depuis la configurations du module
(necessite d'avoir délcaré une route pour le module dans le configuration de ce dernier).
Si la configuration du module contient des propriétés d'accès (accessControlAction...)
on testera les droits avant de générer le composant. Sinon le composant sera affiché et actif par defaut.
Utilise Link
de react-router-dom
.
Propriété | Description | Statut |
---|---|---|
plugin | la configuration du bundle qui contiens le module visé par le lien | Obligatoire |
eltKey | La clé unique du module visé | Obligatoire |
state | l'objet state à passer au lien (voir react-router-dom ) | Facultatif |
ability | les habilitations de l'utilisateur courant afin de tester les accès pour ce lien (necessite que les conf d'accès soient définies dans le module) | Facultatif |
controlAccess | Boolean : Définis si des contrôles d'accès doivent être effectués. | Facultatif |
objectIdsToLink | objet contenant les valeurs des paramètres d'url auxquels fait référence le lien et/ou l'objet à tester en cas de contrôles d'accès. ex : si url = board/:boardId/tache/:taskName , l'objet passé doit être {boardId: valeur, taskName: valeur} ex : si url = board/:boardId/tache/:taskName , et accessControl = true l'objet passé doit être votre objet à tester, enrichi avec les paramètres d'url s'il ne les porte pas déjà {...objectToTest, boardId: valeur, taskName: valeur} | Facultatif (Obligatoire si url parametrée et/ou si contrôles d'accès) |
children | Les enfants du lien | Facultatif |