Skip to content

README.md

Latest commit

 

History

History
82 lines (59 loc) · 2.28 KB

README.md

File metadata and controls

82 lines (59 loc) · 2.28 KB

UUI

Universal Utility-first React UI Library

Storybook

UUI is still heavily under development. Specifications and Usage might change in the future and, as of now, no backwards compatibility is guaranteed!

English | 简体中文

Features

  • A set of useful components out of the box.
  • TypeScript based full type safety.
  • Highly customizable.

Installation

npm install @hackplan/uui --save
yarn add @hackplan/uui

Usage

import '@hackplan/uui/lib/index.css';
import { Button } from '@hackplan/uui';

function App() {
  return (
    <div>
      <Button>Click me!</Button>
    </div>
  )
}

Links

Development

For the development of this project, Yarn is preferred over npm. However, any Yarn command can be replaced by the npm equivalent.

git clone https://github.com/HackPlan/UUI.git
cd uui
nvm use
yarn
yarn storybook

Open your browser and visit http://localhost:6006 .

Contributing

We welcome all contributions. Please read CONTRIBUTING.md first.

Licenses

All files on the UUI GitHub repository are subject to the MIT license. Please read the License file at the root of the project.