# react-win-ui

Latest version **0.3.5** (published 2021-09-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install react-win-ui
pnpm add react-win-ui
yarn add react-win-ui
bun add react-win-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.3.5 |
| Published | 2021-09-26 |
| First published | 2021-08-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 47.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gabriel José de Oliveira |
| Maintainers | gaoliveira21 |

## Links

- npm: https://www.npmjs.com/package/react-win-ui
- Homepage: http://gaoliveira21.github.io/react-win-ui
- npm.io page: https://npm.io/package/react-win-ui

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^17.0.2
- [react-dom](https://npm.io/package/react-dom.md) ^17.0.2
- [react-icons](https://npm.io/package/react-icons.md) ^4.2.0
- [styled-components](https://npm.io/package/styled-components.md) ^5.3.0

## Recent versions

- 0.3.5 (latest) — 2021-09-26
- 0.3.4 — 2021-09-26
- 0.3.2 — 2021-09-26
- 0.3.1 — 2021-09-25
- 0.3.0 — 2021-09-25
- 0.1.1 — 2021-09-25
- 0.1.0 — 2021-08-22

## README

<img src="./.github/assets/thumbnail.png">

## React Windows UI

:art: UI Kit built with React based on [Windows UI](https://www.figma.com/community/file/989931624019688277)

## 📦 How to install

To use React Win UI, you just need to install the react-win-ui package:

```bash
$ yarn add react-win-ui

# or

$ npm i react-win-ui
```

## 🔨 Usage

To start using the components you need to wrap your application with the `ThemeProvider` provided by react-win-ui

```javascript
import { ThemeProvider } from 'react-win-ui'

// Do this at the root of your application
function App({ children }) {
  return <ThemeProvider>{children}</ThemeProvider>
}
```

## :memo: Looking for the documentation?

online demo: https://gaoliveira21.github.io/react-win-ui

## :construction_worker: Developer guide

### :clipboard: Requirements

- [NodeJS LTS](https://nodejs.org/en/)

### :notebook: How to run

```bash
# Clone this repo
$ git clone <git@github.com:gaoliveira21/react-win-ui.git>

# Go to the project folder
$ cd react-win-ui

# Install dependencies
$ npm i

# Start storybook server
$ npm run docs:start

By default the server starts at port:3000
```

### :hammer_and_wrench: Development tools

- :atom: [ReactJS](https://pt-br.reactjs.org/)
- :collision: [TypeScript](https://www.typescriptlang.org/)
- :books: [Storybook](https://storybook.js.org/)
- :pill: [Jest](https://jestjs.io/pt-BR/)
- :bookmark: [React Testing Library](https://testing-library.com/docs/react-testing-library/intro)
- :pencil2: [Styled Components](https://styled-components.com/)

### :construction_worker: Built by:

<table>
  <tr>
    <td align="center"><a href="https://github.com/gaoliveira21"><img style="border-radius: 50%;" src="https://github.com/gaoliveira21.png" width="100px" alt="Foto de perfil do Github"/><br /><sub><b>Gabriel Oliveira</b></sub></a><br /></td>
  </tr>
</table>

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