fxgcomponents_stham001
v1.0.4
Published
420-314-FX-A22 TP2 - Package NPM de composants React
Downloads
5
Readme
Description
La bibliothèque contient 10 composants React réutilisables :
Pour démarrer le storybook :
npm run storybook
Liste des composantes
Alert
Dans la composante "Alert", nous avons une fontion appelée "BasicAlerts", qui contient deux arguments :
severity :
- Type : string
- Affiche la sévérité ou la gravité d'alerte et peut être une alerte en "warning", "success", "info" et "danger".
text :
- Type : string
- Affiche un message en fonction du type d'alerte. Le message à l'intérieur des alertes change en fonction d'alerte.
Autocomplete
Dans la composante "Autocomplete", nous avons une fonction intitulée "CountrySelect" qui a pour objectif de selectionner ou non un pays dans une liste déroulante en saisissant automatiquement le nom du pays dans le champ input. Cette fonction possède quatre arguments :
text :
- Type : string
- Permet de saisir un titre pour la composante, par exemple.
disabled :
- Type : boolean
- Permet de désactiver la liste déroulante s'il est vrai.
disableClearable :
- Type : boolean
- Si vrai, l'entrée ne peut pas être effacée avec l'icone "x".
disableCloseOnSelect :
- Type : boolean.
- Si vrai , la fenêtre contextuelle ne se ferme pas lorsqu'une valeur est sélectionnée. Ainsi, la fenêtre de la liste déroulante reste bloquée et se referme pas lorsqu'un pays est sélectionné.
Bouton
La composante "Bouton" a une fonction appelée "Bouton" possédant quatre arguments :
width :
- Type : number
- A pour objectif d'augmenter ou de diminuer la largeur des boutons.
variant :
- Type : string
- Permet de choisir la variante que l'on veut. Il existe 3 variantes "contained", "outlined" et "text".
text :
- Type : string
- Permet de changer le contenu du bouton de façon automatique.
color :
- Type : string
- Permet de choisir n'importe quelle couleur. Mais comme nous utilisons le MUI, nous nous sommes contentés des couleurs prédéfinies dans MUI.
BoutonFlottants
La composante BoutonFlottants possède une fonction qui contient 6 arguments :
text :
- Type : string
- Permet de changer le titre des boutons de façon automatique.
color :
- Type : string
- Permet de choisir n'importe quelle couleur. Mais comme nous utilisons le MUI, nous nous sommes contentés des couleurs prédéfinies dans MUI.
size :
- Type : string
- Permet de jouer sur la taille et la grandeur des boutons.
marginRight :
- Type : number
- Pour faire une marge de droite entre les boutons flottants.
variant :
- Type : string
- La variante utilisée peut etre soit "circular" soit "extended".
disabled :
- Type : boolean.
- Permet de desactiver un ou plusieurs boutons flottants.
Checkbox
La composante Checkbox possède une fonction qui contient 4 arguments :
size :
- Type : string
- Permet de jouer sur la taille et la grandeur des checkbox.
color :
- Type : string
- Permet de choisir n'importe quelle couleur. Mais comme nous utilisons le MUI, nous nous sommes contentés des couleurs prédéfinies dans MUI.
checked :
- Type : boolean
- Si c'est vrai, le composant est coché.
text :
- Type : string
- Permet de changer le titre des boutons de façon automatique.
Grid
La composante Grid contient une fonction Grid avec deux arguments :
spacing :
- Type : number
- Permet de définir l'espace entre les composants de l'élément de type. Il ne peut être utilisé que sur un composant de conteneur de type.
xs :
- Type : number
- Définit le nombre de colonnes utilisées par l'élément de grille. Il ne peut pas être supérieur au nombre total de colonnes du conteneur (12 par défaut).
Menu
La composantemée Menu possède une fonction appelée AccountMenu qui contient 3 arguments :
display : Propriété CSS qui représente un argument dans notre composante pour afficher notre menu soit avec display "flex" ou display "row".
alignItems : Propriété CSS qui représente un argument dans notre composante pour aligner nos Items soit à gauche, à droite ou au centre.
textAlign : Propriété CSS qui représente un argument dans notre composante pour aligner les textes soit à gauche, à droite ou au centre.
Pagination
Dans la composante Pagination, nous avons une fonction appelée BasicPagination. A l'intérieur de cette fonction, nous avons 3 arguments :
variant :
- Type : string
- La variante utilisée peut être soit "outlined" soit "text".
color :
- Type : string
- Permet de choisir n'importe quelle couleur. Mais comme nous utilisons le MUI, nous nous sommes contentés des couleurs prédéfinies dans MUI.
disabled :
- Type : boolean
- Permet de desactiver les numéros de la pagination.
Slider
La composante Slider contient une fonction nommée ContinuousSlider avec 5 arguments :
track :
- Type "string"
- Prend comme valeur "inverted" ou "normal". Il est normal par défaut. S'il est "normal", la piste affichera une barre représentant la valeur du curseur. Et s'il est "inverted", la piste affichera une barre représentant la valeur restante du curseur.
olor :
- Type : string
- Permet de choisir n'importe quelle couleur. Mais comme nous utilisons le MUI, nous nous sommes contentés des couleurs prédéfinies dans MUI.
disabled :
- Type : boolean
- Il est false par défaut. Mais si c'est vrai, le composant est désactivé.
orientation : - Type : string - Prend comme valeur "horizontal" ou "vertical". Par défaut, il est horizontal.
height : Le height est une propriété CSS pour fixer la hauteur du composant.
Switch
La composante Switch contient une fonction appelée BasicSwitches avec deux arguments déclarés à l'intérieur de cette fonction :
- defaultChecked :
- Type : boolean
- Il est false par defaut. Mais on peut utiliser lorsque le composant n'est pas contrôlé.
- disabled :
- Type : boolean
- Il est false par défaut. Mais si c'est vrai, le composant est désactivé.