rocket ui

？弃用

该图书馆已被弃用。这些组件已使用最新的Materi-UI和React版本重新设计，可以在此处找到：Rocket-UI

有关文档和有意义的例子，请签出GitBook文档

---

火箭 - UI（已弃用）

位收集

一组可重复使用的可重复使用的反应组件构建在材料UI核心之上，用于开发快速友好的Web应用程序接口。

？‍检查从位遗产到位和谐版本的迁移指南。

？安装

NPMRC是NPM配置文件，为了使用我们的库，您需要配置此文件。

！如果使用我们的WebApp Rocket Generator生成项目，则跳过此步骤。 .NPMRC文件已经配置

跑步

npm config set @totalsoft_oss:registry https://node.bit.cloud

此命令将在您的root .NPMRC文件中添加一个条目。如果不存在，它将创建一个。

- 安装一个组件

转到组件主页，然后选择您使用的软件包管理器的命令。您也可以选择要安装的版本。

在您的终端中运行命令，您将准备使用它！

npm i @totalsoft_oss/rocket-ui.components.data-display.typography

- 使用单个软件包安装所有组件

如果您只想将项目中的所有组件放在一个软件包中。导航到位云中的核心组件。

通过运行安装core包

npm i @totalsoft_oss/rocket-ui.core

用法

    import React from 'react'
    import Typography from '@totalsoft_oss/rocket-ui.components.data-display.typography'
    /* example using core package
    import { Typography } from '@totalsoft_oss/rocket-ui.core'
    */

    const App = ( ) => {
        return (
            < Typography variant = 'body2' emphasis = 'bold' >
                "Text"
            </ Typography >
        )
    } 

？组件结构

每个组件都在适合其目的的部分中。例如，所有与按钮相关的组件都位于buttons文件夹中。所有组件都具有相同的文件结构。我们通过创建自己的组件生成器来实现和执行此结构，该功能由BIT提供。如您所见，所有组件和将使用rocket-generator模板创建的组件都将具有以下结构

• index.js条目文件。
• MyComponent.js主文件。
• MyComponent.test.js测试文件。
• MyComponent.docs.mdx docs文件。
• compositions组成文件夹。
  • MyComponent.composition.js组成，用于模拟不同状态和上下文中的组件。

？贡献指南

我们使用位用于组件管理和贡献。 BIT是用于组成组件驱动软件的开源工具。

- 安装位

由于某些兼容性问题，建议使用命令提示而不是powershell。

npm i -g @teambit/bvm

bvm install

如果安装时发生任何错误，请检查故障排除部分。

- 启动本地服务器

Bit成功安装后，您可以将存储库克隆并充分使用位功能。

要立即开始运行命令提示bit start并打开Localhost：3000。您第一次运行此命令可能需要一段时间，因为它正在为您的开发环境构建整个用户界面。当本地服务器启动并运行时，您会看到所有组件，并且可以与它们进行交互。

bit start

- 修改现有组件

根据您的需求更改/修复组件后，您应该运行bit test以确保所有测试都通过，并在您的更改所需的情况下添加更多。

bit test

另外，如果添加了新功能，除了测试外，还应添加具有新功能的示例。示例文件位于compositions目录中的每个组件目录中。

更改组件后，您需要运行bit status以检查与位相关的问题，然后bit compile以便在UI中进行最新修改。

bit status

bit compile

- 添加新组件

为了创建新组件，您应该使用我们自己的组件生成器rocket-generator ，它提供了一个有助于实现新组件的模板。

bit create rocket-generator components/buttons/my-component

- 打开拉请求

完成更改/功能/修复程序并要标记出发布哪些组件，其下一个版本和ChangElog Message使用-Soft选项。

bit tag -m " my message " --soft

运行上述命令后，您应该看到更改bitmap文件，然后可以创建拉动请求。

您可以阅读有关他在这里提供的BIT和其他功能性的更多信息。

执照

Rocket-UI已获得MIT许可证的许可。 @totalsoft