分类： API

ScrollViewContext

基础库 2.14.4 开始支持，低版本需做兼容处理。

增强微信小程序中的 ScrollView 实例，可通过 wx.createSelectorQuery 的 NodesRef.node 方法获取。 仅在 scroll-view 组件开启 enhanced 属性后生效。

属性

boolean scrollEnabled

滚动开关

boolean bounces

设置滚动边界弹性 (仅在 iOS 下生效)

boolean showScrollbar

设置是否显示滚动条

boolean pagingEnabled

分页滑动开关

boolean fastDeceleration

设置滚动减速速率 (仅在 iOS 下生效)

boolean decelerationDisabled

取消滚动惯性 (仅在 iOS 下生效)

方法

ScrollViewContext.triggerRefresh(Object object)

触发下拉刷新。

ScrollViewContext.closeRefresh()

关闭下拉刷新。

ScrollViewContext.triggerTwoLevel(Object object)

触发下拉二级。

ScrollViewContext.closeTwoLevel(Object object)

关闭下拉二级。

ScrollViewContext.scrollTo(Object object)

滚动至指定位置

ScrollViewContext.scrollIntoView(string selector, object ScrollIntoViewOptions)

滚动至指定位置

示例代码

wx.createSelectorQuery()
  .select('#scrollview')
  .node()
  .exec((res) => {
    const scrollView = res[0].node;
    scrollView.scrollEnabled = false;
  })

wx.pageScrollTo(Object object)

基础库 1.4.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.1.0

在微信小程序插件中使用时，只能在当前插件的页面中调用

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

将页面滚动到目标位置，支持选择器和滚动距离两种方式定位

参数

Object object

属性 类型 默认值 必填 说明 最低版本
scrollTop number 否 滚动到页面的目标位置，单位 px
duration number 300 否 滚动动画的时长，单位 ms
selector string 否 选择器 2.7.3
offsetTop number 否 偏移距离，需要和 selector 参数搭配使用，可以滚动到 selector 加偏移距离的位置，单位 px 2.23.1
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

selector 语法

selector类似于 CSS 的选择器，但仅支持下列语法。

  • ID选择器：#the-id
  • class选择器（可以连续指定多个）：.a-class.another-class
  • 子元素选择器：.the-parent > .the-child
  • 后代选择器：.the-ancestor .the-descendant
  • 跨自定义组件的后代选择器：.the-ancestor >>> .the-descendant
  • 多选择器的并集：#a-node, .some-other-nodes

示例代码

wx.pageScrollTo({
  scrollTop: 0,
  duration: 300
})

wx.startPullDownRefresh(Object object)

基础库 1.5.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.1.0

在微信小程序插件中使用时，只能在当前插件的页面中调用

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

开始下拉刷新。调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

wx.startPullDownRefresh()

wx.stopPullDownRefresh(Object object)

基础库 1.5.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.1.0

在微信小程序插件中使用时，只能在当前插件的页面中调用

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

停止当前页面的下拉刷新效果。

参数

Object object

属性 类型 默认值 必填 说明
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

Page({
  onPullDownRefresh () {
    wx.stopPullDownRefresh()
  }
})

wx.loadBuiltInFontFace(Object object)

基础库 3.7.9 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：不支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 3.7.9

微信 Windows 版：支持

微信 Mac 版：支持

功能描述

加载内置字体。

参数

Object object

属性 类型 默认值 必填 说明
global boolean false 否 是否全局生效
family string 是 定义的字体名称
source string 是 要加载的内置字体名字
合法值 说明
WeChatSansSS WeChatSansSS 字体
WeChatSansStd WeChatSansStd 字体
scopes Array 否 字体作用范围，可选值为 webview / native / skyline，默认全选，设置 native 可在 Canvas 2D 下使用
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

示例代码

在开发者工具中预览效果

wx.loadBuiltInFontFace({
  family: 'WeChatSansSS',
  source: 'WeChatSansSS',
  success: console.log
})

wx.loadFontFace(Object object)

基础库 2.1.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

微信小程序插件：支持，需要微信小程序基础库版本不低于 2.15.0

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

动态加载网络字体。

参数

Object object

属性 类型 默认值 必填 说明 最低版本
global boolean false 否 是否全局生效 2.10.0
family string 是 定义的字体名称
source string 是 字体资源的地址，可以为 https 链接或者 Data URL。
desc Object 否 可选的字体描述符
结构属性 类型 默认值 必填 说明
style string ‘normal’ 否 字体样式，可选值为 normal / italic / oblique
weight string ‘normal’ 否 字体粗细，可选值为 normal / bold / 100 / 200../ 900
variant string ‘normal’ 否 设置小型大写字母的字体显示文本，可选值为 normal / small-caps / inherit
scopes Array 否 字体作用范围，可选值为 webview / native / skyline，默认全选，设置 native 可在 Canvas 2D 下使用
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数
Object res
属性 类型 说明
status string 加载字体结果

object.fail 回调函数

参数
Object res
属性 类型 说明
status string 加载字体结果

object.complete 回调函数

参数
Object res
属性 类型 说明
status string 加载字体结果

示例代码

在开发者工具中预览效果

wx.loadFontFace({
  family: 'Bitstream Vera Serif Bold',
  source: 'url("https://res.wx.qq.com/t/wx_fed/base/weixin_portal/res/static/font/33uDySX.ttf")',
  success: console.log
})

Tips

  1. 字体链接需要是下载类型。
  2. 字体文件返回的 content-type 参考 font，格式不正确时会解析失败。
  3. 字体链接必须是 https（ios不支持http)。
  4. 建议格式为 TTF 和 WOFF，WOFF2 在低版本的iOS上会不兼容。
  5. 字体链接必须是同源下的，或开启了cors支持，微信小程序的域名是servicewechat.com
  6. 工具里提示 Faild to load font可以忽略
  7. 2.10.0 以前仅在调用页面生效。2.10.0 起支持全局生效，需在 app.js 中调用。
  8. 3.7.9 以前 scopes 默认值为 webview。3.7.9 起默认全选。
  9. 3.7.9 开始 source 支持传入 Data URL。

wx.hideTabBar(Object object)

基础库 1.9.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然

微信小程序插件：不支持

微信 Windows 版：支持

微信 鸿蒙 OS 版：支持

功能描述

隐藏 tabBar

参数

Object object

属性 类型 默认值 必填 说明
animation boolean false 否 是否需要动画效果
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）

wx.hideTabBarRedDot(Object object)

基础库 1.9.0 开始支持，低版本需做兼容处理。

以 Promise 风格 调用：支持

需要页面权限：当前是插件页面时，宿主微信小程序不能调用该接口，反之亦然

微信小程序插件：不支持

微信 Windows 版：支持

微信 Mac 版：支持

微信 鸿蒙 OS 版：支持

功能描述

隐藏 tabBar 某一项的右上角的红点

参数

Object object

属性 类型 默认值 必填 说明
index number 是 tabBar 的哪一项，从左边算起
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）