# rsuite **Repository Path**: codingstudio/rsuite ## Basic Information - **Project Name**: rsuite - **Description**: 一套 React 的 UI 组件库，贴心的 UI 设计，友好的开发体验。 - **Primary Language**: TypeScript - **License**: MIT - **Default Branch**: next - **Homepage**: http://rsuitejs.com - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 79 - **Created**: 2021-03-08 - **Last Updated**: 2021-11-02 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README [English][readm-en] | 中文版

React Suite logo

[![npm][npm-svg]][npm-home] [![Travis][travis-svg]][travis-home] [![Coverage Status][coverage-svg]][travis-home] [![Discord][discord-svg]][discord-invite] [![Gitter][gitter-svg]][gitter] [![Gitter][gitter-cn-svg]][gitter-cn] React Suite 是一套 React 组件库，为后台产品而生。同时也是一个具有贴心设计以及对开发者友好的 UI 框架。 ### UI Design React Suite 设计原型与规范， [点击查看][rsuite-design]。 ## 支持的平台 ### 浏览器 React Suite 支持最新的，稳定版的全部主流浏览器和平台。 从 React Suite 3 开始不支持 IE9 以下版本(包括 IE9)。不推荐在移动端使用。 | IE | Edge | Firefox | Chrome | Safari | | ---- | ---- | ------- | ------ | ------ | | >=10 | >=14 | >= 45 | >= 49 | >= 10 | ### 服务端 React Suite 支持服务端渲染， 支持通过 [Next.js](https://github.com/zeit/next.js) 构建应用。 ## 支持的开发环境 - 支持 React 16 + - 支持 [TypeScript](http://www.typescriptlang.org/) - 支持 [Electron](https://electronjs.org/) ## 安装 React Suite 可通过 [npm][npm-home] 安装。 ```bash npm i rsuite@next --save ``` ## 使用 这里有一个简单的示例： ```js import { Button } from 'rsuite'; import 'rsuite/lib/styles/index.less'; // or 'rsuite/dist/styles/rsuite-default.css' ReactDOM.render(, mountNode); ``` 您可以在 [CodeSandbox][live-preview-on-codesandbox] 上查看该示例。 ### 文档 您可以阅读[完整文档][rsuite-doc-guide]，或者从下面几个章节开始学习 - [如何使用？][rsuite-doc-guide] - [自定义主题][rsuite-doc-guide-themes] - [国际化][rsuite-doc-guide-intl] - [Right-to-left][rsuite-doc-guide-intl] - [组件][rsuite-components-overview] **历史版本:** - [3.\* 版本](https://v3.rsuitejs.com/) - [2.\* 版本](https://v2.rsuitejs.com/) ### 示例 - [管理系统][demo-admin] - [模块化按需加载][demo-modular-import] - [CDN 引入][demo-cdn] - [国际化方案][demo-intl-app] - [多主题方案][demo-multiple-themes] - [RTL 方案 - rtlcss][demo-rtlcss] - [RTL 方案 - postcss-rtl][demo-postcss-rtl] - [在 create-react-app 中使用][demo-create-react-app] - [在 Electron 中使用][demo-electron] - [在 Flow 中使用][demo-flow-app] - [在 TypeScript 中使用][demo-typescript-app] - [在 Next.js 中使用][demo-nextjs] - [在 UmiJS 中使用][demo-umi-app] ## 更新日志 每一个版本的详细变化记录在[Release Notes][release-notes] ## 开发 您可以通过 [Projects](https://github.com/rsuite/rsuite/projects) 查看我们的开发计划，同时希望您能参与其中。 ### 测试驱动开发（TDD） 1. Fork `https://github.com/rsuite/rsuite` 这个仓库。 ```bash $ git clone git@github.com:/rsuite.git $ cd rsuite ``` 2. 安装并运行 ```bash $ npm i $ npm run tdd ``` 3. 运行单个组件 ```bash $ M=Button npm run tdd ``` ### UI 驱动开发 1. Fork `https://github.com/rsuite/rsuite` 这个仓库。 ```bash $ git clone git@github.com:/rsuite.git ``` 2. 安装并运行 ```bash $ npm i $ npm run dev ``` 3. 您可以开始访问了， 在浏览器输入 http://127.0.0.1:3000/ Gitee 用户访问地址: https://gitee.com/rsuite/rsuite ## 贡献 在开始之前，确保您已读[贡献指南][contributing]。 编辑器的配置参考 [.prettierrc][prettierrc]， 下载编辑的插件 https://prettier.io/ ## 支持 React Suite 如果您喜欢 React Suite，可以通过以下方式支持我们： - Star 这个项目。 - 如果您在您的项目中使用了 React Suite，欢迎在这里[留言][issues-11]！ - 在 [OpenCollective](https://opencollective.com/rsuite#) 上赞助我们。 这个项目的存在归功于所有贡献者。 国内交流群, 添加 React Suite 小助手，备注 rsuite， 邀请入群。 ## License React Suite 基于 [MIT licensed][license] 发布。 [readm-en]: https://github.com/rsuite/rsuite/blob/master/README.md [npm-svg]: https://badge.fury.io/js/rsuite.svg [npm-home]: https://www.npmjs.com/package/rsuite [travis-svg]: https://travis-ci.org/rsuite/rsuite.svg?branch=master [travis-home]: https://travis-ci.org/rsuite/rsuite [coverage-svg]: https://coveralls.io/repos/github/rsuite/rsuite/badge.svg?branch=master [travis-home]: https://coveralls.io/github/rsuite/rsuite?branch=master [discord-svg]: https://img.shields.io/badge/Discord-Join%20chat%20%E2%86%92-738bd7.svg [discord-invite]: https://discord.gg/R8mnjwh [rsuite-design]: https://rsuitejs.com/design/default [live-preview-on-codesandbox]: https://codesandbox.io/s/mo7jxvr9x9?from-embed [rsuite-doc-guide]: https://rsuitejs.com/guide/introduction [rsuite-doc-guide-themes]: https://rsuitejs.com/guide/themes [rsuite-doc-guide-intl]: https://rsuitejs.com/guide/intl [rsuite-doc-guide-intl]: https://rsuitejs.com/en/guide/intl [rsuite-components-overview]: https://rsuitejs.com/components/overview [release-notes]: https://github.com/rsuite/rsuite/releases [contributing]: https://github.com/rsuite/rsuite/blob/master/CONTRIBUTING.zh-CN.md [prettierrc]: https://github.com/rsuite/rsuite/wiki/.prettierrc [issues-11]: https://github.com/rsuite/rsuite/issues/11 [opencollective-svg]: https://opencollective.com/rsuite/tiers/backer.svg?avatarHeight=36 [opencollective-home]: https://opencollective.com/rsuite [license]: https://github.com/rsuite/rsuite/blob/master/LICENSE [gitter]: https://gitter.im/rsuite/rsuite?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge [gitter-svg]: https://img.shields.io/gitter/room/rsuite/rsuite?label=chat-english [gitter-cn]: https://gitter.im/rsuite/rsuite-CN?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge [gitter-cn-svg]: https://img.shields.io/gitter/room/rsuite/rsuite?label=chat-chinese [demo-admin]: https://github.com/rsuite/rsuite-management-system [demo-modular-import]: https://github.com/rsuite/rsuite/tree/master/examples/with-babel-preset-rsuite [demo-cdn]: https://github.com/rsuite/rsuite/tree/master/examples/cdn [demo-create-react-app]: https://github.com/rsuite/rsuite/tree/master/examples/create-react-app [demo-electron]: https://github.com/rsuite/rsuite/tree/master/examples/with-electron [demo-intl-app]: https://github.com/rsuite/rsuite/tree/master/examples/custom-i18n [demo-multiple-themes]: https://github.com/rsuite/rsuite/tree/master/examples/custom-multiple-themes [demo-flow-app]: https://github.com/rsuite/rsuite/tree/master/examples/with-flow [demo-typescript-app]: https://github.com/rsuite/rsuite/tree/master/examples/with-typescript [demo-nextjs]: https://github.com/rsuite/rsuite/tree/master/examples/with-nextjs [demo-umi-app]: https://github.com/rsuite/rsuite/tree/master/examples/with-umi [demo-rtlcss]: https://github.com/rsuite/rsuite/tree/master/examples/with-rtlcss [demo-postcss-rtl]: https://github.com/rsuite/rsuite/tree/master/examples/with-postcss-rtl