0.3.5 • Published 4 years ago

react-win-ui

Licence

ISC

Version

0.3.5

Deps

Size

48 kB

Vulns

Weekly

Summary Dependency Versions

React Windows UI

UI Kit built with React based on Windows UI

How to install

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

$ 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

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

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

Looking for the documentation?

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

Developer guide

Requirements

NodeJS LTS

How to run

# 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

Development tools

Built by:

_{Gabriel Oliveira}