Link-Kou/rsuite

🧱 A suite of React components .

English | 中文版

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

• Supports React 16 +
• Supports TypeScript
• Supports Electron
• Supports Reason

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

• Quick start
• Customizing themes
• Internationalization
• Right-to-left
• Components

Previous old version

• Version 3.*
• Version 2.*

Examples

• Management system
• Use modularized
• Use CDN
• Internationalization
• Themes
• RTL - RTLCSS
• RTL - PostCSS-RTL
• Use in create-react-app
• Use in Electron
• Use in Flow
• Use in TypeScript
• Use in Next.js
• Use in UmiJS

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

2. Install it and run

$ npm install
$ npm run tdd

3. 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

2. Install it and run

$ cd rsuite
$ npm install
$ cd rsuite/docs
$ npm install
$ npm run dev

3. Your show time. Open url http://127.0.0.1:3000/ 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.

License

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