rsuite

by rsuite

rsuite / rsuite

🧱 A suite of React components .

4.8K Stars 420 Forks Last release: 4 months ago (4.8.0) MIT License 1.7K Commits 94 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

React Suite logo

English | 中文版

npm GitHub Actions 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, 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 [email protected]:/rsuite.git
$ cd rsuite
  1. Install it and run
$ npm i
$ 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 [email protected]:/rsuite.git
  1. Install it and run
$ npm i
$ npm run dev
  1. 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

This project exists thanks to all the people who contribute.

License

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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.