小程序开放平台

文档中心
小程序配置
框架接口
小程序App
页面
Page
getCurrentPages
自定义组件
模块化
基础功能
XHSML语法参考
2.0架构升级
sjs 语法参考
平台骨架屏(beta)

Page

开发
>
框架
>
框架接口
>
页面
>
Page
>
更新时间:2025-02-10 11:17:45

Page

注册小程序中的一个页面。接受一个 object 类型参数,其指定页面的初始数据、生命周期回调、事件处理函数等。

属性
类型
默认值
必填
说明
dataobject页面的初始数据
onLoadfunction生命周期回调—监听页面加载
onShowfunction生命周期回调—监听页面显示
onReadyfunction生命周期回调—监听页面显示
onHidefunction生命周期回调—监听页面隐藏
onUnloadfunction生命周期回调—监听页面卸载
onPullDownRefreshfunction监听用户下拉动作
onReachBottomfunction页面上拉触底事件的处理函数
onShareAppMessagefunction用户点击右上角转发
onShareTimelinefunction用户点击右上角转发到朋友圈
onShareChatfunction用户点击右上角转发到微信群组
onPageScrollfunction页面滚动触发事件的处理函数
onTabItemTapfunction当前是 tab 页时,点击 tab 时触发
onCopyUrlfunction用户点击右上角复制链接时触发

示例代码

//index.js
Page({
  data: {
    text: "This is page data."
  },
  onLoad: function(options) {
    // Do some initialize when page load.
  },
  onShow: function() {
    // Do something when page show.
  },
  onReady: function() {
    // Do something when page ready.
  },
  onHide: function() {
    // Do something when page hide.
  },
  onUnload: function() {
    // Do something when page close.
  },
  onPullDownRefresh: function() {
    // Do something when pull down.
  },
  onReachBottom: function() {
    // Do something when page reach bottom.
  },
  onShareAppMessage: function () {
    // return custom share data when user share.
  },
  onShareTimeline: function () {
    // return custom share options for timeline
  },
  onShareChat: function () {
    // return custom share options for wx chat
  },
  onCopyUrl: function () {
    // return custom share options for onCopyUrl
  },
  onPageScroll: function() {
    // Do something when page scroll
  },
  // Event handler.
  viewTap: function() {
    this.setData({
      text: 'Set some data for updating view.'
    }, function() {
      // this is setData callback
    })
  },
  customData: {
    hi: 'MINA'
  }
})

data

data 是页面第一次渲染使用的初始数据。

页面加载时,data 将会以 JSON 字符串的形式由逻辑层传至渲染层,因此 data 中的数据必须是可以转成 JSON 的类型:字符串,数字,布尔值,对象,数组。

渲染层可以通过 XHSML 对数据进行绑定。

示例代码:

<view>{{text}}</view>
<view>{{array[0].msg}}</view>
Page({
  data: {
    text: 'init data',
    array: [{msg: '1'}, {msg: '2'}]
  }
})

生命周期回调函数

onLoad(Object query)

页面加载时触发。一个页面只会调用一次,可以在 onLoad 的参数中获取打开当前页面路径中的参数。

参数:

名称
类型
说明
queryObject打开当前页面路径中的参数

onShow()

页面显示/切入前台时触发。

onReady()

页面初次渲染完成时触发。一个页面只会调用一次,代表页面已经准备妥当,可以和视图层进行交互。

注意:对界面内容进行设置的 API 如 xhs.setNavigationBarTitle,请在

onReady
之后进行

onHide()

页面隐藏/切入后台时触发。 如 xhs.navigateTo 或底部 tab 切换到其他页面,小程序切入后台等。

onUnload()

页面卸载时触发。如 xhs.redirectTo 或 xhs.navigateBack 到其他页面时。

页面事件处理函数

onPullDownRefresh()

监听用户下拉刷新事件。

  • 需要在
    app.json
    的 window 选项中或页面配置中开启
    enablePullDownRefresh。
  • 可以通过 xhs.startPullDownRefresh 触发下拉刷新,调用后触发下拉刷新动画,效果与用户手动下拉刷新一致。
  • 当处理完数据刷新后,xhs.stopPullDownRefresh 可以停止当前页面的下拉刷新。

onReachBottom()

监听用户上拉触底事件。

  • 可以在
    app.json
    的 window 选项中或页面配置中设置触发距离 onReachBottomDistance。
  • 在触发距离内滑动期间,本事件只会被触发一次。

onShareAppMessage(Object object)

基础库 >= 3.28.0 开始支持该接口

监听用户点击页面内转发按钮(button 组件 open-type="share")或右上角菜单“转发”按钮的行为,并自定义转发内容。



注意:只有定义了此事件处理函数,右上角菜单才会显示“转发”按钮自定义转发内容 分享图支持网络图片。 参数 Object object:

参数
类型
说明
最低版本
fromString转发事件来源。button:页面内转发按钮;menu:右上角转发菜单3.28.0
targetObject如果 from 值是 button,则 target 是触发这次转发事件的 button,否则为 undefined3.28.0
shareTypestring分享类型3.108.0
pageIdstring当前页面的 pageId3.108.0


此事件处理函数需要 return 一个 Object,用于自定义转发内容,返回内容如下

自定义转发内容
分享图支持网络图片

字段
说明
默认值
title转发标题当前小程序名称
path转发路径当前页面 path ,必须是以 / 开头的完整路径
query自定义页面路径中携带的参数,如 path?a=1&b=2 的 “?” 后面部分(注:不要对整个 query 字符串进行 encode!!)null
imageUrl仅支持网络图片路径(IOS 客户端路径中如果含中文需要encode)
content站内分享的内容描述默认取小程序描述
promise如果该参数存在,则以 resolve 结果为准,如果三秒内不 resolve,分享会使用上面传入的默认参数null
success分享成功回调(回调中无分享信息)null
fail分享失败回调(回调中无失败信息)null
complete分享完成回调null

示例代码

Page({
  onShareAppMessage() {
    const promise = new Promise(resolve => {
      setTimeout(() => {
        resolve({
          title: '自定义转发标题'
        })
      }, 2000)
    })
    return {
      title: '自定义转发标题',
      path: '/page/user?id=123',
      promise 
    }
  }
})

onShareTimeline()

基础库 >= 3.28.0 开始支持该接口,基础库 > 3.108.x 不再回调 onShareAppMessage

监听右上角菜单“分享到朋友圈”按钮的行为,并自定义分享内容。

注意: 只有定义了此事件处理函数,右上角菜单才会显示“分享到朋友圈”按钮自定义转发内容自定义转发内容 分享图支持网络图片。 参数 Object object:

参数
类型
说明
最低版本
fromString转发事件来源。button:页面内转发按钮;menu:右上角转发菜单3.28.0
targetObject如果 from 值是 button,则 target 是触发这次转发事件的 button,否则为 undefined3.28.0
shareTypestring分享类型3.108.0
pageIdstring当前页面的 pageId3.108.0

** 事件处理函数返回一个 Object,用于自定义分享内容,不支持自定义页面路径,返回内容如下:**

字段
说明
默认值
最低版本
title自定义标题,即朋友圈列表页上显示的标题当前小程序名称3.28.0
path转发的路径当前页面路径3.28.0
query自定义页面路径中携带的参数,如 path?a=1&b=2 的 “?” 后面部分当前页面路径携带的参数3.28.0
imageUrl自定义图片路径,可以是本地文件或者网络图片(IOS 客户端路径中如果含中文需要encode) 。支持 PNG 及 JPG,显示图片长宽比是 1:1默认使用小程序 Logo3.28.0
promise如果该参数存在,则以 resolve 结果为准,如果三秒内不 resolve,分享会使用上面传入的默认参数null3.108.0
externalImageUrl分享到小红书站外的截图字段 (用于站外 h5 落地页展示,不传默认容器截取栈顶页面)null3.108.0
success分享成功回调(回调中无分享信息)null3.108.0
fail分享失败回调(回调中无失败信息)null3.108.0
complete分享完成回调null3.108.0

示例代码

Page({
  onShareAppMessage(res) { /** 必须先配置 onShareAppMessage */},
  onShareTimeline(res) {
    return {
      title: '自定义转发标题, 来自于: ' + res.from,
      query: 'a=1&b=2 ',
      imageUrl: 'http://localhost/a.png',
      externalImageUrl: 'http://localhost/b.png', // 用于站外 h5 落地页展示
    }
  }
})

onShareChat()

基础库 >= 3.28.0 开始支持该接口,基础库 > 3.108.x 不再回调 onShareAppMessage

监听右上角菜单“分享到微信群组”按钮的行为,并自定义分享内容。

注意: 只有定义了此事件处理函数,右上角菜单才会显示“分享到微信群组”按钮自定义转发内容自定义转发内容 分享图支持网络图片。 参数 Object object:

参数
类型
说明
最低版本
fromString转发事件来源。button:页面内转发按钮;menu:右上角转发菜单3.28.0
targetObject如果 from 值是 button,则 target 是触发这次转发事件的 button,否则为 undefined3.28.0
shareTypestring分享类型3.108.0
pageIdstring当前页面的 pageId3.108.0

事件处理函数返回一个 Object,用于自定义分享内容,不支持自定义页面路径,返回内容如下:

字段
说明
默认值
最低版本
path转发的路径当前页面路径3.28.0
title自定义标题,即聊天群组内分享内容显示的标题当前小程序名称3.28.0
query自定义页面路径中携带的参数,如 path?a=1&b=2 的 “?” 后面部分当前页面路径携带的参数3.28.0
imageUrl自定义图片路径,可以是本地文件或者网络图片(IOS 客户端路径中如果含中文需要encode) 。支持 PNG 及 JPG,显示图片长宽比是 1:1默认使用小程序 Logo3.28.0
promise如果该参数存在,则以 resolve 结果为准,如果三秒内不 resolve,分享会使用上面传入的默认promise3.28.0
content好友分享的内容描述默认取小程序描述3.28.0
externalImageUrl分享到小红书站外的截图字段 (用于站外 h5 落地页展示,不传默认容器截取栈顶页面)null3.108.0
success分享成功回调(回调中无分享信息)null3.108.0
fail分享失败回调(回调中无失败信息)null3.108.0
complete分享完成回调null3.108.0

示例代码

Page({
  onShareAppMessage(res) { /** 必须先配置 onShareAppMessage */},
  onShareChat(res) {
    return {
      path: 'pages/name/test',
      title: '自定义转发标题',
      query: 'a=1&b=2 ',
      imageUrl: 'http://localhost/a.png',
      content: '自定义描述',
      success() {
        // do sth
      },
      fail() {
        // do sth
      }
    }
  }
})

异步场景(promise)示例:

Page({
  onShareAppMessage(res) { /** 必须先配置 onShareAppMessage */},
  onShareChat() {
    const promise = new Promise(resolve => {
      setTimeout(() => {
        resolve({
          title: '异步请求回来的标题'
        })
      }, 2000)
    })
    return {
      title: '自定义转发标题',
      path: '/page/user?id=123',
      promise
    }
  }
})

onCopyUrl()

基础库 >= 3.108.0 开始支持该接口

监听右上角菜单“复制链接”按钮的行为,并自定义分享内容。

注意: 该接口仅支持「复制链接」行为部分字段的配置,不配置不会影响复制链接本身的能力注:客户端8.56版本,对应基础库 >= 3.108.0 版本后,复制链接将得到「小程序短链」,可用于私信、或站外分享

事件处理函数返回一个 Object,用于自定义分享内容,不支持自定义页面路径,返回内容如下:

字段
说明
默认值
最低版本
path转发的路径当前页面路径3.108.0
query自定义页面路径中携带的参数,如 path?a=1&b=2 的 “?” 后面部分当前页面路径携带的参数3.108.0
externalImageUrl分享到小红书站外的截图字段 (用于站外 h5 落地页展示,不传默认容器截取栈顶页面)null3.108.0
success分享成功回调(回调中无分享信息)null3.108.0
fail分享失败回调(回调中无失败信息)null3.108.0
complete分享完成回调null3.108.0

示例代码

Page({
  onCopyUrl(res) {
    return {
      path: '/page/user/index',
      query: 'a=1&b=2 ',
      externalImageUrl: 'http://localhost/b.png', // 用于站外 h5 落地页展示
    }
  }
})

onPageScroll(Object object)

监听用户滑动页面事件。

参数 Object object:

属性
类型
说明
scrollTopNumber页面在垂直方向已滚动的距离(单位px)

注意:请只在需要的时候才在 page 中定义此方法,不要定义空方法。以减少不必要的事件派发对渲染层-逻辑层通信的影响。 注意:请避免在

onPageScroll
中过于频繁的执行
setData
等引起逻辑层-渲染层通信的操作。尤其是每次传输大量数据,会影响通信耗时。

组件事件处理函数

Page 中还可以定义组件事件处理函数。在渲染层的组件中加入事件绑定,当事件被触发时,就会执行 Page 中定义的事件处理函数。

示例代码:

<view bindtap="viewTap"> click me </view>
Page({
  viewTap: function() {
    console.log('view tap')
  }
})

Page.route

到当前页面的路径,类型为

String

Page({
  onShow: function() {
    console.log(this.route)
  }
})

Page.prototype.setData(Object data, Function callback)

setData 函数用于将数据从逻辑层发送到视图层(异步),同时改变对应的 this.data 的值(同步)。

参数说明

字段
类型
必填
描述
dataObject这次要改变的数据
callbackFunctionsetData引起的界面更新渲染完毕后的回调函数

Object
key: value
的形式表示,将
this.data
中的
key
对应的值改变成
value

其中 key 可以以数据路径的形式给出,支持改变数组中的某一项或对象的某个属性,如 array2.message,a.b.c.d,并且不需要在 this.data 中预先定义。

注意:

  1. 直接修改 this.data 而不调用 this.setData 是无法改变页面的状态的,还会造成数据不一致。
  2. 仅支持设置可 JSON 化的数据。
  3. 单次设置的数据不能超过1024kB,请尽量避免一次设置过多的数据。
  4. 请不要把 data 中任何一项的 value 设为 undefined ,否则这一项将不被设置并可能遗留一些潜在问题。

示例代码:

<view>{{text}}</view>
<button bindtap="changeText"> Change normal data </button>
<view>{{num}}</view>
<button bindtap="changeNum"> Change normal num </button>
<view>{{array[0].text}}</view>
<button bindtap="changeItemInArray"> Change Array data </button>
<view>{{object.text}}</view>
<button bindtap="changeItemInObject"> Change Object data </button>
<view>{{newField.text}}</view>
<button bindtap="addNewField"> Add new data </button>
// index.js
Page({
  data: {
    text: 'init data',
    num: 0,
    array: [{text: 'init data'}],
    object: {
      text: 'init data'
    }
  },
  changeText: function() {
    // this.data.text = 'changed data' // 不要直接修改 this.data
    // 应该使用 setData
    this.setData({
      text: 'changed data'
    })
  },
  changeNum: function() {
    // 或者,可以修改 this.data 之后马上用 setData 设置一下修改了的字段
    this.data.num = 1
    this.setData({
      num: this.data.num
    })
  },
  changeItemInArray: function() {
    // 对于对象或数组字段,可以直接修改一个其下的子字段,这样做通常比修改整个对象或数组更好
    this.setData({
      'array[0].text':'changed data'
    })
  },
  changeItemInObject: function(){
    this.setData({
      'object.text': 'changed data'
    });
  },
  addNewField: function() {
    this.setData({
      'newField.text': 'new data'
    })
  }
})