Documentation RCL
Documentation de la RCL
Table des matières
Aperçu
pankosmia-rcl est la bibliothèque de composants React partagée par les clients Pankosmia. Les composants documentés ici sont ceux du dossier v1.0 de la bibliothèque (src/rcl/v1.0). Ils sont exportés depuis le point d’entrée du paquet et sont construits sur MUI.
La bibliothèque exporte actuellement quatre composants v1.0 :
PanBasicDialog: une boîte de dialogue compacte pour les confirmations courtes et les petits formulaires.PanAdvancedDialog: une boîte de dialogue plus grande qui passe en plein écran sur les petits écrans.PanDialogActionsArray: une fonction utilitaire qui construit les boutons de fermeture et d’action fournis aux boîtes de dialogue.PanMenuWrapper: un menu qui s’affiche en fenêtre contextuelle sur les grands écrans et en tiroir inférieur sur les petits écrans.
Importez-les par leur nom depuis le paquet :
import {
PanBasicDialog,
PanAdvancedDialog,
PanDialogActionsArray,
PanMenuWrapper,
} from "pankosmia-rcl";
Sections de composants
Les composants sont documentés par famille. Chaque page explique chaque composant de la famille et chacune de ses propriétés :
- { site.data.i18n.pages.rcl_dialog.title[current_lang] }:
PanBasicDialog,PanAdvancedDialogetPanDialogActionsArray. - { site.data.i18n.pages.rcl_menu.title[current_lang] }:
PanMenuWrapper.
Débogage
L’option de débogage permet à l’utilisateur de voir les options pour développeurs. Lorsqu’elle est activée, tous les clients qui exigent le débogage et qui ne sont pas exclus du menu apparaissent dans le menu.