npm:uiw | Skypack

README

uiw

The official documentation site for uiw. A high quality UI Toolkit, A Component Library for React 16+. 💘

Installation

npm install uiw --save

You can use kkt to quickly create a react + uiw project.

npx create-kkt my-app -e uiw

You can use the uiw v1.x version. Please see here for instructions. (npx comes with npm 5.2+ and higher.)

Basic Usage

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 website for more information.

Or Open in VSCode Preview :

Packages

This git repository is a repo built using Lerna. It contains several packages:

Package	Version	Description
`uiw`		-
`@uiw/formatter`		-
`@uiw/react-affix`		-
`@uiw/react-alert`		-
`@uiw/react-avatar`		-
`@uiw/react-back-top`		-
`@uiw/react-badge`		-
`@uiw/react-breadcrumb`		-
`@uiw/react-button`		-
`@uiw/react-button-group`		-
`@uiw/react-calendar`		-
`@uiw/react-card`		-
`@uiw/react-checkbox`		-
`@uiw/react-collapse`		-
`@uiw/react-copy-to-clipboard`		-
`@uiw/react-date-input`		-
`@uiw/react-date-picker`		-
`@uiw/react-descriptions`		-
`@uiw/react-divider`		-
`@uiw/react-drawer`		-
`@uiw/react-dropdown`
`@uiw/react-empty`		-
`@uiw/react-file-input`		-
`@uiw/react-form`		-
`@uiw/react-grid`		-
`@uiw/react-icon`		-
`@uiw/react-input`		-
`@uiw/react-layout`		-
`@uiw/react-list`		-
`@uiw/react-loader`		-
`@uiw/react-menu`		-
`@uiw/react-message`		-
`@uiw/react-modal`		-
`@uiw/react-month-picker`		-
`@uiw/react-notify`		-
`@uiw/react-overlay`		-
`@uiw/react-overlay-trigger`		-
`@uiw/react-pagination`		-
`@uiw/react-pin-code`		-
`@uiw/react-popover`		-
`@uiw/react-portal`		-
`@uiw/react-progress`		-
`@uiw/react-radio`		-
`@uiw/react-rate`		-
`@uiw/react-search-select`		-
`@uiw/react-select`		-
`@uiw/react-split`		-
`@uiw/react-slider`		-
`@uiw/react-steps`		-
`@uiw/react-switch`		-
`@uiw/react-table`		-
`@uiw/react-tabs`		-
`@uiw/react-tag`		-
`@uiw/react-textarea`		-
`@uiw/react-time-picker`		-
`@uiw/react-tooltip`		-
`@uiw/react-tree`		-
`@uiw/react-tree-checked`		-
`@uiw/utils`		-

Development

Use Gitpod, a free online dev environment for GitHub.

Or clone locally:

$ git clone https://github.com/uiwjs/uiwjs.github.io.git --recurse-submodules

Install dependencies & compile component code.

$ npm install # Install dependencies

$ npm run hoist
$ npm run build

To develop, run the self-reloading build:

# 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

├── LICENSE
├── README.md
├── package.json
├── website
│   ├── uiw        # Documentation website source code
└── packages
    ├── uiw        # Component library source code
    ├── react-alert
    ├── react-tree
    ├── ...
    └── react-affix

Contributors

License

Licensed under the MIT License.

Usage no npm install needed!