微信小程序提供了丰富的 API,用于实现页面渲染、数据交互、网络请求、本地存储、设备信息获取等功能。以下是一些常用的微信小程序 API 分类及其功能简介:
1. 页面相关 API
页面路由
wx.navigateTo:跳转到新页面
wx.redirectTo:关闭当前页面,跳转到新页面
wx.navigateBack:关闭当前页面,返回上一页面或多级页面
wx.reLaunch:关闭所有页面,打开到应用内的某个页面
页面生命周期
onLoad:监听页面加载
onShow:监听页面显示
onReady:监听页面初次渲染完成
onHide:监听页面隐藏
onUnload:监听页面卸载
2. 网络请求 API
发起请求
wx.request:发起 HTTPS 网络请求
wx.uploadFile:上传文件
wx.downloadFile:下载文件
3. 数据缓存 API
本地数据存储
wx.setStorage:异步将数据存储在本地缓存中
wx.getStorage:异步获取本地缓存的数据
wx.removeStorage:异步移除本地缓存的数据
wx.clearStorage:清理本地数据缓存
4. 界面交互 API
消息提示
wx.showToast:显示消息提示框
wx.showLoading:显示 loading 提示框
wx.showModal:显示模态对话框
wx.showActionSheet:显示操作菜单
界面导航
wx.setNavigationBarTitle:动态设置当前页面的标题
wx.setNavigationBarColor:设置导航条颜色
wx.showTabBar:显示 tabBar
wx.hideTabBar:隐藏 tabBar
5. 设备相关 API
系统信息
wx.getSystemInfo:获取系统信息
wx.getSystemInfoSync:同步获取系统信息
网络状态
wx.getNetworkType:获取网络类型
wx.onNetworkStatusChange:监听网络状态变化
6. 多媒体 API
音频
wx.createInnerAudioContext:创建并返回内部 audio 上下文 InnerAudioContext 对象
wx.createAudioContext:通过 audioId 获得 audio 组件实例
图片
wx.chooseImage:从本地相册选择图片或使用相机拍照
wx.previewImage:预览图片
wx.getImageInfo:获取图片信息
7. 位置 API
获取位置
wx.getLocation:获取当前的地理位置、速度
wx.chooseLocation:打开地图选择位置
8. 其他常用 API
用户信息
wx.getUserInfo:获取用户信息
wx.login:调用接口获取登录凭证(code)
小程序生命周期
App:注册小程序示例
Page:注册小程序页面
9. 事件处理 API
事件监听
bind:绑定一个事件处理函数到组件上
catch:绑定一个事件处理函数到组件上,当事件触发时阻止事件冒泡到父组件