Go Main page
Go Main page

Web components

cover

get started

Installation

v.1.0.0 | Saturn

Installation

Run one of the following commands to add Kubit web-components to your project:

With npm

1
npm install @kubit-ui-web/react-components

With yarn

1
yarn install @kubit-ui-web/react-components

For additional available options, please refer to NPM.

You can also check the Changelog to see the latest changes, and the releases notes to see the latest features and bug fixes.

Peer dependencies

Please note that react, react-dom and styled-components are peer dependencies too, so they are also required in your project:

React

Required:

1
react: ^18.0.0

Install it with:

1
yarn add react | npm install react

More info about React here.

React-dom

Required:

1
react-dom: ^18.0.0

Install it with:

1
yarn add react-dom | npm install react-dom

More info about React-dom here.

Styled-components

Required:

1
styled-components: ^6.0.0

Install it with:

1
yarn add styled-components | npm install styled-components

More info about Styled-components here.

Run storybook

If you dowload the fully repository from GitHub you can run the storybook to see all the components and their documentation.

Once you have installed the dependencies, run one of the following commands:

1
yarn run storybook | npm run storybook

This will start the storybook server on port localhost:6006.

More info about Storybook here.

System Requirements

  • Node.js 16.4 or later.