Skip to content

kununu/nukleus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

69efcd6 Â· Feb 20, 2021
Jul 12, 2019
Apr 6, 2020
Oct 9, 2020
Nov 26, 2018
Oct 9, 2020
Oct 7, 2020
May 3, 2019
Apr 6, 2020
Jun 9, 2017
Feb 5, 2019
Feb 5, 2019
Jan 10, 2019
Dec 6, 2016
Apr 24, 2018
May 3, 2019
Feb 5, 2019
Feb 25, 2019
Jul 2, 2019
Feb 20, 2021
Apr 24, 2018
Feb 5, 2019
Feb 20, 2021

Repository files navigation

nukleus


Welcome to kununu's collection of React UI components! These reusable components are designed and implemented to help build amazing products fast and easily.

Dependencies Dev dependencies Storybook

Features

  • Over 80% code coverage
  • Frequently updated
  • Wide range of form and UI components
  • Themeable

Setup


Install with npm or yarn

npm i nukleus
# OR
yarn add nukleus

Usage

You will need a module bundler that supports css modules. To do this with webpack (recommended) you can use something like this:

{
    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.

import Select from 'nukleus/dist/components/Select';
import TextField from 'nukleus/dist/components/TextField';

Or you can import and bundle all nukleus components via:

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.