kubit react components

---

Commencer

Installation

Pour installer le package, exécutez la commande suivante:

NPM

npm install @kubit-ui-web/react-components

fil

yarn add @kubit-ui-web/react-components

Cela installera le package et ses dépendances. Vous pouvez maintenant importer les composants et les utiliser dans votre application.

Usage

Pour utiliser les composants, importez-les dans le package et utilisez-les dans votre application.

 import { Button , KubitProvider } from '@kubit-ui-web/react-components' ;
import React from 'react' ;

const App = ( ) => {
  return (
    < KubitProvider >
      < Button variant = "PRIMARY" size = "MEDIUM" >
        Click me
      </ Button >
    </ KubitProvider >
  ) ;
} ;

export default App ;

Cela rendra le bouton avec les styles et les fonctionnalités par défaut.

Remarque: le KubitProvider est nécessaire pour utiliser les composants. Il fournit le thème et un autre contexte aux composants.

Vous pouvez faire plus d'informations sur Changer le thème et d'autres options dans le thème Personnaliser

Documentation

Vous pouvez trouver la documentation des composants Web du site Web de l'interface utilisateur de Kubit

Livre de contes

Pour exécuter le livre de contes, clonez tout d'abord le référentiel et installez les dépendances. Puis exécutez la commande suivante:

npm run storybook

yarn storybook

Cela commencera le serveur de contes de contes et vous pouvez voir les composants en action.

Tests

Pour exécuter les tests, vous pouvez utiliser la commande suivante:

npm run test

yarn test

Cela exécutera les tests et montrera les résultats du terminal.

Contributif

Nous sommes ouverts aux contributions. Si vous souhaitez contribuer au projet, veuillez suivre les étapes ci-dessous:

1. Fourchez le référentiel : cliquez sur le bouton "Fork" dans le coin supérieur droit de la page du référentiel sur GitHub. Cela créera une copie du référentiel dans votre compte.

2. Clone le référentiel : utilisez git clone pour cloner le référentiel de votre machine locale.

   git clone

3. Créez une branche : utilisez git checkout pour créer une nouvelle branche pour vos modifications.

   git checkout -b < branch-name >

4. Apporter des modifications : apportez les modifications nécessaires à la base de code. Et tester les changements.

5. Engagez des modifications : utilisez git commit pour engager vos modifications dans la succursale.

   git commit -m " Your commit message "

6. Poussez les modifications : utilisez git push pour pousser vos modifications à votre référentiel fourchu.

   git push origin < branch-name >

7. Ouvrez une demande de traction : accédez au référentiel d'origine sur GitHub et cliquez sur le bouton "New Pull Demande". Remplissez le formulaire avec des détails sur vos modifications et soumettez la demande de traction.

Une fois que votre demande de traction a été soumise, un responsable examinera vos modifications et fournira des commentaires. Si tout semble bon, votre demande de traction sera fusionnée et vos modifications feront partie du projet.

Pour plus d'informations sur la contribution à nos projets, veuillez vous référer au fichier CONTRIBUTING.md .