File size: 2,912 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# Update - June 2019: Version 2
Alpha now available on NPM:
`npm install tabler-react@alpha`
`yarn add tabler-react@alpha`
Check out the latest progress and get involved on [this branch](https://github.com/tabler/tabler-react/tree/version-2), or add your thoughts and requests to [this issue](https://github.com/tabler/tabler-react/issues/458).
# Tabler React
> React implementation of the [Tabler Dashboard UI Kit](https://github.com/tabler/tabler)
[](https://www.npmjs.com/package/tabler-react)  [](https://greenkeeper.io/) [](http://commitizen.github.io/cz-cli/)
**[Demo](http://tabler-react.com)** | **[Documentation](http://tabler-react.com/documentation/)** | **[Issues](https://github.com/tabler/tabler-react/issues)** | **[Slack](https://tabler-ui.slack.com/messages/CA55LDVHU/)**.
## Install
Make sure you have [Node.js](https://nodejs.org/) 8+ and [yarn](https://yarnpkg.com) installed.
`yarn add tabler-react`
## Example
```jsx
import React, { Component } from "react";
import "tabler-react/dist/Tabler.css";
import { Card, Button } from "tabler-react";
class MyCard extends Component {
render() {
return (
<Card>
<Card.Header>
<Card.Title>Card Title</Card.Title>
</Card.Header>
<Card.Body>
<Button color="primary">A Button</Button>
</Card.Body>
</Card>
);
}
}
```
For more examples and documentation see the [demo website](http://tabler-react.com)
## Contributing
[There are plenty of opportunities to get involved](https://github.com/tabler/tabler-react/issues). Pick an outstanding task, let us know what you are working on and fire away with any questions.
The package is made up of 2 main folders:
- /src contains all the Tabler React components
- /example is our [create-react-app](https://github.com/facebook/create-react-app/) based demo website
To setup and run a local copy:
1. Clone this repo with `git clone https://github.com/tabler/tabler-react`
2. Run `yarn install` in the root folder
3. Run `yarn install` in the example folder
4. In seperate terminal windows, run `yarn start` in the root and example folders.
You should now be up and running with live browser reloading of the example website while you work on Tabler React components in the /src folder.
When you're done working on your changes, submit a PR with the details and include a screenshot if you've changed anything visually.
## License
MIT © [jonthomp](https://github.com/jonthomp), [AaronCoplan](https://github.com/AaronCoplan) and [the contributors](https://github.com/tabler/tabler-react/graphs/contributors).
|