https://github.com/kununu/nukleus
React UI components by @kununu
https://github.com/kununu/nukleus
react ui ui-components
Last synced: 2 months ago
JSON representation
React UI components by @kununu
- Host: GitHub
- URL: https://github.com/kununu/nukleus
- Owner: kununu
- Created: 2016-12-06T10:39:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-26T07:44:51.000Z (12 months ago)
- Last Synced: 2025-04-15T04:55:09.482Z (2 months ago)
- Topics: react, ui, ui-components
- Language: JavaScript
- Homepage: https://kununu.github.io/nukleus
- Size: 13.2 MB
- Stars: 14
- Watchers: 15
- Forks: 3
- Open Issues: 110
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
nukleus
Welcome to [kununu's](https://wwww.kununu.com) collection of [React](https://facebook.github.io/react/) UI components! These reusable components are designed and implemented to help build amazing products fast and easily.
[](https://david-dm.org/kununu/nukleus/master)
[](https://david-dm.org/kununu/nukleus/master?type=dev)
[](https://kununu.github.io/nukleus)
## Features
* Over 80% code coverage
* Frequently updated
* Wide range of form and UI components
* Themeable
## Setup
### Install with `npm` or `yarn`
```sh
npm i nukleus
# OR
yarn add nukleus
```
### Usage
You will need a module bundler that supports css modules. To do this with [webpack](https://webpack.js.org/) (recommended) you can use something like this:
```javascript
{
test: /\.css$/,
include: /nukleus/,
use: [
'style-loader',
'css-loader?modules&localIdentName=[name]---[local]---[hash:base64:5]',
{
loader: 'postcss-loader',
options: {
plugins: function () {
return [
require('autoprefixer')
];
}
}
},
]
}
```
Next you can import each compiled nukelus component seperately, which will help reduce your bundle size if you only require a few components.
```javascript
import Select from 'nukleus/dist/components/Select';
import TextField from 'nukleus/dist/components/TextField';
```
Or you can import and bundle all nukleus components via:
```javascript
import {Select, TextField} from 'nukleus';
```
## Contributing
Coming soon 🎉
## Test
In order to run the tests, run `npm run test`.
There could be two reasons why the tests are failing: either your component broke or was modified on purpose.
In the latter case, you will just need to update the snapshot as we use jest snapshot testing.