uview-plus
Version:
零云®uview-plus已兼容vue3支持多语言，120+全面的组件和便捷的工具会让您信手拈来。近期新增拖动排序、条码、图片裁剪、下拉刷新、虚拟列表、签名、Markdown等。
314 lines (310 loc) • 13.1 kB
JavaScript
import { defineMixin } from '../vue'
import { deepMerge, $parent, sleep } from '../function/index'
import test from '../function/test'
import route from '../util/route'
import {
applyNativeThemeUI,
applyNativeThemeUIDeferred,
getThemeCardStyle,
getThemeIsDark,
getThemePageStyle,
getThemeVar,
getThemeVarsForStyle,
syncThemeRuntimeFromStorage
} from '../theme/runtime'
// #ifdef APP-NVUE
// 由于weex为阿里的KPI业绩考核的产物，所以不支持百分比单位，这里需要通过dom查询组件的宽度
const dom = (typeof uni !== 'undefined' && uni && typeof uni.requireNativePlugin === 'function')
? uni.requireNativePlugin('dom')
: null
// #endif
export const mixin = defineMixin({
// 定义每个组件都可能需要用到的外部样式以及类名
props: {
// 每个组件都有的父组件传递的样式，可以为字符串或者对象形式
customStyle: {
type: [Object, String],
default: () => ({})
},
customClass: {
type: String,
default: ''
},
// 跳转的页面路径
url: {
type: String,
default: ''
},
// 页面跳转的类型
linkType: {
type: String,
default: 'navigateTo'
}
},
data() {
return {
__upPageThemeChangeHandler: null,
upThemeVersion: 0
}
},
onLoad() {
// getRect挂载到$u上，因为这方法需要使用in(this)，所以无法把它独立成一个单独的文件导出
this.upBindGetRect()
this.upInitThemeVersion()
if (this.upIsPageScope()) {
this.upApplyNativeThemeUI()
if (typeof uni !== 'undefined' && typeof uni.$on === 'function' && !this.__upPageThemeChangeHandler) {
this.__upPageThemeChangeHandler = () => {
this.upApplyNativeThemeUI()
}
uni.$on('uThemeChange', this.__upPageThemeChangeHandler)
}
}
},
onShow() {
if (this.upIsPageScope()) {
this.upApplyNativeThemeUI()
}
},
created() {
// 组件当中，只有created声明周期，为了能在组件使用，故也在created中将方法挂载到$u
this.upBindGetRect()
this.upInitThemeVersion()
if (typeof uni !== 'undefined' && typeof uni.$on === 'function') {
this.__uThemeChangeHandler = (payload = {}) => {
this.upSyncThemeVersion(payload)
this.chacheU = null
if (typeof this.$forceUpdate === 'function') {
this.$forceUpdate()
}
}
uni.$on('uThemeChange', this.__uThemeChangeHandler)
}
},
computed: {
// 在2.x版本中，将会把$u挂载到uni对象下，导致在模板中无法使用uni.$u.xxx形式
// 所以这里通过computed计算属性将其附加到this.$u上，就可以在模板或者js中使用uni.$u.xxx
// 只在nvue环境通过此方式引入完整的$u，其他平台会出现性能问题，非nvue则按需引入（主要原因是props过大）
$u() {
this.upThemeVersion
// #ifndef APP-NVUE
// 在非nvue端，移除props，http，mixin等对象，避免在小程序setData时数据过大影响性能
let mergeU = deepMerge(uni.$u, {
props: undefined,
http: undefined,
mixin: undefined
})
// 缓存结果避免每次计算
if (!this.chacheU) {
this.chacheU = mergeU
}
return this.chacheU
// #endif
// #ifdef APP-NVUE
return uni.$u
// #endif
},
upThemeIsDark() {
this.upThemeVersion
return getThemeIsDark(this.$u)
},
upThemeVars() {
this.upThemeVersion
return getThemeVarsForStyle(this.$u)
},
upThemePageStyle() {
this.upThemeVersion
return getThemePageStyle(this.$u)
},
upThemeCardStyle() {
this.upThemeVersion
return getThemeCardStyle(this.$u)
},
/**
* 生成bem规则类名
* 由于微信小程序，H5，nvue之间绑定class的差异，无法通过:class="[bem()]"的形式进行同用
* 故采用如下折中做法，最后返回的是数组（一般平台）或字符串（支付宝和字节跳动平台），类似['a', 'b', 'c']或'a b c'的形式
* @param {String} name 组件名称
* @param {Array} fixed 一直会存在的类名
* @param {Array} change 会根据变量值为true或者false而出现或者隐藏的类名
* @returns {Array|string}
*/
bem() {
return function (name, fixed, change) {
// 类名前缀
const prefix = `u-${name}--`
const classes = {}
if (fixed) {
fixed.map((item) => {
// 这里的类名，会一直存在
classes[prefix + this[item]] = true
})
}
if (change) {
change.map((item) => {
// 这里的类名，会根据this[item]的值为true或者false，而进行添加或者移除某一个类
this[item] ? (classes[prefix + item] = this[item]) : (delete classes[prefix + item])
})
}
return Object.keys(classes)
// 支付宝，头条小程序无法动态绑定一个数组类名，否则解析出来的结果会带有","，而导致失效
// #ifdef MP-ALIPAY || MP-TOUTIAO || MP-LARK
.join(' ')
// #endif
}
}
},
methods: {
upBindGetRect() {
const upU = this.$u || (typeof uni !== 'undefined' ? uni.$u : null)
if (upU) {
upU.getRect = this.$uGetRect
} else if (typeof uni !== 'undefined') {
uni.$u = {
getRect: this.$uGetRect
}
}
},
upReadThemeVersion() {
return Number((typeof uni !== 'undefined' && uni.$u && uni.$u.theme && uni.$u.theme.version) || 0)
},
upInitThemeVersion() {
const version = this.upReadThemeVersion()
if (version) {
this.upThemeVersion = version
}
},
upSyncThemeVersion(payload = {}) {
const version = Number(payload.version || this.upReadThemeVersion() || 0)
this.upThemeVersion = version || Number(this.upThemeVersion || 0) + 1
},
upIsPageScope() {
return !!(this.$page || this.route || this.$options?.mpType === 'page')
},
upHasProp(propName) {
const vnodeProps = this.$?.vnode?.props || {}
const kebabName = propName.replace(/[A-Z]/g, (s) => `-${s.toLowerCase()}`)
return Object.prototype.hasOwnProperty.call(vnodeProps, propName)
|| Object.prototype.hasOwnProperty.call(vnodeProps, kebabName)
},
upThemeVar(varName, fallbackColor) {
this.upThemeVersion
return getThemeVar(varName, fallbackColor, this.$u)
},
upApplyNativeThemeUI() {
syncThemeRuntimeFromStorage(this.$u)
this.upSyncThemeVersion()
applyNativeThemeUIDeferred(this.$u)
},
// 跳转某一个页面
openPage(urlKey = 'url') {
const url = this[urlKey]
if (url) {
// h5官方回应：发行h5会自动摇树优化，所有使用uni的地方，都会被直接转换成具体的API调用 https://ask.dcloud.net.cn/question/161523?notification_id-1201922__rf-false__item_id-226372
// 使用封装的 route 进行跳转（直接调用方法），不使用 uni 对象
route({ type: this.linkType, url })
// 执行类似uni.navigateTo的方法
// uni[this.linkType]({
// url
// })
}
},
navTo(url = '', linkType = 'navigateTo') {
route({ type: this.linkType, url })
},
// 查询节点信息
// 目前此方法在支付宝小程序中无法获取组件跟接点的尺寸，为支付宝的bug(2020-07-21)
// 解决办法为在组件根部再套一个没有任何作用的view元素
$uGetRect(selector, all) {
return new Promise((resolve) => {
// #ifndef APP-NVUE
uni.createSelectorQuery()
.in(this)[all ? 'selectAll' : 'select'](selector)
.boundingClientRect((rect) => {
if (all && Array.isArray(rect) && rect.length) {
resolve(rect)
}
if (!all && rect) {
resolve(rect)
}
})
.exec()
// #endif
// #ifdef APP-NVUE
sleep(30).then(() => {
let selectorNvue = selector.substring(1) // 去掉开头的#或者.
let selectorRef = this.$refs[selectorNvue]
if (!selectorRef) {
// console.log('不存在元素，请检查是否设置了ref属性' + selectorNvue + '。')
resolve({
with: 0,
height: 0,
left: 0,
right: 0,
top: 0,
bottom: 0
})
}
dom.getComponentRect(selectorRef, res => {
// console.log(res)
resolve(res.size)
})
})
// #endif
})
},
getParentData(parentName = '') {
// 避免在created中去定义parent变量
if (!this.parent) this.parent = {}
// 这里的本质原理是，通过获取父组件实例(也即类似u-radio的父组件u-radio-group的this)
// 将父组件this中对应的参数，赋值给本组件(u-radio的this)的parentData对象中对应的属性
// 之所以需要这么做，是因为所有端中，头条小程序不支持通过this.parent.xxx去监听父组件参数的变化
// 此处并不会自动更新子组件的数据，而是依赖父组件u-radio-group去监听data的变化，手动调用更新子组件的方法去重新获取
this.parent = $parent.call(this, parentName)
if (this.parent.children) {
// 如果父组件的children不存在本组件的实例，才将本实例添加到父组件的children中
this.parent.children.indexOf(this) === -1 && this.parent.children.push(this)
}
if (this.parent && this.parentData) {
// 历遍parentData中的属性，将parent中的同名属性赋值给parentData
Object.keys(this.parentData).map((key) => {
this.parentData[key] = this.parent[key]
})
}
},
// 阻止事件冒泡
preventEvent(e) {
e && typeof (e.stopPropagation) === 'function' && e.stopPropagation()
},
// 空操作
noop(e) {
this.preventEvent(e)
}
},
onReachBottom() {
uni.$emit('uOnReachBottom')
},
beforeUnmount() {
// 判断当前页面是否存在parent和chldren，一般在checkbox和checkbox-group父子联动的场景会有此情况
// 组件销毁时，移除子组件在父组件children数组中的实例，释放资源，避免数据混乱
if (this.parent && test.array(this.parent.children)) {
// 组件销毁时，移除父组件中的children数组中对应的实例
const childrenList = this.parent.children
childrenList.map((child, index) => {
// 如果相等，则移除
if (child === this) {
childrenList.splice(index, 1)
}
})
}
if (typeof uni !== 'undefined' && typeof uni.$off === 'function' && this.__uThemeChangeHandler) {
uni.$off('uThemeChange', this.__uThemeChangeHandler)
this.__uThemeChangeHandler = null
}
if (typeof uni !== 'undefined' && typeof uni.$off === 'function' && this.__upPageThemeChangeHandler) {
uni.$off('uThemeChange', this.__upPageThemeChangeHandler)
this.__upPageThemeChangeHandler = null
}
}
})
export default mixin