hrnet-components-ohm
v0.0.16
Published
HRNet components for React
Downloads
18
Maintainers
Readme
HRNet Components Library
Cette librairie regroupe trois composants principaux, accessibles sur npm sous forme de package :
DatePicker
Permet de saisir une date, d’ouvrir un calendrier interactif et de transmettre la valeur sélectionnée via un champ caché.- Propriétés :
name?: stringvalue?: string(valeur initiale, format "JJ/MM/AAAA")placeholder?: stringonChange?: (value: string) => void
- Affiche un champ texte, un bouton pour ouvrir le calendrier, et insère automatiquement un champ
<input type="hidden">pour la soumission en formulaire.
- Propriétés :
CustomSelect
Un sélecteur personnalisable permettant de choisir une option et de la transmettre via un champ caché.- Propriétés :
options: T[]defaultValue?: Tplaceholder?: stringname?: stringonOptionChange?: (value: T) => void
- Permet de sélectionner une valeur parmi des options et met à jour un champ
<input type="hidden">.
- Propriétés :
Modal
Affiche une fenêtre modale avec un titre, un message et un bouton de fermeture.- Propriétés :
title: stringmessage: stringsetIsOpenModal: React.Dispatch<React.SetStateAction<boolean>>
- Propriétés :
Prérequis
- Node.js (version 18 ou supérieure)
- npm (version 9 ou supérieure)
- React (version 18 ou supérieure)
- ReactDOM (version 18 ou supérieure)
Gestion du projet global
Cette section explique comment ajouter un composant, compiler la CSS, construire la librairie et la publier sur npm.
1. Ajouter un composant
- Créer un fichier sous
src/libpour votre nouveau composant. - L’exporter dans
src/lib/index.tsxpour l’inclure dans la librairie.
2. Compiler la CSS
- La compilation Tailwind génère components.css.
- Pour régénérer ce fichier, exécutez :
(Voirnpm run build-csspackage.jsonpour la définition du script.)
3. Construire la librairie
- Pour construire la librairie, exécutez :
Cela compile votre code TypeScript et copie les fichiers nécessaires dans le dossiernpm run builddist.
4. Publier sur npm
- Ajuster le numéro de version dans
package.json. - Pour publier sur npm, authentifiez-vous puis exécutez :
Vous pouvez ainsi distribuer vos composants sous forme de package npm, prêt à être utilisé dans d’autres projets.npm publish
