概览

小程序

名称

功能说明

my.getAppIdSync

同步获取小程序 appId。

my.onAppHide

监听小程序切后台事件。

my.offAppHide

取消监听小程序切后台事件。

my.onAppShow

监听小程序切前台事件。

my.offAppShow

取消监听小程序切前台事件。

界面

导航栏

名称

功能说明

my.getTitleColor

获取导航栏背景色。

my.hideBackHome

隐藏 TitleBar 上的返回首页图标,和通用菜单中的返回首页功能。

my.showNavigationBarLoading

在当前页面显示导航条加载动画。

my.hideNavigationBarLoading

在当前页面隐藏导航条加载动画。

my.setNavigationBar

设置导航栏文字及样式。

TabBar

名称

功能说明

my.hideTabBar

隐藏 tabBar。

my.hideTabBarRedDot

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

my.removeTabBarBadge

移除 tabBar 某一项右上角的文本。

my.setTabBarBadge

为 tabBar 某一项的右上角添加文本。

my.setTabBarItem

动态设置 tabBar 某一项的内容。

my.setTabBarStyle

动态设置 tabBar 的整体样式。

my.showTabBar

显示 tabBar。

my.showTabBarRedDot

显示 tabBar 某一项的右上角的红点。

onTabItemTap

点击 tab 时触发。

TabBar 常见问题

对 TabBar 标签的常见问题解答。

路由

名称

功能说明

my.switchTab

跳转到指定 tabBar 页面,并关闭其他所有非 tabBar 页面。

my.reLaunch

关闭当前所有页面,跳转到应用内的某个指定页面。

my.redirectTo

关闭当前页面,跳转到应用内的某个指定页面。

my.navigateTo

从当前页面,跳转到应用内的某个指定页面,以使用 my.navigateBack 返回到原来页面。

my.navigateBack

关闭当前页面,返回上一级或多级页面。

路由 FAQ

对路由的常见问题解答。

交互反馈

名称

功能说明

my.alert

警告框。

my.confirm

确认框。

my.prompt

弹出一个对话框,让用户在对话框内输入文本。

my.showToast

显示一个弱提示,可选择多少秒之后消失。

my.hideToast

隐藏弱提示。

my.showLoading

显示加载提示。

my.hideLoading

隐藏加载提示。

my.showActionSheet

显示操作菜单。

下拉刷新

名称

功能说明

onPullDownRefresh

监听该页面用户的下拉刷新事件。

my.startPullDownRefresh

启用当前页面的下拉刷新。

my.stopPullDownRefresh

停用当前页面的下拉刷新。

选择日期

名称

功能说明

my.datePicker

打开日期选择列表。

动画

名称

功能说明

my.createAnimation

创建动画实例。

画布

名称

功能说明

my.createCanvasContext

创建 canvas 绘图上下文。

滚动

名称

功能说明

my.pageScrollTo

滚动到页面的目标位置。

设置窗口背景

名称

功能说明

my.setBackgroundColor

动态设置窗口的背景色。

my.setBackgroundTextStyle

动态设置下拉背景字体、loading 图的样式。

字体

名称

功能说明

my.loadFontFace

动态加载网络字体。

缓存

名称

功能说明

my.setStorage

将数据存储在本地缓存中指定的 key 中的异步接口。

my.setStorageSync

同步将数据存储在本地缓存中指定的 key 中的同步接口。

my.getStorage

获取缓存数据的异步接口。

my.getStorageSync

获取缓存数据的同步接口。

my.removeStorage

删除缓存数据的异步接口。

my.removeStorageSync

删除缓存数据的同步接口。

my.clearStorage

清除本地数据缓存的异步接口。

my.clearStorageSync

清除本地数据缓存的同步接口。

my.getStorageInfo

获取当前 storage 的相关信息的异步接口。

my.getStorageInfoSync

获取当前 storage 相关信息的同步接口。

网络

名称

功能说明

my.request

小程序网络请求。

my.uploadFile

上传本地资源到开发者服务器。

my.downloadFile

下载文件资源到本地。

my.connectSocket

创建一个 WebSocket 的连接。

my.onSocketOpen

监听 WebSocket 连接打开事件。

my.offSocketOpen

取消监听 WebSocket 连接打开事件。

my.onSocketError

监听 WebSocket 错误。

my.offSocketError

取消监听 WebSocket 错误。

my.sendSocketMessage

通过 WebSocket 连接发送数据。

my.onSocketMessage

监听 WebSocket 接受到服务器的消息事件。

my.closeSocket

关闭 WebSocket 连接。

my.onSocketClose

监听 WebSocket 关闭。

my.offSocketClose

取消监听WebSocket关闭。