# dom/bom 扩展 API

为了更好地适配小程序端接口,此方案在原有的 dom 接口之上进行了扩展。

# window 对象

# window.$$miniprogram

挂在 window 对象下的一个特殊对象,用于对页面作一些初始化工作(主要针对小程序页面路由相关)

属性名 类型 描述
window Object 对象所属页面的 window 对象
document Object 对象所属页面的 document 对象
config Object 创建页面时传入的 config
  • init(url)

初始化页面,如果需要页面跳转逻辑,则此方法必须被执行。

参数 类型 描述
url String 页面初始 url
  • getMatchRoute(pathname)

根据传入的 url pathname 来获取匹配的小程序页面路由。

# window.$$global

跨页面共享对象,所有页面的 window.$$global 均会指向同一个对象。

# window.$$trigger

触发当前节点事件。与 dispatchEvent 不同的是,$$trigger 不会触发事件的捕获、冒泡阶段,只对绑定在节点上的事件句柄按顺序执行一遍。

参数 类型 描述
eventName String 事件名称
options Object 配置
options.event Object 事件句柄接收到的事件对象
options.isCapture Boolean 是否触发捕获事件句柄,默认是 false
window.$$trigger('ready')
window.$$trigger('beforeunload', {
    event: new window.CustomEvent('beforeunload'),
    isCapture: false,
})
1
2
3
4
5

# window.$$clearEvent

清空某个事件的所有句柄。

参数 类型 描述
eventName String 事件名称
isCapture Boolean 是否清空捕获事件句柄,默认是 false

PS:慎用此方法,因为会清理掉所有地方绑定的事件句柄。

# window.$$getComputedStyle

小程序中 window.getComputedStyle 的替代实现,返回一个 promise。

参数 类型 描述
dom String dom 节点
computedStyle Array<String> 指定样式名列表
window.$$getComputedStyle(document.body, ['backgroundColor']).then(res => {
    console.log(res.backgroundColor)
})

window.$$getComputedStyle(document.querySelector('div'), ['backgroundColor']).then(res => {
    console.log(res.backgroundColor)
})
1
2
3
4
5
6
7

# window.$$createSelectorQuery

相当于 wx.createSelectorQuery,用法可参考官方文档

# window.$$createIntersectionObserver

相当于 wx.createIntersectionObserver,用法可参考官方文档

# window.$$getOpenerEventChannel

相当于页面的 this.getOpenerEventChannel,用法可参考官方文档

PS:一般来说,页面间通信可直接通过 window.$$subscribewindow.$$publish 来处理。只有对非插件页面和插件页面通信或者非 kbone 页面和 kbone 页面通信等特殊情况需要通过 eventChannel 的方式进行处理。

# window.$$forceRender

强制清空 setData 队列进行渲染。

# window.$$getPrototype

获取 dom/bom 对象的原型,用于对其做一些扩展改造。

参数 类型 描述
descriptor String 描述字符串

描述字符串支持的列表如下:

  • window.location
  • window.navigator
  • window.performance
  • window.screen
  • window.history
  • window.localStorage
  • window.sessionStorage
  • window.XMLHttpRequest
  • window.event
  • window
  • document
  • element.attribute
  • element.classList
  • element.style
  • element
  • textNode
  • comment
const locationPrototype = window.$$getPrototype('window.location') // location 对象的 prototype

const elementPrototype = window.$$getPrototype('element') // 普通节点的 prototype
const textNodePrototype = window.$$getPrototype('textNode') // 文本节点的 prototype
1
2
3
4

# window.$$extend

对 dom/bom 对象进行扩展。

参数 类型 描述
descriptor String 描述字符串,值同 window.$$getPrototype 接口
options Object 扩展对象
// 对 location 对象进行扩展
window.$$extend('window.location', {
    testStr: 'I am location',
    testFunc() {
        return `Hello, ${this.testStr}`
    },
})

console.log(window.location.testFunc()) // 输出 Hello, I am location
1
2
3
4
5
6
7
8
9

# window.$$addAspect

对 dom/bom 对象方法追加前置/后置处理。

参数 类型 描述
descriptor String 描述字符串
func Function 处理方法

描述字符串的值类似 window.$$getPrototype 接口的描述字符串,只是后续追加了方法和类型,比如 element.hasChildNodes.before 即表示在 element.hasChildNodes 方法追加前置处理。

前置处理即表示此方法会在执行原始方法之前执行,后置处理则是在之后执行。前置处理方法接收到的参数和原始方法接收到的参数一致,后置处理方法接收到的参数则是原始方法执行后返回的结果。

const div = document.createElement('div')
div.count = 0

const beforeAspect = function(arg) {
    // 在执行 div.hasChildNodes 前被调用
    console.log(arg) // 输出调用 div.hasChildNodes 时传入的参数
    if (this.count === 50) return true // 如果返回 true,则中断方法执行,不会再执行原始方法
    this.count++
}
const afterAspect = function(res) {
    // 在执行 div.hasChildNodes 后被调用
    console.log(res) // 输出调用 div.hasChildNodes 的返回值

    this.count++
}
window.$$addAspect('element.hasChildNodes.before', beforeAspect)
window.$$addAspect('element.hasChildNodes.after', afterAspect)
div.hasChildNodes('abc') // 返回 false
div.count // 输出 2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# window.$$removeAspect

移除对 dom/bom 对象方法追加前置/后置处理。

参数 类型 描述
descriptor String 描述字符串,值同 window.$$addAspect 接口
func Function 处理方法
window.$$removeAspect('element.hasChildNodes.before', beforeAspect)
window.$$removeAspect('element.hasChildNodes.after', afterAspect)
1
2

# window.$$subscribe

订阅来自 window 对象发布的广播消息。

参数 类型 描述
name String 消息名称
handler Function 事件句柄
window.$$subscribe('hello', data => {
    console.log('receive a msg: ', data)
})
1
2
3

# window.$$unsubscribe

取消订阅来自 window 对象发布的广播消息。

参数 类型 描述
name String 消息名称
handler Function 事件句柄,如果不传则会清除关于此消息的所有事件句柄
const handler = data => {
    console.log('receive a msg: ', data)
}

window.$$unsubscribe('hello', handler) // 取消当前订阅
window.$$unsubscribe('hello') // 取消关于此消息的所有订阅
1
2
3
4
5
6

# window.$$publish

发布广播消息,所有订阅过此消息的 window 对象均会收到。

参数 类型 描述
name String 消息名称
data Any 数据
window.$$publish('hello', 'I am june')
window.$$publish('hello', {name: 'june'})
1
2

# window.onShareAppMessage

开启 share 配置后,当进行页面转发时会执行的回调。此回调可以返回一个对象,作为小程序处理转发的参数。

属性名 类型 描述
data Object 小程序被转发页面 onShareAppMessage 回调传入的参数,可参考官方文档

返回对象中除了官方支持的参数外,还支持额外的参数:

属性名 类型 描述
miniprogramPath String 默认传入的 path 会被改造成 kbone 能解析的路径,如果需要转发原始的小程序页面路由,可传入此参数
window.onShareAppMessage = function(data) {
    // 当页面被转发时会进入这个回调
    // 返回一个对象,作为小程序处理转发的参数,对象内容和小程序页面 onShareAppMessage 回调可返回对象内容基本一致,具体可参考官方文档:https://developers.weixin.qq.com/miniprogram/dev/reference/api/Page.html#onShareAppMessage-Object-object
    return {
        title: 'test title',
        path: '/a', // 当前页面,这里的 path 是页面 url,而不是小程序路由
        // path: 'https://test.miniprogram.com/a', // 当前页面的完整 url,同上
        // path: '/b', // 其他页面,同上
        // path: 'https://test.miniprogram.com/b', // 其他页面的完整 url,同上
        // miniprogramPath: `/pages/page2/index?type=share&targeturl=${encodeURIComponent('/b')}`, // 如果需要分享原始小程序页面路由,可传递此参数
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

PS:返回的对象中,path 是要转发页面的 url(支持跨页面转发),而不是页面路由。如果不返回默认取 window.locaiton.href。

PS:miniprogramPath 的组装方式可参考 QA 说明

# window.onShareTimeline

开启 shareTimeline 配置后,当进行页面分享朋友圈时会执行的回调。此回调可以返回一个对象,作为小程序处理分享朋友圈的参数。

返回对象中除了官方支持的参数外,还支持额外的参数:

属性名 类型 描述
miniprogramQuery String 默认传入的 query 会被改造成 kbone 能解析的参数,如果需要转发原始的小程序页面参数,可传入此参数
window.onShareTimeline = function(data) {
    // 当页面被分享朋友圈时会进入这个回调
    // 返回一个对象,作为小程序处理分享朋友圈的参数,对象内容和小程序页面 onShareTimeline 回调可返回对象内容基本一致,具体可参考官方文档:https://developers.weixin.qq.com/miniprogram/dev/reference/api/Page.html#onShareTimeline
    return {
        title: 'test title',
        query: 'a=123&b=321', // 这里的 query 是页面 url 中的 search 参数,而不是小程序路由中的参数
        // miniprogramQuery: `type=share&targeturl=${encodeURIComponent('/a?a=123&b=321')}`, // 如果需要分享原始小程序页面路由参数,可传递此参数
    }
}
1
2
3
4
5
6
7
8
9

PS:返回的对象中,query 是要转发页面的 search,而不是页面路由参数。如果不返回默认取 locaiton.search。

PS:miniprogramPath 的组装方式可参考 QA 说明

# window.onAddToFavorites

当页面被收藏时会执行的回调。此回调可以返回一个对象,作为小程序处理收藏的参数。

属性名 类型 描述
data Object 小程序被转发页面 onAddToFavorites 回调传入的参数,可参考官方文档

返回对象中除了官方支持的参数外,还支持额外的参数:

属性名 类型 描述
miniprogramQuery String 默认传入的 query 会被改造成 kbone 能解析的参数,如果需要转发原始的小程序页面参数,可传入此参数
window.onAddToFavorites = function(data) {
    // 当页面被收藏时会进入这个回调
    // 返回一个对象,作为小程序处理收藏的参数,对象内容和小程序页面 onAddToFavorites 回调可返回对象内容基本一致,具体可参考官方文档:https://developers.weixin.qq.com/miniprogram/dev/reference/api/Page.html#onAddToFavorites-Object-object
    return {
        title: 'test title',
        query: 'a=123&b=321', // 这里的 query 是页面 url 中的 search 参数,而不是小程序路由中的参数
        // miniprogramQuery: `type=share&targeturl=${encodeURIComponent('/a?a=123&b=321')}`, // 如果需要收藏原始小程序页面路由参数,可传递此参数
    }
}
1
2
3
4
5
6
7
8
9

PS:返回的对象中,query 是要转发页面的 search,而不是页面路由参数。如果不返回默认取 locaiton.search。

PS:miniprogramPath 的组装方式可参考 QA 说明

# window.onTabItemTap

tabbar 被点击时会执行的回调,详情可参考官方文档

# window.onDealWithNotSupportDom

渲染时遇到不支持的 dom 节点会执行的回调。

属性名 类型 描述
dom Object 不支持的 dom 节点
window.onDealWithNotSupportDom = function(dom) {
    // 渲染时遇到不支持的 dom 节点时会进入这个回调
    if (dom.tagName === 'IFRAME') {
        dom.textContent = '当前小程序版本暂不支持 iframe'
    }
}
1
2
3
4
5
6

# window: pagenotfound 事件

当跳转到一个不存在的页面时触发。

  • event.type:页面跳转类型,jump 表示当前页面跳转,open 表示新开页面
  • event.url:目标页面的 url

# window: pageaccessdenied 事件

当跳转到一个被禁止访问的页面时触发,通常跳转非同源页面时会触发。

  • event.type: 页面跳转类型,jump 表示当前页面跳转,open 表示新开页面
  • event.url: 目标页面的 url

# window: reachbottom 事件

开启 reachBottom 配置后,当页面上拉触底时会触发此事件。

# window: pulldownrefresh 事件

开启 pullDownRefresh 配置后,当下拉刷新页面时会触发此事件。

# window: wxload 事件

即小程序页面的 onLoad 生命周期回调。

# window: wxshow 事件

即小程序页面的 onShow 生命周期回调。

# window: wxready 事件

即小程序页面的 onReady 生命周期回调。

# window: wxhide 事件

即小程序页面的 onHide 生命周期回调。

# window: wxunload 事件

即小程序页面的 onUnload 生命周期回调。

# document 对象

获取完整的 cookie,相当于请求头附带的 cookie。

// 给请求头设置 cookie
wx.request({
    method: 'GET',
    url: '/cgi/xxx',
    header: {
        cookie: window.document.$$cookie,
    },
    success() {},
})
1
2
3
4
5
6
7
8
9

# document.$$trigger

window.$$trigger

# document.$$clearEvent

window.$$clearEvent

PS:慎用此方法,因为会清理掉所有地方绑定的事件句柄。

# document.$$setCookie

处理 wx.request 返回的 Set-Cookie 头,并存入 document.cookie 中。

wx.request({
    method: 'GET',
    url: '/cgi/xxx',
    success(res) {
        const setCookie = res.header['Set-Cookie']
        document.$$setCookie(setCookie)

        console.log(document.cookie)
    },
})
1
2
3
4
5
6
7
8
9
10

# dom 对象

# dom.$$wxComponent

获取该节点所属的小程序自定义组件实例。

PS:只有 dom.nodeType 为 1 的元素节点可获取。

# dom.$$trigger

window.$$trigger

# dom.$$clearEvent

window.$$clearEvent

PS:慎用此方法,因为会清理掉所有地方绑定的事件句柄。

# dom.$$getBoundingClientRect

小程序中 dom.getBoundingClientRect 的替代实现,返回一个 promise。

PS:此接口本质上是小程序的 SelectorQuery 的二次封装,如果是 dom 是 document.body,会默认走 scrollOffset 接口,如果是其他 dom 则走 boundingClientRect 接口。

document.body.$$getBoundingClientRect().then(res => {
    // res 的内容可以参考官方文档:https://developers.weixin.qq.com/miniprogram/dev/api/wxml/NodesRef.scrollOffset.html
})

document.querySelector('div').$$getBoundingClientRect().then(res => {
    // res 的内容可以参考官方文档:https://developers.weixin.qq.com/miniprogram/dev/api/wxml/NodesRef.boundingClientRect.html
})
1
2
3
4
5
6
7

# dom.$$getContext

获取小程序组件的 context 对象,返回一个 promise。

PS:此接口是小程序的 SelectorQuery 的二次封装

document.querySelector('video').$$getContext().then(context => {
    // 这里的 context 仅限于文档中支持的那些:https://developers.weixin.qq.com/miniprogram/dev/api/wxml/NodesRef.context.html
})
1
2
3

# dom.$$getNodesRef

获取小程序组件的 NodesRef 对象,返回一个 promise。

PS:此接口是小程序的 SelectorQuery 的二次封装

document.querySelector('video').$$getNodesRef().then(nodesRef => {
    // NodesRef 对象文档:https://developers.weixin.qq.com/miniprogram/dev/api/wxml/NodesRef.html
    nodesRef.node(res => {
        console.log(res.node)
    }).exec()
})
1
2
3
4
5
6

# dom: $$domNodeUpdate 事件

当前节点有更新时触发。

# dom: $$childNodesUpdate 事件

儿子节点有更新时触发。

PS:注意此处孙子节点更新是不会触发的。

# canvas

# canvas.$$prepare

小程序 canvas 提供了和 Web 端接口对齐的 node 对象,此方法用于将该对象处理到 canvas 节点的 getContext 方法中。

document.getElementById('#canvas').$$prepare().then(domNode => {
    const ctx = domNode.getContext('2d') // 注意,这种用法需要设置 canvas 节点的 type 属性,相关文档:https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html
    
    // do something
})
1
2
3
4
5