Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 1.7 KB

README.md

File metadata and controls

69 lines (49 loc) · 1.7 KB

LUI (Landbot UI) ✨

GitHub license npm version Build Stoybook link

What is a UI components library?

A UI component library is a robust set of ready-made UI components such as buttons, inputs, dialogs, scrolling lists, and more.

Preparation and prerequisites

npm install

Start the component explorer

npm run storybook

For more information about Storybook, please visit the Storybook website.

Test

Component tests are written using Jest and React Testing Library.

npm run test

Build

Package is built using Rollup. The build is configured to generate an ES module (esm) package.

npm run build

Installation and usage

npm install @landbot/lui

Import on the root of the project

import { ThemeProvider } from 'styled-components';
import { theme } from '@landbot/lui';

Wrap the project with the provider

const App = () => {
  return (
    <ThemeProvider theme={theme}>
      <div className="App">//react app</div>
    </ThemeProvider>
  );
};