# @sfx-ui/core

React UI components library by Scaleflex

---

## Installation

```shell script
npm i @sfx-ui/core # styled-components react react-dom
```

```shell script
yarn add @sfx-ui/core # styled-components react react-dom
```

> Make sure to have `react`, `react-dom` and `styled-components` installed in your package as they are included in our peer dependencies.

## Usage

`@sfx-ui/core` package implements different UI components under the SFX UI design system.
Every component is exported by default from its folder along with its props and, sometimes, some helper entities.

```typescript jsx
import Button from '@sfx-ui/core/button';

// ...

<Button color="primary">
  Download
</Button>
```