| 1 | react-widgets
|
| 2 | =============
|
| 3 |
|
| 4 | [![NPM version][npm-image]][npm-url]
|
| 5 | [![Downloads][downloads-image]][downloads-url]
|
| 6 |
|
| 7 | An à la carte set of polished, extensible, and accessible form inputs built for React.
|
| 8 |
|
| 9 | __Demos and Documentation [here](http://jquense.github.io/react-widgets/)__
|
| 10 |
|
| 11 | ### Install
|
| 12 |
|
| 13 | `npm install react-widgets`
|
| 14 |
|
| 15 |
|
| 16 | ### Local development and contributing
|
| 17 |
|
| 18 | React widgets, uses a "monorepo" organization style for managing multiple npm packages
|
| 19 | in a single git repo. This is done through a [Yarn](https://yarnpkg.com/en/) feature called
|
| 20 | workspaces. To get everything setup and dependencies installed:
|
| 21 |
|
| 22 | - make sure you have the __latest__ version of yarn installed
|
| 23 | - run `yarn run bootstrap` in the repo root directory
|
| 24 |
|
| 25 | #### Running the doc site locally
|
| 26 |
|
| 27 | - Follow the steps above
|
| 28 | - switch to the `www` directory and run `yarn`
|
| 29 | - `yarn run develop` to start the site
|
| 30 |
|
| 31 | #### Running the storybook examples
|
| 32 | - follow the general install instructions
|
| 33 | - run `yarn start-dev`
|
| 34 |
|
| 35 | ### Old Browser Support
|
| 36 |
|
| 37 | The goal is to support IE9+, but it is difficult for me to test a wide variety of browsers so there is no guarantee it will work (patches welcome!).
|
| 38 |
|
| 39 | [npm-image]: https://img.shields.io/npm/v/react-widgets.svg?style=flat-square
|
| 40 | [npm-url]: https://npmjs.org/package/react-widgets
|
| 41 | [downloads-image]: http://img.shields.io/npm/dm/react-widgets.svg?style=flat-square
|
| 42 | [downloads-url]: https://npmjs.org/package/react-widgets
|