README_zh.md

English | 中文版

React Suite 是一套 React 组件库，为后台产品而生。同时也是一个具有贴心设计以及对开发者友好的 UI 框架。

UI Design

React Suite 设计原型与规范， 点击查看。

支持的平台

浏览器

React Suite 支持最新的，稳定版的全部主流浏览器和平台。 从 React Suite 3 开始不支持 IE9 以下版本(包括 IE9)。不推荐在移动端使用。

IE	Edge	Firefox	Chrome	Safari
>=11	>=14	>= 45	>= 49	>= 10

服务端

React Suite 支持服务端渲染， 支持通过 Next.js 构建应用。

支持的开发环境

• 支持 React 16 +
• 支持 TypeScript
• 支持 Electron

安装

React Suite 可通过 npm 安装。

npm i rsuite@next --save

使用

这里有一个简单的示例：

import { Button } from 'rsuite';
import 'rsuite/styles/index.less'; // or 'rsuite/dist/rsuite.min.css'

ReactDOM.render(<Button>Button</Button>, mountNode);

您可以在 CodeSandbox 上查看该示例。

文档

您可以阅读完整文档，或者从下面几个章节开始学习

• 如何使用？
• 自定义主题
• 国际化
• Right-to-left
• 组件

历史版本:

• 3.* 版本
• 2.* 版本

示例

• 管理系统
• 模块化按需加载
• CDN 引入
• 国际化方案
• 多主题方案
• RTL 方案 - rtlcss
• RTL 方案 - postcss-rtl
• 在 create-react-app 中使用
• 在 Electron 中使用
• 在 Flow 中使用
• 在 TypeScript 中使用
• 在 Next.js 中使用
• 在 Next.js 和 Typescript 中使用
• 在 UmiJS 中使用
• 在 Snowpack 中使用
• 在 Vite 中使用

更新日志

每一个版本的详细变化记录在Release Notes

开发

您可以通过 Projects 查看我们的开发计划，同时希望您能参与其中。

测试驱动开发（TDD）

1. Fork https://github.com/rsuite/rsuite 这个仓库。

$ git clone [email protected]:<YOUR NAME>/rsuite.git
$ cd rsuite

2. 安装并运行

$ npm i
$ npm run tdd

3. 运行单个组件

$ M=Button npm run tdd

UI 驱动开发

1. Fork https://github.com/rsuite/rsuite 这个仓库。

$ git clone [email protected]:<YOUR NAME>/rsuite.git

2. 安装并运行

$ npm i
$ npm run dev

3. 您可以开始访问了， 在浏览器输入 http://127.0.0.1:3000/

Gitee 用户访问地址: https://gitee.com/rsuite/rsuite

贡献

在开始之前，确保您已读贡献指南。

编辑器的配置参考 .prettierrc， 下载编辑的插件 https://prettier.io/

支持 React Suite

如果您喜欢 React Suite，可以通过以下方式支持我们：

• Star 这个项目。
• 如果您在您的项目中使用了 React Suite，欢迎在这里留言！
• 在 OpenCollective 上赞助我们。

这个项目的存在归功于所有贡献者。

国内交流群, 添加 React Suite 小助手，备注 rsuite， 邀请入群。

License

React Suite 基于 MIT licensed 发布。