Use in create-react-app

create-react-app can help build a react project quickly, and this wizard will explain how to use rsuite in conjunction with create-react-app.

Install and Initialization

Before all start, you may need install yarn.

$ yarn create react-app test-app

After execution, the tool will automatically generate a react development scaffold and install all dependencies necessary to develop react. Execute after Setup completes

$ yarn start

Open the browser at http://localhost:3000/. It renders a header saying "Welcome to React" on the page.

Install rsuite

$ yarn add rsuite

And then edit ./src/App.js

  import React, { Component } from 'react';
- import logo from './logo.svg';
  import './App.css';

+ import 'rsuite/dist/styles/rsuite-default.css';
+ import { Button } from 'rsuite';

  class App extends Component {
    render() {
      return (
        <div className="App">
-         <header className="App-header">
-           <img src={logo} className="App-logo" alt="logo" />
-           <h1 className="App-title">Welcome to React</h1>
-         </header>
-         <p className="App-intro">
-           To get started, edit <code>src/App.js</code> and save to reload.
-         </p>
+         <Button appearance="primary"> Hello world </Button>

  export default App;

Then you'll see an accent button and now you can go ahead and develop.

If you encounter other problems, you can check create-react-app's official documentation.

Customize Theme

To use the custom theme feature, you must modify the default configuration of the create-react-app.

  1. Installation dependencies.
yarn add react-app-rewired customize-cra less less-loader
  1. Modify scripts in package.json
    "scripts": {
-     "start": "react-scripts start",
+     "start": "react-app-rewired start",
-     "build": "react-scripts build",
+     "build": "react-app-rewired build",
-     "test": "react-scripts test --env=jsdom",
+     "test": "react-app-rewired test --env=jsdom",
-     "eject": "react-scripts eject"
+     "eject": "react-app-rewired eject"
  1. Edit ./src/App.js
- import 'rsuite/dist/styles/rsuite-default.css';
+ import 'rsuite/lib/styles/index.less';
  import { Button } from 'rsuite';
  1. Create a new config-overrides.js in the root directory. The contents are as follows:
/* config-overrides.js */
const { override, addLessLoader } = require('customize-cra');

module.exports = override(
    // If you are using less-loader@5 or older version, please spread the lessOptions to options directly.
    lessOptions: {
      javascriptEnabled: true,
      modifyVars: { '@base-color': '#f44336' }

Re-executing yarn start, the red button is the configuration was successful

We uses react-app-rewired and customize-cra to implement custom themes with less-loader using modifyVars configuration. For more details, see Customize Theme.

Source code

πŸŽ‰ v5 is released! Head to the v5 documentation to get started.