rsuite: A TypeScript repository from wrilong

English | 中文版

React Suite is a set of react component libraries for enterprise system products. Built by HYPERS front-end team and UX team, mainly serving company's big data products.

After three major revisions, a large number of components and rich functionality have been accumulated.

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

Supports React 16 +
Supports TypeScript
Supports Electron

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

China Mirror 🇨🇳

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

You can learn about our development plan through Trello and hope that you can get involved.

Fork https://github.com/rsuite/rsuite this repo.

$ git clone git@github.com:<YOUR NAME>/rsuite.git
$ cd rsuite
$ npm install
$ npm run dev

Fork https://github.com/rsuite/rsuite.github.io this repo.

$ git clone git@github.com:<YOUR NAME>/rsuite.github.io.git
$ cd rsuite.github.io
$ npm install
$ npm run dev

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

Starring this repo
Leaving a comment here if you are using React Suite in your project (like we do 😄)
Becoming a backer on OpenCollective

This project exists thanks to all the people who contribute.

wrilong/rsuite