kubit react components

---

入門

安裝

要安裝軟件包，請運行以下命令：

NPM

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

紗

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

這將安裝軟件包及其依賴項。現在，您可以導入組件並將其在您的應用程序中使用。

用法

要使用這些組件，請從包裝中導入它們，然後將其在您的應用程序中使用。

 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 ;

這將用默認樣式和功能渲染按鈕。

注意：需要使用KubitProvider才能使用組件。它為組件提供主題和其他上下文。

您可以在自定義主題中更改主題和其他選項的更多信息

文件

您可以在Kubit UI網站中找到Web組件的文檔

故事書

要運行故事書，首先要克隆存儲庫並安裝依賴項。然後運行以下命令：

npm run storybook

yarn storybook

這將啟動Storybook服務器，您可以看到正在使用的組件。

測試

要運行測試，您可以使用以下命令：

npm run test

yarn test

這將運行測試並在終端顯示結果。

貢獻

我們願意做出貢獻。如果您想為該項目做出貢獻，請按照以下步驟操作：

1. 叉子存儲庫：單擊Github右上角右上角的“叉”按鈕。這將在您的帳戶中創建存儲庫的副本。

2. 克隆存儲庫：使用git clone將存儲庫克隆到本地計算機。

   git clone

3. 創建一個分支：使用git checkout為您的更改創建一個新分支。

   git checkout -b < branch-name >

4. 進行更改：對代碼庫進行任何必要的更改。並測試更改。

5. 提交更改：使用git commit將您的更改提交分支機構。

   git commit -m " Your commit message "

6. 推動更改：使用git push將更改推向分叉存儲庫。

   git push origin < branch-name >

7. 打開拉動請求：轉到GitHub上的原始存儲庫，然後單擊“新拉請求”按鈕。填寫有關您更改的詳細信息的表格，並提交拉動請求。

提交拉動請求後，維護人員將審查您的更改並提供反饋。如果一切看起來都不錯，您的拉力請求將被合併，您的更改將成為項目的一部分。

有關為我們的項目做出貢獻的更多信息，請參閱CONTRIBUTING.md文件。