# @platformbuilders/react-ui

> Platform Builders Shared Components Library For React Web

Latest version **0.1.0** (published 2020-09-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @platformbuilders/react-ui
pnpm add @platformbuilders/react-ui
yarn add @platformbuilders/react-ui
bun add @platformbuilders/react-ui
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2020-09-18 |
| First published | 2020-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 94.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Platform Builders |
| Maintainers | dev-builders |
| Keywords | platformbuilders, react, react-ui |

## Links

- npm: https://www.npmjs.com/package/@platformbuilders/react-ui
- Repository: https://github.com/platformbuilders/react-ui
- Homepage: https://github.com/platformbuilders/react-ui#readme
- Issues: https://github.com/platformbuilders/react-ui/issues
- npm.io page: https://npm.io/package/@platformbuilders/react-ui

## Dependencies (9)

- [react](https://npm.io/package/react.md) ^16.13.1
- [formik](https://npm.io/package/formik.md) ^2.1.5
- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [polished](https://npm.io/package/polished.md) ^3.6.6
- [react-lottie](https://npm.io/package/react-lottie.md) ^1.2.3
- [react-input-mask](https://npm.io/package/react-input-mask.md) ^2.0.4
- [react-router-dom](https://npm.io/package/react-router-dom.md) ^5.2.0
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.11.0
- [@platformbuilders/helpers](https://npm.io/package/@platformbuilders/helpers.md) ^0.3.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2020-09-18
- 0.0.3 — 2020-08-11
- 0.0.2 — 2020-07-19
- 0.0.1 — 2020-07-19

## README

# @platformbuilders/react-ui

[![Build Status][check-badge]][workflows]
[![npm][npm-badge]][npm]
[![MIT][license-badge]][license]

[npm-badge]: https://img.shields.io/npm/v/@platformbuilders/react-ui.svg
[npm]: https://www.npmjs.com/package/@platformbuilders/react-ui
[license-badge]: https://img.shields.io/dub/l/vibe-d.svg
[license]: https://raw.githubusercontent.com/platformbuilders/react-ui/master/LICENSE.md
[workflows]: https://github.com/platformbuilders/react-ui/actions
[check-badge]: https://github.com/platformbuilders/react-ui/workflows/check/badge.svg

Welcome to the @platformbuilders/react-ui package here you will find out all of our components shared with the community

# Whats the idea of this repository

Its a place that we can share a little bit of our code base and show how we work on our projects with our components!

# How can i use the library?

Here's how you add our dependencie to your project @platformbuilders/react-ui

1. depend on it:

```bash
yarn add @platformbuilders/react-ui
```

2. import the ThemeProvider from [styled-components](https://styled-components.com/docs/advanced) and provide the Theme following the ThemeType definition.

```jsx
import { ThemeProvider } from 'styled-components';
import { ThemeType } from '@platformbuilders/react-ui';

const theme: ThemeType = { ... };

<ThemeProvider theme={theme}>
  <App />
</ThemeProvider>
```

3. use it

```jsx
import { Button } from '@platformbuilders/react-ui';
```

---
_Source: https://npm.io/package/@platformbuilders/react-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
