下载安装方式配置

关于SCSS

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

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

// 安装sass
npm i sass@1.63.2 -D

// 安装sass-loader
npm i sass-loader@10.4.1 -D

准备工作

在进行配置之前，请确保您已经根据安装中的步骤对uview-ultra进行了下载安装，如果没有，请先下载安装。

配置步骤

引入uview-ultra主JS库

在项目根目录中的main.js中，引入并使用uview-ultra的JS库，注意这两行要放在const app = createSSRApp(App)之后。

// main.js
import ultraUI from '@/uni_modules/uview-ultra'

// #ifdef VUE3
import { createSSRApp } from 'vue'
export function createApp() {
  const app = createSSRApp(App)
  app.use(ultraUI)
  return {
    app
  }
}
// #endif

在引入uview-ultra的全局SCSS主题文件

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

注意！

请注意uni-app官方规范中uni.scss是一个特殊文件，万万不可将其它样式比如uview-ultra/index.scss引入至uni.scss中，否则会造成打包后包超大。

/* uni.scss */
@import '@/uni_modules/uview-ultra/theme.scss';

引入uview-ultra基础样式

注意！

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

注意！

请注意uni.scss是一个特殊文件，万万不可将其它样式比如uview-ultra/index.scss引入至uni.scss中，严格按照文档指示在App.vue中引入。

注意！

请注意uni.scss是一个特殊文件，万万不可将其它样式比如uview-ultra/index.scss引入至uni.scss中，严格按照文档指示在App.vue中引入。

注意！

请注意uni.scss是一个特殊文件，万万不可将其它样式比如uview-ultra/index.scss引入至uni.scss中，严格按照文档指示在App.vue中引入。

<style lang="scss">
	/* 注意要写在第一行，注意不能引入至uni.scss，同时给style标签加入lang="scss"属性 */
	@import "@/uni_modules/uview-ultra/index.scss";
</style>

配置manifest

在项目的manifest.json中增加mergeVirtualHostAttributes配置

"mp-weixin" : {
	"appid" : "",
	...
	"mergeVirtualHostAttributes" : true
},
"mp-toutiao" : {
	"appid" : "",
	...
	"mergeVirtualHostAttributes" : true
}

配置easycom组件模式

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

温馨提示

1. uni-app为了调试性能的原因，修改easycom规则不会实时生效，配置完后，您需要重启HX或者重新编译项目才能正常使用uview-ultra的功能。
2. 请确保您的pages.json中只有一个easycom字段，否则请自行合并多个引入规则。

// pages.json
{
	"easycom": {
		"autoscan": true,
		// 注意一定要放在custom里，否则无效，https://ask.dcloud.net.cn/question/131175
		"custom": {
			"^up-(.*)": "@/uni_modules/uview-ultra/components/up-$1/up-$1.uvue",
		}
	},
	
	// 此为本身已有的内容
	"pages": [
		// ......
	]
}

typescript支持（uni-app-x下不需要）

在tsconfig.json中参考如下配置增加"uni-modules/uview-ultra/types"

{
	"compilerOptions": {
    "sourceMap": true,
    "baseUrl": ".",
    "paths": {
      "@/*": ["./src/*"]
    },
    "lib": ["esnext", "dom"],
    "types": [
        "@dcloudio/types",
        "uni_modules/uview-ultra/types"
    ]
  },
  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"]
}