https://github.com/hackplan/uui

Universal Utility-first UI Library
https://github.com/hackplan/uui

react typescript ui ui-components utility-first wai-aria web

Last synced: about 2 months ago
JSON representation

Universal Utility-first UI Library

• Host: GitHub
• URL: https://github.com/hackplan/uui
• Owner: HackPlan
• License: mit
• Created: 2020-05-11T05:03:23.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-19T06:04:50.000Z (over 1 year ago)
• Last Synced: 2024-11-15T22:27:01.043Z (2 months ago)
• Topics: react, typescript, ui, ui-components, utility-first, wai-aria, web
• Language: TypeScript
• Homepage: https://doc.uui.cool
• Size: 5.65 MB
• Stars: 98
• Watchers: 9
• Forks: 9
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# UUI

Universal Utility-first React UI Library

![](https://img.shields.io/npm/v/@hackplan/uui)

![](https://img.shields.io/github/workflow/status/HackPlan/UUI/CI)

![](https://img.shields.io/david/HackPlan/UUI)

![](https://img.shields.io/david/dev/HackPlan/UUI)

![](https://img.shields.io/bundlephobia/minzip/@hackplan/uui)

![](https://img.shields.io/npm/dm/@hackplan/uui)

![](https://img.shields.io/github/contributors/HackPlan/UUI)

![](https://img.shields.io/github/issues-pr-raw/HackPlan/UUI)

![](https://img.shields.io/github/issues-raw/HackPlan/UUI)

![](https://img.shields.io/github/languages/top/HackPlan/UUI)

![](https://img.shields.io/github/license/HackPlan/UUI)

[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg)](https://doc.uui.cool/)

![components overview screenshot](https://raw.githubusercontent.com/HackPlan/UUI/master/assets/screenshots/overview.png)

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

English | [简体中文](https://github.com/HackPlan/UUI/blob/master/docs/README.zh-CN.md)

## Features

* A set of useful components out of the box.

* TypeScript based full type safety.

* Highly customizable.

* WAI-ARIA 1.2 compliance

## Installation

⚠️⚠️⚠️ UUI requires TypeScript 3.8 or higher. ⚠️⚠️⚠️

```bash

npm install @hackplan/uui --save

```

```bash

yarn add @hackplan/uui

```

## Usage

```tsx

import '@hackplan/uui/lib/index.css';

import { Button } from '@hackplan/uui';

function App() {

  return (

    


      Click me!

    

  )

}

```


## Links

* [Documentation](https://doc.uui.cool)

* [Introduction](https://github.com/HackPlan/UUI/blob/master/docs/INTRODUCTION.zh-CN.md)

* [Using Customize](https://github.com/HackPlan/UUI/blob/master/docs/USING_CUSTOMIZE.zh-CN.md)

* [Principle & Implementation](https://github.com/HackPlan/UUI/blob/master/docs/PRINCIPLE.md)

* [Contributing](https://github.com/HackPlan/UUI/blob/master/CONTRIBUTING.md)

* [Deployment](https://github.com/HackPlan/UUI/blob/master/docs/DEVELOPMENT.md)

* [Changelog](https://github.com/HackPlan/UUI/blob/master/CHANGELOG.md)

## Development

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

```bash

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.

## Products built with UUI

|  |  |  |

| :----------------------------------------------------------: | :----------------------------------------------------------: | ------------------------------------------------------------ |

|              [图压](https://tuya.xinxiao.tech/)              |               [多少记账](https://duoshao.app/)               | [昼间日历](https://daylight.cool/)                           |

## 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.