codecamp
快速上手

快速上手

Packagist Packagist jest

安装

使用 npm 或 yarn 安装

$ npm i uiw # 安装 v2.x.x 最新版本

$ yarn add uiw

浏览器引入

在浏览器中使用 scriptlink 标签直接引入文件,并使用全局变量 uiw。

我们在 npm 发布包内的 uiw/dist 目录下提供了 uiw.js uiw.css 以及 uiw.min.js uiw.min.css。你也可以通过 UNPKG 进行下载。

⚠️ 强烈不推荐使用已构建文件,这样无法按需加载。

⚠️ 浏览器引入只在 uiw v2.x 以上的版本支持。

安装 v1.x 旧版本

⚠️ v1.x 不可以升级到 v2.xv2是对 v1 的重构和简化

安装 v1.x 版本

npm install uiw --save


## 通过 GitHub 仓库安装
npm i -S uiwjs/uiw
## 指定版本
npm i -S uiwjs/uiw#v1.16.14
## 或者
yarn add uiwjs/uiw

通过 GitHub 仓库安装win 用户请在 Git Bash 下执行,因为需要用到 git

对新版本 v2.x 的更新内容

  1. 优化大部分组件,让组件变得更小更简单。
  2. 删除大部分组件冗余功能,直接使用样式就可以展现组件效果。
  3. 删除冗余组件,例如组件 Capsule 胶囊Tag 标签 组件合并。
  4. 抽离组件,需要单独安装,如 HeatMap 日历热图
  5. 支持服务端渲染,可以通过 kkt-ssr 工具建立实例。

使用

使用过程中不需要引入 CSS,但是需要 LESS 编译环境,如果对环境使用有障碍,可以通过 kkt 工具初始化一个工程。

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


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

组件冲突

重新取一个名字

import { Button as ButtonView } from 'uiw';

VSCode 中文档预览

组件文档可以在 VSCode 中预览,打开下面链接进行安装 VSCode 插件。

Open in VSCode

开发

使用 GitpodGitHub 的免费在线开发环境,点击打开下面链接,自动初始化项目,将开发环境跑起来。

Open in Gitpod

要开发,运行自重新构建,获取代码:

$ git clone https://github.com/uiwjs/uiw.git
$ cd uiw
$ npm install # or  yarn install

要开发,运行自重新构建,这里将要跑两个任务:

## Listening compiled component code.
$ cd ./packages/core
$ npm run watch

## Run the app
## Restart the app automatically every time code changes. 
## Useful during development.
$ cd ./
$ npm start

打开浏览器并访问:http://localhost:19870

文件目录说明

├── LICENSE
├── README.md
├── package.json
├── packages        # 组件源码
│   └── core
├── public          # Document the static file.
└── src             # D文档网站源码

License

Licensed under the MIT License.

在 Create React App 中使用
温馨提示
下载编程狮App,免费阅读超1000+编程语言教程
取消
确定
目录

关闭

MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }