An open API service indexing awesome lists of open source software.

https://github.com/einride/ui

Reusable React components that adhere to Einride's design system.
https://github.com/einride/ui

components library maps react typescript ui

Last synced: 10 months ago
JSON representation

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

Awesome Lists containing this project

README

          

# @einride/ui

[![license](https://img.shields.io/npm/l/@einride/ui.svg)](https://github.com/einride/ui/blob/master/LICENSE)
[![npm version](https://img.shields.io/npm/v/@einride/ui.svg)](https://www.npmjs.com/package/@einride/ui)
[![total npm downloads](https://img.shields.io/npm/dt/@einride/ui.svg)](https://www.npmjs.com/package/@einride/ui)

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

## Installation

Install `@einride/ui` together with its peer dependencies:

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

## Setup

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

```tsx
import { EinrideProvider } from "@einride/ui"

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

## Contribute

See [Contributing Guide](./CONTRIBUTING.md).

## Documentation

All currently available components are documented in our
[Storybook](https://storybook.einride.tech/).

## License

MIT