README.md

React Rainbow

React Rainbow is a collection of components that will reliably help you build your application in a snap. Give it a hack and let us know what you think.

✨ Features

• 90+ components built on top of React.
• Interactive Examples.
• First class testing.
• Wdio page objects.
• Redux-Form integration.
• We designed each component with i18n in mind.
• Accessibility is part of our definition of done.
• Components with out-of-the-box Typescript typing.

🖥 Environment Support

Firefox	Chrome	Safari
last 2 versions	last 2 versions	last 2 versions

📦 Installation

React Rainbow Components is available as an npm package.

$ yarn add react-rainbow-components

or

$ npm install react-rainbow-components --save

⌨️ Usage

Here is a quick example to get you started. It's all you need:

import React from 'react';
import ReactDOM from 'react-dom';
import { Button } from 'react-rainbow-components';

function App() {
    return <Button label="Hello World!" variant="brand" onClick={() => alert('Hello World!')} />;
}

ReactDOM.render(<App />, document.getElementById('container'));

Yes, it's really all you need to get started as you can see in this live and interactive demo:

You can also use individual component from bit:

import React from 'react';
import ReactDOM from 'react-dom';
import Button from '@bit/nexxtway.react-rainbow.button';

function App() {
    return <Button label="Hello World!" variant="brand" onClick={() => alert('Hello World!')} />;
}

ReactDOM.render(<App />, document.getElementById('container'));

⌨️ Running locally

1. git clone https://github.com/nexxtway/react-rainbow.git
2. cd react-rainbow
3. yarn install
4. yarn start
5. navigate to http://localhost:6060/

💬 Questions

For how-to questions and other non-issues, please use our Gitter Chat instead of Github issues.

https://gitter.im/react-rainbow-components/community

🖥 Examples

Are you looking for an example project to get started?

We host some here.

🤝 Contributing

We are excited that you are interested in contributing to this project!

You can help us improve React Rainbow Components, the first step to begin collaboration is to create an issue before submitting a pull request. It's always good to file an issue, so we can discuss the details of your approach or suggestion.

See more details about how to collaborate

⚖️ License

The MIT license governs your use of React Rainbow Components.