Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.14 KB

README.md

File metadata and controls

41 lines (26 loc) · 1.14 KB

@einride/ui

license npm version total npm downloads

Reusable React components that adhere to Einride's design system.

Installation

Install @einride/ui together with its peer dependencies:

yarn add @einride/ui @emotion/react @emotion/styled framer-motion

Setup

<EinrideProvider> needs to wrap all @einride/ui components. The provider sets up the theme and color schemes. It's common to put it in the <App> component in the top of the component tree.

import { EinrideProvider } from "@einride/ui"

export const App = (): React.JSX.Element => {
  return <EinrideProvider>{/* All @einride/ui components go here! */}</EinrideProvider>
}

Contribute

See Contributing Guide.

Documentation

All currently available components are documented in our Storybook.

License

MIT