uiw
Version:
A high quality UI Toolkit, A Component Library for React 16+.
204 lines (169 loc) ⢠24.8 kB
Markdown
<p align="center">
<a href="https://uiwjs.github.io">
<img alt="uiw LOGO" width="150" src="https://raw.githubusercontent.com/uiwjs/uiw/92f189f53312f1177466f48991736f95f86da0a6/src/assets/logo-README.svg?sanitize=true">
</a>
</p>
<p align="center">
<a href="https://jaywcjlove.github.io/#/sponsor">
<img alt="Buy me a coffee" src="https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee">
</a>
<a href="https://github.com/uiwjs/uiw/actions">
<img alt="Github Actions" src="https://github.com/uiwjs/uiw/actions/workflows/deploy.yml/badge.svg">
</a>
<a href="https://github.com/uiwjs/uiw">
<img alt="License MIT" src="https://img.shields.io/dub/l/vibe-d.svg">
</a>
<a href="https://github.com/facebook/jest">
<img alt="jest" src="https://jestjs.io/img/jest-badge.svg">
</a>
<a href="https://gitpod.io/#https://github.com/uiwjs/uiw">
<img alt="Open in Gitpod" src="https://shields.io/badge/Open%20in-Gitpod-green?logo=Gitpod">
</a>
<br>
<a href="https://github.com/uiwjs/uiw/releases">
<img alt="Github Releases" src="https://img.shields.io/github/release/uiwjs/uiw.svg">
</a>
<a href="https://www.npmjs.com/package/uiw">
<img alt="npm version" src="https://img.shields.io/npm/v/uiw.svg">
</a>
<a href="https://github.com/uiwjs/uiw/stargazers">
<img alt="Github Stars" src="https://img.shields.io/github/stars/uiwjs/uiw.svg">
</a>
</p>
<p align="center">
<a href="https://uiwjs.github.io"><img alt="uiw document website" src="https://raw.githubusercontent.com/uiwjs/uiw/92f189f53312f1177466f48991736f95f86da0a6/src/assets/uiw-doc.png" /></a>
</p>
## uiw
The official documentation site for [`uiw`](https://github.com/uiwjs/uiw). A high quality UI Toolkit, A Component Library for React 16+. š
### Installation
```bash
npm install uiw --save
```
You can use [`kkt`](https://github.com/kktjs/kkt) to quickly create a react + uiw project.
```bash
npx create-kkt my-app -e uiw
```
You can use the [`uiw v1.x`](https://github.com/uiwjs/uiw/tree/v1) version. [Please see here for instructions](https://github.com/uiwjs/uiw/tree/v1). ([**npx**](https://github.com/npm/npm/releases/tag/v5.2.0) comes with npm `5.2+` and higher.)
### Basic Usage
```js
import React from "react";
import ReactDOM from "react-dom";
import { Button } from "uiw";
ReactDOM.render(
<Button type="primary">Hello</Button>,
document.getElementById("app")
);
```
### Documentation
Visit the [uiwjs.github.io](https://uiwjs.github.io) website for more information.
Or Open in VSCode Preview :
[](https://marketplace.visualstudio.com/items?itemName=uiw.uiw)
### Packages
This git repository is a repo built using [Lerna](https://github.com/lerna/lerna). It contains several packages:
Package | Downloads | Version | Description
----- | ----- | ----- | -----
[`uiw`](/packages/uiw) | [](https://www.npmjs.com/package/uiw) | [](https://www.npmjs.com/package/uiw) | -
[`@uiw/react-affix`](/packages/react-affix) | [](https://www.npmjs.com/package/@uiw/react-affix) | [](https://www.npmjs.com/package/@uiw/react-affix) | -
[`@uiw/react-alert`](/packages/react-alert) | [](https://www.npmjs.com/package/@uiw/react-alert) | [](https://www.npmjs.com/package/@uiw/react-alert) | -
[`@uiw/react-avatar`](/packages/react-avatar) | [](https://www.npmjs.com/package/@uiw/react-avatar) | [](https://www.npmjs.com/package/@uiw/react-avatar) | -
[`@uiw/react-back-top`](/packages/react-back-top) | [](https://www.npmjs.com/package/@uiw/react-back-top) | [](https://www.npmjs.com/package/@uiw/react-back-top) | -
[`@uiw/react-badge`](/packages/react-badge) | [](https://www.npmjs.com/package/@uiw/react-badge) | [](https://www.npmjs.com/package/@uiw/react-badge) | -
[`@uiw/react-breadcrumb`](/packages/react-breadcrumb) | [](https://www.npmjs.com/package/@uiw/react-breadcrumb) | [](https://www.npmjs.com/package/@uiw/react-breadcrumb) | -
[`@uiw/react-button`](/packages/react-button) | [](https://www.npmjs.com/package/@uiw/react-button) | [](https://www.npmjs.com/package/@uiw/react-button) | -
[`@uiw/react-button-group`](/packages/react-button-group) | [](https://www.npmjs.com/package/@uiw/react-button-group) | [](https://www.npmjs.com/package/@uiw/react-button-group) | -
[`@uiw/react-calendar`](/packages/react-calendar) | [](https://www.npmjs.com/package/@uiw/react-calendar) | [](https://www.npmjs.com/package/@uiw/react-calendar) | -
[`@uiw/react-card`](/packages/react-card) | [](https://www.npmjs.com/package/@uiw/react-card) | [](https://www.npmjs.com/package/@uiw/react-card) | -
[`@uiw/react-checkbox`](/packages/react-checkbox) | [](https://www.npmjs.com/package/@uiw/react-checkbox) | [](https://www.npmjs.com/package/@uiw/react-checkbox) | -
[`@uiw/react-collapse`](/packages/react-collapse) | [](https://www.npmjs.com/package/@uiw/react-collapse) | [](https://www.npmjs.com/package/@uiw/react-collapse) | -
[`@uiw/react-copy-to-clipboard`](/packages/react-copy-to-clipboard) | [](https://www.npmjs.com/package/@uiw/react-copy-to-clipboard) | [](https://www.npmjs.com/package/@uiw/react-copy-to-clipboard) | -
[`@uiw/react-date-input`](/packages/react-date-input) | [](https://www.npmjs.com/package/@uiw/react-date-input) | [](https://www.npmjs.com/package/@uiw/react-date-input) | -
[`@uiw/react-date-picker`](/packages/react-date-picker) | [](https://www.npmjs.com/package/@uiw/react-date-picker) | [](https://www.npmjs.com/package/@uiw/react-date-picker) | -
[`@uiw/react-descriptions`](/packages/react-descriptions) | [](https://www.npmjs.com/package/@uiw/react-descriptions) | [](https://www.npmjs.com/package/@uiw/react-descriptions) | -
[`@uiw/react-divider`](/packages/react-divider) | [](https://www.npmjs.com/package/@uiw/react-divider) | [](https://www.npmjs.com/package/@uiw/react-divider) | -
[`@uiw/react-drawer`](/packages/react-drawer) | [](https://www.npmjs.com/package/@uiw/react-drawer) | [](https://www.npmjs.com/package/@uiw/react-drawer) | -
[`@uiw/react-dropdown`](/packages/react-dropdown) | [](https://www.npmjs.com/package/@uiw/react-dropdown) | [](https://www.npmjs.com/package/@uiw/react-dropdown)
[`@uiw/react-empty`](/packages/react-empty) | [](https://www.npmjs.com/package/@uiw/react-empty) | [](https://www.npmjs.com/package/@uiw/react-empty) | -
[`@uiw/react-file-input`](/packages/react-file-input) | [](https://www.npmjs.com/package/@uiw/react-file-input) | [](https://www.npmjs.com/package/@uiw/react-file-input) | -
[`@uiw/react-form`](/packages/react-form) | [](https://www.npmjs.com/package/@uiw/react-form) | [](https://www.npmjs.com/package/@uiw/react-form) | -
[`@uiw/react-grid`](/packages/react-grid) | [](https://www.npmjs.com/package/@uiw/react-grid) | [](https://www.npmjs.com/package/@uiw/react-grid) | -
[`@uiw/react-icon`](/packages/react-icon) | [](https://www.npmjs.com/package/@uiw/react-icon) | [](https://www.npmjs.com/package/@uiw/react-icon) | -
[`@uiw/react-input`](/packages/react-input) | [](https://www.npmjs.com/package/@uiw/react-input) | [](https://www.npmjs.com/package/@uiw/react-input) | -
[`@uiw/react-list`](/packages/react-list) | [](https://www.npmjs.com/package/@uiw/react-list) | [](https://www.npmjs.com/package/@uiw/react-list) | -
[`@uiw/react-loader`](/packages/react-loader) | [](https://www.npmjs.com/package/@uiw/react-loader) | [](https://www.npmjs.com/package/@uiw/react-loader) | -
[`@uiw/react-menu`](/packages/react-menu) | [](https://www.npmjs.com/package/@uiw/react-menu) | [](https://www.npmjs.com/package/@uiw/react-menu) | -
[`@uiw/react-message`](/packages/react-message) | [](https://www.npmjs.com/package/@uiw/react-message) | [](https://www.npmjs.com/package/@uiw/react-message) | -
[`@uiw/react-modal`](/packages/react-modal) | [](https://www.npmjs.com/package/@uiw/react-modal) | [](https://www.npmjs.com/package/@uiw/react-modal) | -
[`@uiw/react-month-picker`](/packages/react-month-picker) | [](https://www.npmjs.com/package/@uiw/react-month-picker) | [](https://www.npmjs.com/package/@uiw/react-month-picker) | -
[`@uiw/react-notify`](/packages/react-notify) | [](https://www.npmjs.com/package/@uiw/react-notify) | [](https://www.npmjs.com/package/@uiw/react-notify) | -
[`@uiw/react-overlay`](/packages/react-overlay) | [](https://www.npmjs.com/package/@uiw/react-overlay) | [](https://www.npmjs.com/package/@uiw/react-overlay) | -
[`@uiw/react-overlay-trigger`](/packages/react-overlay-trigger) | [](https://www.npmjs.com/package/@uiw/react-overlay-trigger) | [](https://www.npmjs.com/package/@uiw/react-overlay-trigger) | -
[`@uiw/react-pagination`](/packages/react-pagination) | [](https://www.npmjs.com/package/@uiw/react-pagination) | [](https://www.npmjs.com/package/@uiw/react-pagination) | -
[`@uiw/react-pin-code`](/packages/react-pin-code) | [](https://www.npmjs.com/package/@uiw/react-pin-code) | [](https://www.npmjs.com/package/@uiw/react-pin-code) | -
[`@uiw/react-popover`](/packages/react-popover) | [](https://www.npmjs.com/package/@uiw/react-popover) | [](https://www.npmjs.com/package/@uiw/react-popover) | -
[`@uiw/react-portal`](/packages/react-portal) | [](https://www.npmjs.com/package/@uiw/react-portal) | [](https://www.npmjs.com/package/@uiw/react-portal) | -
[`@uiw/react-progress`](/packages/react-progress) | [](https://www.npmjs.com/package/@uiw/react-progress) | [](https://www.npmjs.com/package/@uiw/react-progress) | -
[`@uiw/react-radio`](/packages/react-radio) | [](https://www.npmjs.com/package/@uiw/react-radio) | [](https://www.npmjs.com/package/@uiw/react-radio) | -
[`@uiw/react-rate`](/packages/react-rate) | [](https://www.npmjs.com/package/@uiw/react-rate) | [](https://www.npmjs.com/package/@uiw/react-rate) | -
[`@uiw/react-search-select`](/packages/react-search-select) | [](https://www.npmjs.com/package/@uiw/react-search-select) | [](https://www.npmjs.com/package/@uiw/react-search-select) | -
[`@uiw/react-search-tree`](/packages/react-search-tree) | [](https://www.npmjs.com/package/@uiw/react-search-tree) | [](https://www.npmjs.com/package/@uiw/react-search-tree) | -
[`@uiw/react-select`](/packages/react-select) | [](https://www.npmjs.com/package/@uiw/react-select) | [](https://www.npmjs.com/package/@uiw/react-select) | -
[`@uiw/react-slider`](/packages/react-slider) | [](https://www.npmjs.com/package/@uiw/react-slider) | [](https://www.npmjs.com/package/@uiw/react-slider) | -
[`@uiw/react-steps`](/packages/react-steps) | [](https://www.npmjs.com/package/@uiw/react-steps) | [](https://www.npmjs.com/package/@uiw/react-steps) | -
[`@uiw/react-switch`](/packages/react-switch) | [](https://www.npmjs.com/package/@uiw/react-switch) | [](https://www.npmjs.com/package/@uiw/react-switch) | -
[`@uiw/react-table`](/packages/react-table) | [](https://www.npmjs.com/package/@uiw/react-table) | [](https://www.npmjs.com/package/@uiw/react-table) | -
[`@uiw/react-tabs`](/packages/react-tabs) | [](https://www.npmjs.com/package/@uiw/react-tabs) | [](https://www.npmjs.com/package/@uiw/react-tabs) | -
[`@uiw/react-tag`](/packages/react-tag) | [](https://www.npmjs.com/package/@uiw/react-tag) | [](https://www.npmjs.com/package/@uiw/react-tag) | -
[`@uiw/react-textarea`](/packages/react-textarea) | [](https://www.npmjs.com/package/@uiw/react-textarea) | [](https://www.npmjs.com/package/@uiw/react-textarea) | -
[`@uiw/react-time-picker`](/packages/react-time-picker) | [](https://www.npmjs.com/package/@uiw/react-time-picker) | [](https://www.npmjs.com/package/@uiw/react-time-picker) | -
[`@uiw/react-tooltip`](/packages/react-tooltip) | [](https://www.npmjs.com/package/@uiw/react-tooltip) | [](https://www.npmjs.com/package/@uiw/react-tooltip) | -
[`@uiw/react-tree`](/packages/react-tree) | [](https://www.npmjs.com/package/@uiw/react-tree) | [](https://www.npmjs.com/package/@uiw/react-tree) | -
[`@uiw/react-tree-checked`](/packages/react-tree-checked) | [](https://www.npmjs.com/package/@uiw/react-tree-checked) | [](https://www.npmjs.com/package/@uiw/react-tree-checked) | -
[`@uiw/utils`](/packages/utils) | [](https://www.npmjs.com/package/@uiw/utils) | [](https://www.npmjs.com/package/@uiw/utils) | -
**Package** | **Downloads** | **Version** | **Description**
[`@uiw/react-split`](https://github.com/uiwjs/react-split) | [](https://www.npmjs.com/package/@uiw/react-split) | [](https://www.npmjs.com/package/@uiw/react-split) | -
[`@uiw/react-layout`](https://github.com/uiwjs/react-layout) | [](https://www.npmjs.com/package/@uiw/react-layout) | [](https://www.npmjs.com/package/@uiw/react-layout) | -
[`@uiw/formatter`](https://github.com/uiwjs/date-formatter) | [](https://www.npmjs.com/package/@uiw/formatter) | [](https://www.npmjs.com/package/@uiw/formatter) | -
### Development
Use Gitpod, a free online dev environment for GitHub.
[](https://gitpod.io/#https://github.com/uiwjs/uiw)
Or clone locally:
```bash
$ git clone git@github.com:uiwjs/uiw.git
```
Install dependencies & compile component code.
```bash
$ npm install # Install dependencies
$ npm run hoist
$ npm run build
```
To develop, run the self-reloading build:
```bash
# Run the app
# Restart the app automatically every time code changes.
# Useful during development.
$ npm run lib:watch
$ npm run start
$ lerna run --scope uiw watch --stream
$ lerna exec --scope @uiw/button -- tsbb types --outDir lib/esm --target ESNEXT --watch
$ lerna exec --scope @uiw/button -- tsbb watch --target react --env-name esm:dev --env-name cjs
```
Folders
```bash
āāā LICENSE
āāā README.md
āāā package.json
āāā website
āĀ Ā āāā uiw # Documentation website source code
āāā packages
Ā Ā Ā āāā uiw # Component library source code
Ā Ā Ā āāā react-alert
Ā Ā Ā āāā react-tree
Ā Ā Ā āāā ...
Ā Ā Ā āāā react-affix
```
### Contributors
<a href="https://github.com/uiwjs/uiw/graphs/contributors">
<img src="https://uiwjs.github.io/uiw/CONTRIBUTORS.svg" />
</a>
### License
Licensed under the MIT License.