微信小程序（基础、路由、界面）接口文档整理

青旅半醒 2022-02-21 04:28 286阅读 0赞

接口文档

**系统：**

wx.canIUse   判断小程序的API，回调，参数，组件等是否在当前版本可用

wx.getSystemInfoSync() / wx.getSystemInfo(Object object)    获取设备品牌，型号，像素比，屏幕宽高，可使用窗口宽高，状态栏高度，允许微信使用相册，摄像头，定位，麦克风。通知，蓝牙，地理位置，wifi开关等信息

**生命周期**：

wx.getLaunchOptionsSync()    获取小程序启动时的参数。与 [`App.onLaunch`][App.onLaunch] 的回调参数一致。

**应用级事件：**

wx.onPageNotFound(function callback)     监听小程序要打开的页面不存在事件。该事件与 [`App.onPageNotFound`][App.onPageNotFound] 的回调时机一致。

wx.offPageNotFound(function callback)   取消监听小程序要打开的页面不存在事件

wx.onError(function callback)   监听小程序错误事件。如脚本错误或 API 调用报错等。该事件与 [`App.onError`][App.onError] 的回调时机与参数一致。

wwx.offError(function callback)   取消监听小程序错误事件。

wx.onAudioInterruptionEnd(function callback)    监听音频中断结束事件。在收到 onAudioInterruptionBegin 事件之后，小程序内所有音频会暂停，收到此事件之后才可再次播放成功

wx.offAudioInterruptionEnd(function callback)   取消监听音频中断结束事件

wx.onAudioInterruptionBegin(function callback)   监听音频因为受到系统占用而被中断开始事件。以下场景会触发此事件：闹钟、电话、FaceTime 通话、微信语音聊天、微信视频聊天。此事件触发后，小程序内所有音频会暂停。

wx.offAudioInterruptionBegin(function callback)   取消监听音频因为受到系统占用而被中断开始事件

wx.onAppShow(function callback)    监听小程序切前台事件。该事件与 [`App.onShow`][App.onShow] 的回调参数一致。

wx.offAppShow(function callback)   取消监听小程序切前台事件

wx.onAppHide(function callback)   监听小程序切后台事件。该事件与 [`App.onHide`][App.onHide] 的回调时机一致。

wx.offAppHide(function callback)   取消监听小程序切后台事件

**路由**

wx.switchTab(Object object)    跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面

wx.reLaunch(Object object)   关闭所有页面，打开到应用内的某个页面

wx.redirectTo(Object object)   关闭当前页面，跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面。

wx.navigateTo(Object object)   保留当前页面，跳转到应用内的某个页面。但是不能跳到 tabbar 页面。使用 [wx.navigateBack][] 可以返回到原页面。小程序中页面栈最多十层。

wx.navigateBack(Object object)   关闭当前页面，返回上一页面或多级页面。可通过 [`getCurrentPages`][getCurrentPages] 获取当前的页面栈，决定需要返回几层。

**交互**

wx.showToast(Object object)    显示消息提示框

wx.showModal(Object object)    显示模态对话框

wx.showLoading(Object object)   显示 loading 提示框。需主动调用 wx.hideLoading 才能关闭提示框

wx.showActionSheet(Object object)   显示操作菜单

wx.hideToast(Object object)    隐藏消息提示框

wx.hideLoading(Object object)    隐藏 loading 提示框

**导航栏**

wx.showNavigationBarLoading(Object object)   在当前页面显示导航条加载动画

wx.setNavigationBarTitle(Object object)   动态设置当前页面的标题

wx.setNavigationBarColor(Object object)   设置页面导航条颜色

wx.hideNavigationBarLoading(Object object)   在当前页面隐藏导航条加载动画

**背景**

wx.setBackgroundTextStyle(Object object)   动态设置下拉背景字体、loading 图的样式

wx.setBackgroundColor(Object object)   动态设置窗口的背景色

**TabBar**

wx.showTabBarRedDot(Object object)   显示 tabBar 某一项的右上角的红点

wx.showTabBar(Object object)   显示 tabBar

wx.setTabBarStyle(Object object)   动态设置 tabBar 的整体样式

wx.setTabBarItem(Object object)   动态设置 tabBar 某一项的内容

wx.setTabBarBadge(Object object)   为 tabBar 某一项的右上角添加文本

wx.removeTabBarBadge(Object object)  移除 tabBar 某一项右上角的文本

wx.hideTabBarRedDot(Object object)   隐藏 tabBar 某一项的右上角的红点

wx.hideTabBar(Object object)   隐藏 tabBar

**下拉刷新**

wx.stopPullDownRefresh(Object object)   停止当前页面下拉刷新。

wx.startPullDownRefresh(Object object)   开始下拉刷新。调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。

**滚动**

wx.pageScrollTo(Object object)   将页面滚动到目标位置

**动画**

wx.createAnimation(Object object)   创建一个动画实例 [animation][]。调用实例的方法来描述动画。最后通过动画实例的 export 方法导出动画数据传递给组件的 animation 属性。

**菜单**

wx.getMenuButtonBoundingClientRect()  获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。

**窗口**

wx.onWindowResize(function callback)    监听窗口尺寸变化事件

wx.offWindowResize(function callback)    取消监听窗口尺寸变化事件

[App.onLaunch]: https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onlaunchobject-object
[App.onPageNotFound]: https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onpagenotfoundobject-object
[App.onError]: https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onerrorstring-error
[App.onShow]: https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onshowobject-object
[App.onHide]: https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html#onhide
[wx.navigateBack]: https://developers.weixin.qq.com/miniprogram/dev/api/wx.navigateBack.html
[getCurrentPages]: https://developers.weixin.qq.com/miniprogram/dev/reference/api/getCurrentPages.html
[animation]: https://developers.weixin.qq.com/miniprogram/dev/api/Animation.html