RSG-Group/rsg-components

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# RSG-Components

## Badges

[![js-standard-style](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)

[![RSG Slack Team](https://rsg-slack.herokuapp.com/badge.svg)](https://rsg-slack.herokuapp.com)

### Dependencies

[![dependencies Status](https://david-dm.org/RSG-Group/rsg-components/status.svg?style=flat-square)](https://david-dm.org/RSG-Group/rsg-components) [![devDependencies Status](https://david-dm.org/RSG-Group/rsg-components/dev-status.svg?style=flat-square)](https://david-dm.org/RSG-Group/rsg-components?type=dev) [![peerDependencies Status](https://david-dm.org/RSG-Group/rsg-components/peer-status.svg?style=flat-square)](https://david-dm.org/RSG-Group/rsg-components?type=peer)

### Coverage and Linting

[![Code Climate](https://img.shields.io/codeclimate/github/RSG-Group/rsg-components.svg?style=flat-square)](https://codeclimate.com/github/RSG-Group/rsg-components) [![Code Climate](https://img.shields.io/codeclimate/issues/github/RSG-Group/rsg-components.svg?style=flat-square)](https://codeclimate.com/github/RSG-Group/rsg-components)

### Miscellaneous

[![npm](https://img.shields.io/npm/dm/rsg-components.svg?style=flat-square)](http://npmjs.com/package/rsg-components) [![npm](https://img.shields.io/npm/v/rsg-components.svg?style=flat-square)](http://npmjs.com/package/rsg-components) [![npm (tag)](https://img.shields.io/npm/v/rsg-components/next.svg?style=flat-square)](http://npmjs.com/package/rsg-components) [![npm](https://img.shields.io/npm/l/rsg-components.svg?style=flat-square)](http://npmjs.com/package/rsg-components) [![license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)]()

Install via npm.

```zsh
npm install rsg-components
```

Install via yarn, a futuristic package manager.

```zsh
yarn add rsg-components
```

or clone the repository!

```zsh
git clone https://github.com/RSG-Group/rsg-components
```

## Compatibility

- Firefox > 31
- Chrome > 37
- IE < 11 unsupported.
- Versions of Safari newer than 2014-15 supported.
- Microsoft Edge supported.
- Supports Opera versions which use Blink.

## Example

```jsx
import { render } from "react-dom";
import React from "react";
import { Checkbox } from "rsg-components";

render(<Checkbox props>children</Checkbox>, document.getElementById("app"));
```

An example in Next.js w/ aphrodite-jss is in `example/`.

Run `yarn` or `npm i` here, then run `yarn build-example` or `npm run build-example`.

Then run `yarn` and then `yarn dev` (or `npm i` and then `npm run dev` if you use npm) inside the `example` folder to run the example.


View all components, props and styles on the GitHub wiki page: [https://github.com/RSG-Group/rsg-components/wiki/](https://github.com/RSG-Group/rsg-components/wiki/)

## [Tutorial on YouTube by @radi-cho](https://www.youtube.com/playlist?list=PLBKNj-_iswgrl1XNhpfgGKwfrP_hEoZ2x)

### [Link to channel here.](https://www.youtube.com/c/RadiCho)