https://github.com/taitounited/react-components-kit
A collection of reusable and themable React UI components built with styled-components
https://github.com/taitounited/react-components-kit
react styled-components theme-support ui-components
Last synced: 12 months ago
JSON representation
A collection of reusable and themable React UI components built with styled-components
- Host: GitHub
- URL: https://github.com/taitounited/react-components-kit
- Owner: TaitoUnited
- Created: 2017-03-20T09:20:18.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-30T10:47:30.000Z (over 8 years ago)
- Last Synced: 2025-06-20T00:02:02.458Z (12 months ago)
- Topics: react, styled-components, theme-support, ui-components
- Language: JavaScript
- Homepage: https://taitounited.github.io/react-components-kit/
- Size: 5.65 MB
- Stars: 14
- Watchers: 12
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-components-kit
A collection of reusable and themable React UI components built with [styled-components](https://styled-components.com).
[](https://travis-ci.org/TaitoUnited/rreact-components-kit)
[](https://www.npmjs.com/package/react-components-kit)
[](https://opensource.org/licenses/MIT)
## Install
```
npm install --save react-components-kit
```
## Component showcase
Live demo available: https://taitounited.github.io/react-components-kit/
You can also test the components locally by cloning this repo and doing the following steps:
```
cd docs
npm install
npm start
```
And then open localhost:3000 in a browser.
## Usage
```javascript
import React from 'react';
// Import some components
import { Tooltip, Spinner } from 'react-components-kit';
const Example = () => {
return (
);
}
```
Check out the more detailed [documentation](src/README.md) describing the individual components
in more detail.
## Development
In order to get **react-components-kit** UI components to work in the docs project
you have to link the local npm package by first doing:
```
npm link
```
in the root of the project and then cd to `/docs` and do:
```
npm link react-components-kit
```
to add the package to node_modules in docs' create-react-app project.
Then you can start developing and continuously building your changes by running:
```
npm run watch:build:lib
```
This way you can easily test your changes in the docs pages.
After done with changes add them with:
```
git add .
```
and commit with
```
npm run commit
```
which uses [commitizen](https://github.com/commitizen/cz-cli)
helper to format the commit messages partly based on these [rules](https://gist.github.com/stephenparish/9941e89d80e2bc58a153).
This way [semantic-release](https://github.com/semantic-release/semantic-release)
knows how to bumb up the version number correctly when we finally push the code to master and Travis CI builds our package.
**Do not** force push to the repo, since that may break semantic-release.
You can see the Travis CI builds [here](https://travis-ci.org/TaitoUnited/react-components-kit)