小程序页面框架接口参数（附代码）

网友投稿 38 2024-07-04

Page

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

扩展功能：可以创建一个xxx.ext.json文件。该文件会和页面json文件合并，优先使用xxx.ext.json中的配置(组件同理)

#1. 参数

属性	类型	说明
data	Object	页面的初始数据
onLoad	function	生命周期回调—监听页面加载
onShow	function	生命周期回调—监听页面显示
onReady	function	生命周期回调—监听页面初次渲染完成
onHide	function	生命周期回调—监听页面隐藏
onUnload	function	生命周期回调—监听页面卸载
onPullDownRefresh	function	监听用户下拉动作
onReachBottom	function	页面上拉触底事件的处理函数
onTabItemTap	function	当前是 tab 页时，点击 tab 时触发
onShareAppMessage	function	用户点击右上角转发
onPageScroll	function	页面滚动触发事件的处理函数
其他	any	开发者可以添加任意的函数或数据到 Object 参数中，在页面的函数中用 this 可以访问

#onShareAppMessage

监听用户点击右上角菜单“转发”按钮的行为，并自定义转发内容。

参数

参数	类型	说明	最低版本
title	String		1.0.0
desc	String		1.0.0
imageUrl	String		1.0.0
path	String		1.0.0
from	String	目前只有'menu'值	1.0.0
webViewUrl	String	页面中包含 WebView 组件时，返回当前 WebView 的url	1.0.0

此事件处理函数需要 return 一个 Object，用于自定义转发内容。返回数据最终透传给宿主app。

Page({
  onShareAppMessage: function (res) {
    console.log(res);
    // {
    //     title: '原始标题',
    //     desc: '原始描述'
    //     imageUrl: ***,
    //     path: '原始路径',
    //     from: 'menu',
    //     webViewUrl: ***
    // }

    return {
        title: '开发者自定义转发标题', // 例如返回了title，那么透传给app的是该值。如果没有返回title，透传给app的是参数中的title值
        /*
            如果宿主app有分享到微信小程序等功能，可以在appInfo字段返回微信小程序appid等
        */
        appInfo: {
            appId: 'gh_*******' // 微信小程序appid
        }
    }
  }})
        已复制代码

开发者通过onShareAppMessage返回以上数据之后，宿主app接收到的数据格式如下：

{
    "appTitle": "小程序标题",
    "appAvatar": "小程序图标",
    "appId": "宿主app内小程序id",
    "userId": "用户信息",
    "params": { // params即为小程序开发者返回数据，这里做透传
        "title": "开发者自定义转发标题",
        "desc": "原始描述",
        "imageUrl": "",
        "path": "原始路径",
        "appinfo": {
            "appId": "gh_*******"
        }
    }}
        已复制代码

#2. data

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

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

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

示例代码

<view>{{text}}</view><view>{{array[0].msg}}</view>
        已复制代码

Page({
  data: {
    text: 'init data',
    array: [{msg: '1'}, {msg: '2'}]
  }})
        已复制代码

#3. 生命周期回调函数

#onLoad(Object query)

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

#onShow()

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

#onReady()

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

#onHide()

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

#onUnload()

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

#4. 页面事件处理函数

#onPullDownRefresh()

监听用户下拉刷新事件。

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

#onReachBottom()

监听用户上拉触底事件。

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

#onPageScroll(Object object)

监听用户滑动页面事件。

参数 Object object

属性	类型	说明
scrollTop	Number	页面在垂直方向已滚动的距离（单位px）

注意

请只在需要的时候才在 page 中定义此方法，不要定义空方法。以减少不必要的事件派发对渲染层-逻辑层通信的影响。
请避免在 onPageScroll 中过于频繁的执行 setData 等引起逻辑层-渲染层通信的操作。尤其是每次传输大量数据，会影响通信耗时。

#5. 组件事件处理函数

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 的值（同步）。

参数说明

字段	类型	必填	描述
data	Object	是	这次要改变的数据
callback	Function	否	setData引起的界面更新渲染完毕后的回调函数

Object 以 key: value 的形式表示，将 this.data 中的 key 对应的值改变成 value。
其中 key 可以以数据路径的形式给出，支持改变数组中的某一项或对象的某个属性，如 array[2].message，a.b.c.d，并且不需要在 this.data 中预先定义。

注意

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

示例代码

<!--index.fxml--><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.jsPage({
  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'
    })
  }})
        已复制代码

#PageObject[] getCurrentPages()

获取当前页面栈。数组中第一个元素为首页，最后一个元素为当前页面。

注意

不要尝试修改页面栈，会导致路由以及页面状态错误。
不要在 App.onLaunch 的时候调用 getCurrentPages()，此时 page 还没有生成。

标签：参数程序代码小程序数据

关于小程序获取用户位置授权的全面讲述

38 2024-07-04

那些年微信小程序仿网易云音乐相关播放的探究

38 2024-07-04

那些年有关微信小程序仿网易云音乐实时搜索功能

38 2024-07-04

发表评论

暂时没有评论，来抢沙发吧~

小程序页面框架接口参数（附代码）

Page

#1. 参数

#onShareAppMessage

#2. data

#3. 生命周期回调函数

#onLoad(Object query)

#onShow()

#onReady()

#onHide()

#onUnload()

#4. 页面事件处理函数

#onPullDownRefresh()

#onReachBottom()

#onPageScroll(Object object)

#5. 组件事件处理函数

#Page.route

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

#PageObject[] getCurrentPages()

最近发表

更多内容

推荐文章

解决方案

热评文章