zxUI

# NPM安装方式配置

# 关于SCSS

zxUI依赖SCSS，您必须要安装此插件，否则无法正常运行。

  • 如果您的项目是由HBuilder X创建的，相信已经安装scss插件，如果没有，请在HX菜单的 工具->插件安装中找到"scss/sass编译"插件进行安装， 如不生效，重启HX即可
  • 如果您的项目是由vue-cli创建的，请通过以下命令安装对sass(scss)的支持，如果已安装，请略过。
// 安装sass
npm i sass -D

// 安装sass-loader，注意需要版本10，否则可能会导致vue与sass的兼容问题而报错
npm i sass-loader@10 -D

# 准备工作

在进行配置之前，请确保您已经根据安装中的步骤对zxUI进行了npm安装，如果没有，请先执行安装：

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

// 安装
npm install @tanzhenxing/zxui

# 配置步骤

# 1. 引入zxUI主JS库

在项目src目录中的main.js中，引入并使用zxUI的JS库，注意这两行要放在import Vue之后。

// main.js
import zxUI from "zxui";
Vue.use(zxUI);

# 2. 在引入zxUI的全局SCSS主题文件

在项目src目录的uni.scss中引入此文件。

/* uni.scss */
@import 'zxUI-ui/theme.scss';

# 3. 引入zxUI基础样式

注意！

在App.vue中首行的位置引入，注意给style标签加入lang="scss"属性

<style lang="scss">
	/* 注意要写在第一行，同时给style标签加入lang="scss"属性 */
	@import "zxui/index.scss";
</style>

# 4. 配置easycom组件模式

此配置需要在项目src目录的pages.json中进行。

温馨提示

  1. uni-app为了调试性能的原因，修改easycom规则不会实时生效，配置完后，您需要重启HX或者重新编译项目才能正常使用zxUI的功能。
  2. 请确保您的pages.json中只有一个easycom字段，否则请自行合并多个引入规则。
// pages.json
{
	"easycom": {
		"^zx-(.*)": "zxui/components/zx-$1/zx-$1.vue"
	},
	
	// 此为本身已有的内容
	"pages": [
		// ......
	]
}

# 5. Cli模式额外配置

如果您是vue-cli模式的项目，还需要在项目根目录的vue.config.js文件中进行如下配置：

// vue.config.js，如没有此文件则手动创建
module.exports = {
    transpileDependencies: ['zxui']
}