README_zh.md

English | 中文版

React Suite 是一套 React 组件库。致力于提供高质量并且全面的 React 组件，以帮助开发者快速构建 Web 应用。

支持的平台

浏览器

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

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

服务端

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

安装

# with npm
npm install rsuite

# with Yarn
yarn add rsuite

# with pnpm
pnpm add rsuite

# with Bun
bun add rsuite

使用

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

function App() {
  return <Button appearance="primary">Hello World</Button>;
}

更多关于如何开始的指南，请查看这里。

文档

https://rsuitejs.com 是 React Suite 的最新版本的网站。有关旧版本，请访问这里。

• 4.x 版本文档
• 3.x 版本文档

v4 将不再添加新特性，我们推荐你升级到最新的 v5 版本。v4 的功能修复仍会在一段时间内提供支持，安全修复也会支持，直到 v6 开始开发。

框架使用指南

React Suite 可以在您喜欢的框架中使用。我们为这些框架准备了逐步指南：

• Next.js (App)
• Next.js (Page)
• Create React App
• Vite

更新日志

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

贡献

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

赞助服务

这些优秀的服务帮助我们构建和维护项目。

Service	Description
	Github 让我们可以托管 Git 仓库并协调贡献。
	Vercel 让我们可以部署应用。
	CodeCov 让我们可以检查代码覆盖率。
	Gitee 授予我们 GVP - Gitee 最有价值开源项目。
	CodeSandbox 让我们可以提供组件的实时预览。
	Stackblitz 让我们可以提供组件的实时预览。

支持 React Suite

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

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

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

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

License

React Suite 基于 MIT licensed 发布。