React implementation of the Tabler Dashboard UI Kit
Demo | Documentation | Issues | Slack.
Please note: we're working fast towards version 1.0 and until then all releases should be considered unstable and potentially breaking
Make sure you have Node.js 8+ and npm installed.
npm install --save tabler-react
or yarn add tabler-react
import React, { Component } from "react";
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
There are plenty of opputunities to get involved. 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 based demo website
To setup and run a local copy:
- Clone this repo with
git clone https://github.com/tabler/tabler-react
- Run
yarn
ornpm install
in the root folder - Run
yarn
ornpm install
in the example folder - 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.
MIT © jonthomp, AaronCoplan and the contributors.