安装 | uView

# 安装

说明

由于uView使用easycom模式，让您无需引入组件即可直接使用，但是此功能需要Hbuilder X 2.5.5及以上版本才支持，详见配置easycom组件模式。 easycom打包的时候是按需引入的，您可以放心引入uView的整个组件库，发布打包时会自动剔除您没有使用的组件(注意：调试时仍然是全部引入的)
请确保您下载的Hbuilder X (opens new window)为APP开发版，而非标准版，并且在"工具-插件安装"中安装了"scss/sass编译"插件

# 下载安装

使用下载的方式安装，能更方便阅读源码，但是每次升级都需要重新下载并覆盖uview-ui文件夹。

在uni-app插件市场右上角选择使用HBuilder X 导入插件或者下载插件ZIP
如果您的项目是由HBuilder X创建的标准uni-app项目，将下载后的uview-ui文件夹，复制到项目根目录。
如果您的项目是由vue-cli (opens new window)模式创建的，请将下载后的uview-ui文件夹放到项目的src文件夹中即可。

注意： 此安装方式必须要按照下载方式安装的配置中的说明配置了才可用。

下载地址：https://ext.dcloud.net.cn/plugin?id=6682 (opens new window)

# 示例项目

此方式为整个uView演示项目，里面有uView核心，组件演示，模板等，建议用户可以下载此项目运行用于查看UI演示效果，复制模板案例，通过里面的示例，可以快速掌握某一个组件的用法。

途径一：uView示例项目已内置到HBuilder X中，在文件 -> 新建 -> 项目 -> uni-app中，找到uView UI下载运行即可。
途径二：在uni-app插件市场右上角选择使用 HBuilderX 导入示例项目或者下载示例项目ZIP，然后在HBuilder X中运行即可。

uni-app插件市场地址：https://ext.dcloud.net.cn/plugin?id=6682 (opens new window)

注意

演示项目不适用于直接开发中，它只是演示用的，可以直接运行并查看效果。
如果在微信开发工具真机预览时，提示分包太大运行的问题，请在HBuilder X进行设置：菜单栏运行 -> 运行到小程序模拟器，在下拉菜单中勾选"运行时是否压缩代码"

# 空白项目

此方式为一个完整的uni-app示例工程(使用Hbuilder X创建，非vue-cli (opens new window)模式创建)，它适用于新启动的项目，其中已包含了uView，并且做好了所有配置，让您无需任何配置，开箱即用。

使用方法： 在资源下载页中找到"脚手架空白工程"下载解压，并在Hbuilder X中运行即可。

下载地址：http://uviewui.com/components/resource (opens new window)

# npm安装

使用npm的方式安装，能更方便进行升级。

如果您的项目是通过vue-cli (opens new window)模式创建的，无需手动npm安装scss，因为已内置scss。

注意： 此安装方式必须要按照npm方式安装的配置中的说明配置了才可用，且项目名称不能有中文字符。

注意！

由于HX编译错误的原因的，目前(2020-05-06)不支持通过cnpm安装uView，这意味着您只能通过npm安装uView，如果您的网络无法使用npm，那就使用下载的方式安装，等HX修复此问题，可以使用cnpm的时候，我们会撤销此通告。

# 安装

# 如果您的项目是HX创建的，根目录又没有package.json文件的话，请先执行如下命令：
# npm init -y

# npm方式安装
npm i @ued_fpi/uview-ui

# 更新
npm update uview-ui

# 快速上手之Vue2.0

即使是 Vue2 版本，同样比原版 uView1.0 做了一些优化，如（车牌号键盘点击1次中文后会自动切英文，倒计时支持毫秒等等）

支持：H5、App(vue)、微信小程序、支付宝小程序（其他小程序未测试）

1、main.js 引入 uview-ui

import uView from '@ued_fpi/uview-ui';
Vue.use(uView);

2、App.vue 引入基础样式（注意style标签需声明scss属性支持）

<style lang="scss">
	@import "@ued_fpi/uview-ui/index.scss";
</style>

3、uni.scss 引入全局 scss 变量文件

@import "@ued_fpi/uview-ui/theme.scss";

# 快速上手之Vue3.0

不建议把老项目升级到 Vue3.0 (升级非常麻烦，建议新项目才考虑是否使用Vue3.0)

支持：H5、App(vue)、微信小程序（其他小程序未测试）

目前发现Vue3 H5版本一个重大bug（与此UI框架无关），调试开发没问题，发布到前端托管时样式会错乱，已确定是HBX的问题，等待HBX修复此问题。（hbx3.3.0版本已修复此问题）

1、前置步骤：修改 manifest.json 内的 vue 版本为 vue3
2、项目根目录新增 index.html 文件，文件代码为

<!DOCTYPE html>
<html lang="zh-CN">
	<head>
		<meta charset="UTF-8" />
		<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0" />
		<title></title>
		<!--preload-links-->
		<!--app-context-->
		<!-- 配置H5的 web图标static/logo.png -->
		<link rel="icon" href="./static/logo.png" />
	</head>
	<body>
		<div id="app">
			<!--app-html-->
		</div>
		<script type="module" src="/main.js"></script>
	</body>
</html>

3、main.js 引入 uview-ui

// 引入 uView UI
import uView from '@ued_fpi/uview-ui';

import { createSSRApp } from 'vue'

export function createApp() {
  const app  = createSSRApp(App)
  
  // 使用 uView UI
  app.use(uView)
  
  return { app }
}

4、App.vue 引入基础样式（注意style标签需声明scss属性支持）

<style lang="scss">
	@import "@ued_fpi/uview-ui/index.scss";
</style>

5、uni.scss 引入全局 scss 变量文件

@import "@ued_fpi/uview-ui/theme.scss";

6、pages.json配置easycom规则(按需引入)

// pages.json
{
	"easycom": {
		// npm安装的方式不需要前面的"@/"，下载安装的方式需要"@/"
		// npm安装方式
		"^u-(.*)": "@ued_fpi/uview-ui/components/u-$1/u-$1.vue"
		// 下载安装方式，对应路径引入
		// "^u-(.*)": "@/uview-ui/components/u-$1/u-$1.vue"
	},
	// 此为本身已有的内容
	"pages": [
		// ......
	]
}

7、vue.config.js配置transpileDependencies

// vue.config.js
module.exports = {
	transpileDependencies: ['@ued_fpi/uview-ui'],
}

8、检查package.json的依赖@dcloudio，建议升级到最新。点击阅读 uni-app 官方文档 (opens new window)

# 版本查询

有两种方式可以查询到正在使用的uView的版本：

通过console.log打印的形式

console.log(this.$u.config.v);

// 或者(二者等价)
console.log(this.$u.config.version);

通过源码查看的形式

可以查阅uView的配置文件得知当前版本号，具体位置为"@ued_fpi/uview-ui/libs/config/config.js"。

← 介绍配置 →