Compensa UI Kit

compensa.io React components library - Storybook

| IE / Edge | Firefox | Chrome | Safari | iOS Safari | Samsung | Opera | | --------- | --------- | --------- | --------- | --------- | --------- | --------- | | 18+ | last 4 versions| last 4 versions| 12.1+| last 2 versions| last 2 versions| last 2 versions

Installation

Install the component library

$ npm install @compensa/ui-kit

Usage

You can either import { Button } from "@compensa/ui-kit"; or you might want to import directly the component import Button from "@compensa/ui-kit/dist/Button";

You also need to import Main CSS file to your project import "@compensa/ui-kit/dist/main.css"

Storybook

We are using storybook in order to develop the components independently from any consumer. run this to build & run the storybook locally:

npm run storybook

the storybook will hosted on http://localhost:7007

Developing locally with your consumer application

When developing locally we are using a npm functionality called npm link, this allows us to work locally on our package and use it in a different project without publishing. This functionality basically overrides the npm mapping between package name to its repo, and points it to where the package is located locally.

Troubleshooting local development

• If you are using NVM, make sure both packages are using the same version.

• Because we are using react hooks and having react as a peerDependency - if you want to develop locally and encounter issues with "invalid hook call" See this github thread. The quick fix is in your webpack config file alias react to resolve the node_modules path

Go to the project's directory and run:

nvm use
npm unlink
npm link
npm start

Contributing

We welcome every contributor, please read the contribution guidelines before submitting a PR

Themes

We support theming from the library to the component level using css variables - for more info on theming please read the theme guidelines file

Release

Perform the following steps to release a new version:

• Bump the version in package.json
• Merge into origin/master
• Release the new version in the compensa-ui-kit