新手指南

关于 React Suite

React Suite 是一套 React 组件库，为中后台产品而生。致力于创造出贴心的交互设计，同时为开发者提供了友好的开发体验。

npm Travis Coverage Status Gitter

UI Design

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

支持的平台

浏览器

  • React Suite 支持所有主流的现代浏览器。
IE / Edge
IE		 IE / Edge
Edge		 Firefox
Firefox		 Chrome
Chrome		 Safari
Safari
>=10 >= 14 >= 45 >=49 >=10
  • 从 React Suite 3 开始 不支持 IE9 以下版本(包括 IE9) 。

  • 我们对 IE10 的支持采取了优雅降级的方式，部分样式和动画的表现会有所简化。

    注意：对于 IE 系列浏览器，需要提供使用 Polyfill 进行支持，我们建议您使用 babel-preset-env 来处理浏览器的兼容性问题。

  • 不推荐在移动端使用。

服务端

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

支持的开发环境

示例

更新日志

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

贡献

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

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

开发

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

测试驱动开发（TDD）

  1. Fork https://github.com/rsuite/rsuite 这个仓库。
$ git clone git@github.com:<YOUR NAME>/rsuite.git
$ cd rsuite
  1. 安装并运行
$ npm install
$ npm run tdd
  1. 运行单个组件
$ M=Button npm run tdd

UI 驱动开发

  1. Fork https://github.com/rsuite/rsuite 这个仓库。
$ git clone git@github.com:<YOUR NAME>/rsuite.git
  1. 安装并运行
$ cd rsuite
$ npm install
$ cd rsuite/docs
$ npm install
$ npm run dev
  1. 您可以开始访问了， 在浏览器输入 http://127.0.0.1:3000/

支持 RSUITE

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

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

opencollective-now

License

RSUITE 基于 MIT licensed 发布。