rsuite

<img src="https://user-images.githubusercontent.com/1203827/65102389-7be3f100-d9fd-11e9-859e-ae9617ed2f91.png" alt="React Suite logo">

English | 中文版readm-cn
!npmnpm-svgnpm-home !GitHub Actionsactions-svgactions-home !npm bundle sizenpm-bundle-size-imgnpm-bundle-size !rsuite.min.jsrsuite-min-js-imgrsuite-min-js !codecovcodecov-imgcodecov !Discorddiscord-svgdiscord-invite !Gittergitter-svggitter !Gittergitter-cn-svggitter-cn !Gitpod ready-to-codegitpod-imggitpod
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 viewrsuite-design.

Supported Platforms

Browser

React Suite supports the latest, stable releases of all major browsers and platforms. IE<=10 is no longer supported since React Suite 5.0. React Suite is designed and implemented for use on modern desktop browsers rather than mobile browsers.
| IE | Edge | Firefox | Chrome | Safari | | ---- | ---- | ------- | ------ | ------ | | >=11 | >=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 packagenpm-home.

npm i rsuite --save

or if you prefer Yarn

yarn add rsuite

Usage

Here's a simple example

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

function App() {
  return <Button appearance="primary">Hello World</Button>;
}

Live preview on CodeSandboxlive-preview-on-codesandbox

Documentation

You can go through full documentationrsuite-doc-guide or start with following sections

• Quick startrsuite-doc-guide
• Less Customizationrsuite-doc-guide-themes
• Internationalizationrsuite-doc-guide-intl
• Right-to-leftrsuite-doc-guide-rtl
• Componentsrsuite-components-overview

More examples

• Management systemdemo-admin
• Use modularizeddemo-modular-import
• Use CDNdemo-cdn
• Internationalizationdemo-intl-app
• Themesdemo-multiple-themes
• RTL - RTLCSSdemo-rtlcss
• RTL - PostCSS-RTLdemo-postcss-rtl
• Use in create-react-appdemo-create-react-app
• Use in Electrondemo-electron
• Use in Flowdemo-flow-app
• Use in TypeScriptdemo-typescript-app
• Use in Next.js (App)demo-nextjs-app
• Use in Next.js (Pages)demo-nextjs-pages
• Use in UmiJSdemo-umi-app
• Use in Snowpackdemo-snowpack
• Use in Vitedemo-vite

Previous major versions

The previous major version 4.x will no longer receive new features, and it is recommended to upgrade to the latest 5.x releases. Bug fixes for 4.x are still being supported for a period of time, and security fixes are supported until 6.x is in progress.

Documentations for previous major versions

• 4.x documentation
• 3.x documentation

Changelog

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

Contribution

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

Supporting React Suite

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

• Starring this repo
• Leaving a comment hereissues-11 if you are using React Suite in your project (like we do :smile:)
• Becoming a backeropencollective-home on OpenCollective

This project exists thanks to all the people who contribute.

!opencollective-nowopencollective-svgopencollective-home

License

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