Skip to content
/ ui Public
forked from lidofinance/ui

React UI Components for Lido projects.

License

Notifications You must be signed in to change notification settings

Gaurav1327/ui

Repository files navigation

Lido UI Components

React components for Lido Finance projects.

Check out our Storybook at https://ui.lido.fi

Getting Started

Simply add lido-ui to your dependencies:

yarn add @lidofinance/lido-ui

Then, import Lido theme provider and wrap your components in _app.js:

import { ThemeProvider } from '@lidofinance/lido-ui'

function App({ Component }) {
  return (
    <ThemeProvider>
      <Component />
    </ThemeProvider>
  )
}

Usage

Simply import any components and use in your project:

import { Button } from '@lidofinance/lido-ui'

Developing

  • yarn dev - Start Storybook locally to start developing components.
  • yarn build - Build all components.
  • yarn build:package package_name - Build package_name component (not working now, use yarn build).
  • yarn test - Run tests across components.
  • yarn lint - Run eslint across components.

Publishing

Packages are automatically published to npm when you push to master. The publication is based on semantic-release and @qiwi/multi-semantic-release.

For correct version detection, please follow the conventional commit format.

Linking

To include a local version of modified lido in your project, run yarn link in packages/lido and run yarn link lido in project you want to use it in. Make sure to run yarn unlink lido after it's no longer needed.

About

React UI Components for Lido projects.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 96.9%
  • JavaScript 2.9%
  • Other 0.2%