Skip to content
🧱 A suite of React components .
TypeScript JavaScript CSS HTML
Branch: master
Clone or download

Latest commit

1
Latest commit f29f7ef Apr 4, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update feature_request.md Dec 25, 2019
docs Fix #945 (#946) Apr 4, 2020
examples Added example for `Nav.Item` with `react-router-dom/link` (#909) Mar 19, 2020
src fix #910 (#923) Mar 26, 2020
test [chore] Improved HoC to support ref passing (#862) Mar 2, 2020
.babelrc.js Upgrade to typescirpt 3.7 (#721) Nov 12, 2019
.bithoundrc rm webpack-dev-server Feb 19, 2019
.codecov.yml Add .codecov.yml Jul 5, 2017
.coveralls.yml javscript set up for coveralls Aug 5, 2017
.editorconfig Update config Jul 3, 2017
.eslintignore Migrate from flow to typescript (#531) Jul 31, 2019
.eslintrc.js Update eslint and remove defalut value of `parentSelectable` in Casca… Jan 2, 2020
.gitignore `readOnly` props is passed to `accepter` via `FormControl` (#881) Mar 5, 2020
.prettierrc.js Migrate from flow to typescript (#531) Jul 31, 2019
.stylelintignore Migrate from flow to typescript (#531) Jul 31, 2019
.travis.yml Migrate from flow to typescript (#531) Jul 31, 2019
CHANGELOG-V3.md bump 4.0.0 Sep 9, 2019
CHANGELOG.md Bump 4.3.3 Mar 26, 2020
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md May 16, 2018
CONTRIBUTING.md Update docs Apr 13, 2018
CONTRIBUTING.zh-CN.md Update CONTRIBUTING.zh-CN.md Apr 26, 2018
LICENSE Update LICENSE Apr 2, 2019
README.md [docs]: Split chat in different languages Apr 1, 2020
README_zh.md [docs]: Split chat in different languages Apr 1, 2020
gulpfile.js Added build script for RTL CSS (#757) Nov 29, 2019
karma.conf.js [chore] Improved HoC to support ref passing (#862) Mar 2, 2020
package-lock.json Bump 4.3.3 Mar 26, 2020
package.json Bump 4.3.3 Mar 26, 2020
postcss.config.js update:Add gulp && complie the less files Apr 17, 2018
stylelint.config.js update:Reformat code style with prettier. (#184) Aug 29, 2018
tsconfig.json Migrate from flow to typescript (#531) Jul 31, 2019
tslint.json Fix eslint problem for 35c0baa May 17, 2019
webpack.config.js Migrate from flow to typescript (#531) Jul 31, 2019

README.md

React Suite logo

English | 中文版

npm Travis Coverage Status Discord Gitter Gitter

React Suite is a set of react component libraries for enterprise system products. It is a well-thought-out and developer-friendly UI framework.

UI Design

React Suite Design Prototype and specification, click to view.

Supported Platforms

Browser

React Suite supports the latest, stable releases of all major browsers and platforms. IE<=9 is no longer supported since React Suite 3.0. React Suite is designed and implemented for use on modern desktop browsers rather than mobile browsers.

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

Server

React Suite supports server side rendering. Support Next.js to build applications.

Supported development environment

Installation

React Suite is available as an npm package.

npm i rsuite --save

or if you prefer Yarn

yarn add rsuite

Usage

Here's a simple example

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

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

Live preview on CodeSandbox

Documentation

You can go through full documentation or start with following sections

Previous old version

Examples

Changelog

Detailed changes for each release are documented in the release notes.

Development

Test-Driven Development(TDD)

  1. Fork https://github.com/rsuite/rsuite this repo.
$ git clone git@github.com:<YOUR NAME>/rsuite.git
$ cd rsuite
  1. Install it and run
$ npm install
$ npm run tdd
  1. Run a single component test case.
$ M=Button npm run tdd

UI-Driven Development

  1. Fork https://github.com/rsuite/rsuite this repo.
$ git clone git@github.com:<YOUR NAME>/rsuite.git
  1. Install it and run
$ cd rsuite
$ npm install
$ cd rsuite/docs
$ npm install
$ npm run dev
  1. Your show time. Open url http://127.0.0.1:3200/ in browser.

Contribution

Make sure you've read the guidelines before you start contributing.

Editor preferences are available in the .prettierrc for easy use in common code editors. Read more and download plugins at https://prettier.io/.

Supporting React Suite

If you like React Suite, you can show your support by either

This project exists thanks to all the people who contribute.

License

React Suite is MIT licensed. Copyright (c) 2016-present, HYPERS.

You can’t perform that action at this time.