注册小程序中的一个页面。接受一个 object 类型参数,其指定页面的初始数据、生命周期回调、事件处理函数等。
属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| data | object | 页面的初始数据 | ||
| onLoad | function | 生命周期回调—监听页面加载 | ||
| onShow | function | 生命周期回调—监听页面显示 | ||
| onReady | function | 生命周期回调—监听页面显示 | ||
| onHide | function | 生命周期回调—监听页面隐藏 | ||
| onUnload | function | 生命周期回调—监听页面卸载 | ||
| onPullDownRefresh | function | 监听用户下拉动作 | ||
| onReachBottom | function | 页面上拉触底事件的处理函数 | ||
| onShareAppMessage | function | 用户点击右上角转发 | ||
| onShareTimeline | function | 用户点击右上角转发到朋友圈 | ||
| onShareChat | function | 用户点击右上角转发到微信群组 | ||
| onPageScroll | function | 页面滚动触发事件的处理函数 | ||
| onTabItemTap | function | 当前是 tab 页时,点击 tab 时触发 | ||
| onCopyUrl | function | 用户点击右上角复制链接时触发 |
//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 将会以 JSON 字符串的形式由逻辑层传至渲染层,因此 data 中的数据必须是可以转成 JSON 的类型:字符串,数字,布尔值,对象,数组。
渲染层可以通过 XHSML 对数据进行绑定。
示例代码:
<view>{{text}}</view>
<view>{{array[0].msg}}</view>
Page({
data: {
text: 'init data',
array: [{msg: '1'}, {msg: '2'}]
}
})
页面加载时触发。一个页面只会调用一次,可以在 onLoad 的参数中获取打开当前页面路径中的参数。
参数:
名称 | 类型 | 说明 |
|---|---|---|
| query | Object | 打开当前页面路径中的参数 |
页面显示/切入前台时触发。
页面初次渲染完成时触发。一个页面只会调用一次,代表页面已经准备妥当,可以和视图层进行交互。
注意:对界面内容进行设置的 API 如 xhs.setNavigationBarTitle,请在
页面隐藏/切入后台时触发。 如 xhs.navigateTo 或底部 tab 切换到其他页面,小程序切入后台等。
页面卸载时触发。如 xhs.redirectTo 或 xhs.navigateBack 到其他页面时。
监听用户下拉刷新事件。
监听用户上拉触底事件。
基础库 >= 3.28.0 开始支持该接口
监听用户点击页面内转发按钮(button 组件 open-type="share")或右上角菜单“转发”按钮的行为,并自定义转发内容。
注意:只有定义了此事件处理函数,右上角菜单才会显示“转发”按钮自定义转发内容 分享图支持网络图片。 参数 Object object:
参数 | 类型 | 说明 | 最低版本 |
|---|---|---|---|
| from | String | 转发事件来源。button:页面内转发按钮;menu:右上角转发菜单 | 3.28.0 |
| target | Object | 如果 from 值是 button,则 target 是触发这次转发事件的 button,否则为 undefined | 3.28.0 |
| shareType | string | 分享类型 | 3.108.0 |
| pageId | string | 当前页面的 pageId | 3.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
}
}
})
基础库 >= 3.28.0 开始支持该接口,基础库 > 3.108.x 不再回调 onShareAppMessage
监听右上角菜单“分享到朋友圈”按钮的行为,并自定义分享内容。
注意: 只有定义了此事件处理函数,右上角菜单才会显示“分享到朋友圈”按钮自定义转发内容自定义转发内容 分享图支持网络图片。 参数 Object object:
参数 | 类型 | 说明 | 最低版本 |
|---|---|---|---|
| from | String | 转发事件来源。button:页面内转发按钮;menu:右上角转发菜单 | 3.28.0 |
| target | Object | 如果 from 值是 button,则 target 是触发这次转发事件的 button,否则为 undefined | 3.28.0 |
| shareType | string | 分享类型 | 3.108.0 |
| pageId | string | 当前页面的 pageId | 3.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 | 默认使用小程序 Logo | 3.28.0 |
| promise | 如果该参数存在,则以 resolve 结果为准,如果三秒内不 resolve,分享会使用上面传入的默认参数 | null | 3.108.0 |
| externalImageUrl | 分享到小红书站外的截图字段 (用于站外 h5 落地页展示,不传默认容器截取栈顶页面) | null | 3.108.0 |
| success | 分享成功回调(回调中无分享信息) | null | 3.108.0 |
| fail | 分享失败回调(回调中无失败信息) | null | 3.108.0 |
| complete | 分享完成回调 | null | 3.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 落地页展示
}
}
})
基础库 >= 3.28.0 开始支持该接口,基础库 > 3.108.x 不再回调 onShareAppMessage
监听右上角菜单“分享到微信群组”按钮的行为,并自定义分享内容。
注意: 只有定义了此事件处理函数,右上角菜单才会显示“分享到微信群组”按钮自定义转发内容自定义转发内容 分享图支持网络图片。 参数 Object object:
参数 | 类型 | 说明 | 最低版本 |
|---|---|---|---|
| from | String | 转发事件来源。button:页面内转发按钮;menu:右上角转发菜单 | 3.28.0 |
| target | Object | 如果 from 值是 button,则 target 是触发这次转发事件的 button,否则为 undefined | 3.28.0 |
| shareType | string | 分享类型 | 3.108.0 |
| pageId | string | 当前页面的 pageId | 3.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 | 默认使用小程序 Logo | 3.28.0 |
| promise | 如果该参数存在,则以 resolve 结果为准,如果三秒内不 resolve,分享会使用上面传入的默认 | promise | 3.28.0 |
| content | 好友分享的内容描述 | 默认取小程序描述 | 3.28.0 |
| externalImageUrl | 分享到小红书站外的截图字段 (用于站外 h5 落地页展示,不传默认容器截取栈顶页面) | null | 3.108.0 |
| success | 分享成功回调(回调中无分享信息) | null | 3.108.0 |
| fail | 分享失败回调(回调中无失败信息) | null | 3.108.0 |
| complete | 分享完成回调 | null | 3.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
}
}
})
基础库 >= 3.108.0 开始支持该接口
监听右上角菜单“复制链接”按钮的行为,并自定义分享内容。
注意: 该接口仅支持「复制链接」行为部分字段的配置,不配置不会影响复制链接本身的能力注:客户端8.56版本,对应基础库 >= 3.108.0 版本后,复制链接将得到「小程序短链」,可用于私信、或站外分享
事件处理函数返回一个 Object,用于自定义分享内容,不支持自定义页面路径,返回内容如下:
字段 | 说明 | 默认值 | 最低版本 |
|---|---|---|---|
| path | 转发的路径 | 当前页面路径 | 3.108.0 |
| query | 自定义页面路径中携带的参数,如 path?a=1&b=2 的 “?” 后面部分 | 当前页面路径携带的参数 | 3.108.0 |
| externalImageUrl | 分享到小红书站外的截图字段 (用于站外 h5 落地页展示,不传默认容器截取栈顶页面) | null | 3.108.0 |
| success | 分享成功回调(回调中无分享信息) | null | 3.108.0 |
| fail | 分享失败回调(回调中无失败信息) | null | 3.108.0 |
| complete | 分享完成回调 | null | 3.108.0 |
示例代码
Page({
onCopyUrl(res) {
return {
path: '/page/user/index',
query: 'a=1&b=2 ',
externalImageUrl: 'http://localhost/b.png', // 用于站外 h5 落地页展示
}
}
})
监听用户滑动页面事件。
参数 Object object:
属性 | 类型 | 说明 |
|---|---|---|
| scrollTop | Number | 页面在垂直方向已滚动的距离(单位px) |
注意:请只在需要的时候才在 page 中定义此方法,不要定义空方法。以减少不必要的事件派发对渲染层-逻辑层通信的影响。 注意:请避免在
Page 中还可以定义组件事件处理函数。在渲染层的组件中加入事件绑定,当事件被触发时,就会执行 Page 中定义的事件处理函数。
示例代码:
<view bindtap="viewTap"> click me </view>
Page({
viewTap: function() {
console.log('view tap')
}
})
到当前页面的路径,类型为
Page({
onShow: function() {
console.log(this.route)
}
})
setData 函数用于将数据从逻辑层发送到视图层(异步),同时改变对应的 this.data 的值(同步)。
字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
| data | Object | 是 | 这次要改变的数据 |
| callback | Function | 否 | setData引起的界面更新渲染完毕后的回调函数 |
其中 key 可以以数据路径的形式给出,支持改变数组中的某一项或对象的某个属性,如 array2.message,a.b.c.d,并且不需要在 this.data 中预先定义。
注意:
示例代码:
<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'
})
}
})