kubit react components

---

Erste Schritte

Installation

Führen Sie den folgenden Befehl aus, um das Paket zu installieren:

NPM

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

Garn

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

Dadurch wird das Paket und seine Abhängigkeiten installiert. Jetzt können Sie die Komponenten importieren und in Ihrer Anwendung verwenden.

Verwendung

Um die Komponenten zu verwenden, importieren Sie sie aus dem Paket und verwenden Sie sie in Ihrer Anwendung.

 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 ;

Dadurch wird die Schaltfläche mit den Standardstilen und -funktionen gerendert.

Hinweis: Der KubitProvider muss die Komponenten verwenden. Es bietet das Thema und einen anderen Kontext für die Komponenten.

Sie können weitere Informationen über die Änderung des Themas und anderer Optionen im Anpassungsthema finden

Dokumentation

Die Dokumentation für die Webkomponenten finden Sie auf der Kubit UI -Website

Storybook

Um das Storybook auszuführen, klonen Sie zunächst das Repository und installieren Sie die Abhängigkeiten. Führen Sie dann den folgenden Befehl aus:

npm run storybook

yarn storybook

Dadurch wird der Storybook -Server gestartet und Sie können die Komponenten in Aktion sehen.

Tests

Um die Tests auszuführen, können Sie den folgenden Befehl verwenden:

npm run test

yarn test

Dadurch werden die Tests durchgeführt und die Ergebnisse im Terminal angezeigt.

Beitragen

Wir sind offen für Beiträge. Wenn Sie zum Projekt beitragen möchten, befolgen Sie bitte die folgenden Schritte:

1. Fork auf das Repository : Klicken Sie in der oberen rechten Ecke der Seite des Repositorys auf GitHub auf die Schaltfläche "Fork". Dadurch wird eine Kopie des Repositorys in Ihrem Konto erstellt.

2. Klonen Sie das Repository : Verwenden Sie git clone um das Repository in Ihre lokale Maschine zu klonen.

   git clone

3. Erstellen Sie einen Zweig : Verwenden Sie git checkout , um eine neue Filiale für Ihre Änderungen zu erstellen.

   git checkout -b < branch-name >

4. Änderungen vornehmen : Nehmen Sie die erforderlichen Änderungen an der Codebasis vor. Und testen Sie die Änderungen.

5. Änderungen begehen : Verwenden Sie git commit um Ihre Änderungen an der Filiale zu verpflichten.

   git commit -m " Your commit message "

6. Push -Änderungen : Verwenden Sie git push um Ihre Änderungen in Ihr Forked -Repository zu schieben.

   git push origin < branch-name >

7. Öffnen Sie eine Pull -Anfrage : Gehen Sie zum ursprünglichen Repository auf GitHub und klicken Sie auf die Schaltfläche "Neue Pull Request". Füllen Sie das Formular mit Details zu Ihren Änderungen aus und senden Sie die Pull -Anfrage.

Sobald Ihre Pull -Anfrage eingereicht wurde, überprüft ein Betreuer Ihre Änderungen und gibt Feedback. Wenn alles gut aussieht, wird Ihre Pull -Anfrage zusammengeführt und Ihre Änderungen werden Teil des Projekts.

Weitere Informationen zum Beitrag zu unseren Projekten finden Sie in der Datei CONTRIBUTING.md .