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文件。