Skip to content

Latest commit

 

History

History
210 lines (174 loc) · 24.6 KB

README-zh.md

File metadata and controls

210 lines (174 loc) · 24.6 KB

uiw LOGO

Buy me a coffee Github Actions License MIT jest Open in Gitpod
Github Releases npm version Github Stars

uiw document website

uiw

一个高质量的 UI 工具包,一个 React 16+ 的组件库。 💘

安装

npm install uiw --save

你可以使用 kkt 快速创建一个 react + uiw 的项目。

npx create-kkt my-app -e uiw
# or npm
$ npm create kkt my-app -e uiw
# or yarn
$ yarn create kkt my-app -e uiw

您可以使用 uiw v1.x 版本。 请在此处查看文档。(npx 需要 npm 5.2+ 及更高版本。)

基本使用

import React from "react";
import ReactDOM from "react-dom";
import { Button } from "uiw";

ReactDOM.render(
  <Button type="primary">Hello</Button>,
  document.getElementById("app")
);

文档

有关更多信息,请访问 uiwjs.github.io 网站。

或者在 VSCode 使用 vscode-uiw 插件预览中打开:

Open in VSCode

依赖包

这个 git 仓库是一个使用 Lerna 构建的仓库。它包含以下一些软件包:

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

开发

使用 GitpodGitHub 的免费在线开发环境。

Open in Gitpod

或者在本地克隆:

$ git clone git@github.com:uiwjs/uiw.git

安装依赖 & 编译组件代码

$ npm install # Install dependencies

$ npm run hoist
$ npm run 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

文件夹说明:

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

发布版本

当前工程目前通过 git tag 触发 GitHub Workflow 自动发布到 npm 包管理平台中

Contributors

License

Licensed under the MIT License.