HRnet Modal — composant React publié sur npm
Composant de fenêtre modale React accessible, écrit en TypeScript, testé avec Vitest et publié sur npm sous le nom
modal-cyril-bartz.
👉 Voir le site : bartzcyril.github.io/Hrnet-Modal
Page de démonstration du composant, avec une modale par défaut et une modale personnalisée (styles, fermeture au clic désactivée). Testez l'ouverture, la fermeture par la croix, au clic ou avec Échap, et la navigation au clavier.
Sujet
Projet de formation OpenClassrooms. L'application RH interne HRnet reposait sur jQuery et plusieurs plugins jQuery, source de lenteurs. La mission : migrer l'application vers React et remplacer l'un des plugins jQuery par un composant React, publié comme une bibliothèque réutilisable. J'ai choisi la fenêtre modale.
Compétences acquises
- Création d'une bibliothèque React : build en mode librairie avec Vite (formats ES et UMD, génération des types
.d.ts),reactetreact-domdéclarés en dépendances externes - Publication sur npm et gestion des versions
- Accessibilité : rendu dans un portail,
role="dialog",aria-modal, focus placé dans la modale à l'ouverture et piégé dans la modale avec la touche Tab, fermeture au clavier - TypeScript : props typées, documentation JSDoc
- Tests avec Vitest et Testing Library (ouverture, fermeture par la croix, au clic, avec Entrée et Échap) et mesure de la couverture
- Styled-components pour un style encapsulé, personnalisable via les props
Installation
npm install modal-cyril-bartz
Utilisation
import {Modal, useToggle} from "modal-cyril-bartz";
function Example() {
const {show, toggle} = useToggle(false);
return (
<>
<button onClick={toggle}>Ouvrir</button>
<Modal open={show} onClose={toggle}>
<p>Employé créé !</p>
</Modal>
</>
);
}
Props
| Prop | Type | Défaut | Description |
|---|---|---|---|
open |
boolean |
— | Ouvre ou ferme la modale |
onClose |
() => void |
— | Fonction appelée pour fermer la modale |
children |
React.ReactNode |
— | Contenu de la modale |
escapeClose |
boolean |
true |
Fermeture avec la touche Échap |
clickClose |
boolean |
true |
Fermeture au clic dans la modale |
showClose |
boolean |
true |
Affiche l'icône de fermeture (X) en haut à droite |
bgroundStyle |
CSSProperties |
— | Style du fond autour de la modale |
modalStyle |
CSSProperties |
— | Style de la modale |
iconCloseStyle |
CSSProperties |
— | Style de l'icône (X) |
Le hook useToggle(valeurInitiale) est fourni pour gérer simplement l'état ouvert / fermé.
Développement
npm install
npm run dev # page de démonstration
npm test # tests Vitest
npm run coverage # rapport de couverture
npm run build # build de la librairie dans dist/
npm run build:demo # build de la page de démo dans demo-dist/ (déployée sur GitHub Pages)