ylbtech-微信-小程序-开发文档-开发：开发

1. 开发指南返回顶部

1.1、

小程序提供了一个简单、高效的应用开发框架和丰富的组件及API，帮助开发者在微信中开发具有原生 APP 体验的服务。

本章分主题的介绍了小程序的开发语言、框架、能力、调试等内容，帮助开发者快速全面的了解小程序开发的方方面面。

想要更具体了了关于框架、组件、API的详细内容，请参考对应的参考文档：

小程序框架参考文档
小程序组件参考文档
小程序 API 参考文档
小程序服务端 API 参考文档

1.2、https://developers.weixin.qq.com/miniprogram/dev/framework/2、

2. 小程序框架参考文档返回顶部

1.1、

本章为小程序框架配置、框架接口、WXML 和 WXS 等的参考文档，关于组件和 API 的详细参考文档请参见：

小程序组件参考文档
小程序 API 参考文档
小程序服务端 API 参考文档

1.2、https://developers.weixin.qq.com/miniprogram/dev/reference/2、

3. 组件返回顶部

1.1、

视图容器

名称	功能说明
movable-view	可移动的视图容器，在页面中可以拖拽滑动
cover-image	覆盖在原生组件之上的图片视图
cover-view	覆盖在原生组件之上的文本视图
movable-area	movable-view的可移动区域
scroll-view	可滚动视图区域
swiper	滑块视图容器
swiper-item	仅可放置在swiper组件中，宽高自动设置为100%
view	视图容器

基础内容

名称	功能说明
icon	图标
progress	进度条
rich-text	富文本
text	文本

表单组件

名称	功能说明
button	按钮
checkbox	多选项目
checkbox-group	多项选择器，内部由多个checkbox组成
editor	富文本编辑器，可以对图片、文字进行编辑
form	表单
input	输入框
label	用来改进表单组件的可用性
picker	从底部弹起的滚动选择器
picker-view	嵌入页面的滚动选择器
picker-view-column	滚动选择器子项
radio	单选项目
radio-group	单项选择器，内部由多个 radio 组成
slider	滑动选择器
switch	开关选择器
textarea	多行输入框

名称	功能说明
functional-page-navigator	仅在插件中有效，用于跳转到插件功能页
navigator	页面链接

媒体组件

名称	功能说明
audio	音频
camera	系统相机
image	图片
live-player	实时音视频播放
live-pusher	实时音视频录制
video	视频

地图

名称	功能说明
map	地图

画布

名称	功能说明
canvas	画布

开放能力

名称	功能说明
web-view	承载网页的容器
ad	Banner 广告
official-account	公众号关注组件
open-data	用于展示微信开放的数据

原生组件说明

名称	功能说明
native-component	## 原生组件

小程序中的部分组件是由客户端创建的原生组件，这些组件有：

camera
canvas
input（仅在focus时表现为原生组件）
live-player
live-pusher
map
textarea
video

原生组件的使用限制

由于原生组件脱离在 WebView 渲染流程外，因此在使用时有以下限制：

原生组件的层级是最高的，所以页面中的其他组件无论设置 z-index 为多少，都无法盖在原生组件上 |

无障碍访问

名称	功能说明
aria-component	## 无障碍访问
为了更好地满足视障人士对于小程序的访问需求，基础库自2.7.1起，支持部分ARIA标签

1.2、https://developers.weixin.qq.com/miniprogram/dev/component/2、

4. API返回顶部

1.1、

基础

名称	功能说明
wx.canIUse	判断小程序的API，回调，参数，组件等是否在当前版本可用
wx.base64ToArrayBuffer	将 Base64 字符串转成 ArrayBuffer 对象
wx.arrayBufferToBase64	将 ArrayBuffer 对象转成 Base64 字符串

系统

系统信息

名称	功能说明
wx.getSystemInfoSync	wx.getSystemInfo 的同步版本
wx.getSystemInfo	获取系统信息

更新

名称	功能说明
wx.getUpdateManager	获取全局唯一的版本更新管理器，用于管理小程序更新

UpdateManager

名称	功能说明
UpdateManager.applyUpdate	强制小程序重启并使用新版本
UpdateManager.onCheckForUpdate	监听向微信后台请求检查更新结果事件
UpdateManager.onUpdateFailed	监听小程序更新失败事件
UpdateManager.onUpdateReady	监听小程序有版本更新事件

小程序

生命周期

名称	功能说明
wx.getLaunchOptionsSync	获取小程序启动时的参数

应用级事件

名称	功能说明
wx.onPageNotFound	监听小程序要打开的页面不存在事件
wx.onError	监听小程序错误事件
wx.onAudioInterruptionEnd	监听音频中断结束事件
wx.onAudioInterruptionBegin	监听音频因为受到系统占用而被中断开始事件
wx.onAppShow	监听小程序切前台事件
wx.onAppHide	监听小程序切后台事件
wx.offPageNotFound	取消监听小程序要打开的页面不存在事件
wx.offError	取消监听小程序错误事件
wx.offAudioInterruptionEnd	取消监听音频中断结束事件
wx.offAudioInterruptionBegin	取消监听音频因为受到系统占用而被中断开始事件
wx.offAppShow	取消监听小程序切前台事件
wx.offAppHide	取消监听小程序切后台事件

调试

名称	功能说明
wx.setEnableDebug	设置是否打开调试开关
wx.getLogManager	获取日志管理器对象

console

名称	功能说明
console.debug	向调试面板中打印 debug 日志
console.error	向调试面板中打印 error 日志
console.group	在调试面板中创建一个新的分组
console.groupEnd	结束由 console.group 创建的分组
console.info	向调试面板中打印 info 日志
console.log	向调试面板中打印 log 日志
console.warn	向调试面板中打印 warn 日志

LogManager

名称	功能说明
LogManager.debug	写 debug 日志
LogManager.info	写 info 日志
LogManager.log	写 log 日志
LogManager.warn	写 warn 日志

定时器

名称	功能说明
clearInterval	取消由 setInterval 设置的定时器
clearTimeout	取消由 setTimeout 设置的定时器
setInterval	设定一个定时器
setTimeout	设定一个定时器

路由

名称	功能说明
wx.switchTab	跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
wx.reLaunch	关闭所有页面，打开到应用内的某个页面
wx.redirectTo	关闭当前页面，跳转到应用内的某个页面
wx.navigateTo	保留当前页面，跳转到应用内的某个页面
wx.navigateBack	关闭当前页面，返回上一页面或多级页面

界面

交互

名称	功能说明
wx.showToast	显示消息提示框
wx.showModal	显示模态对话框
wx.showLoading	显示 loading 提示框
wx.showActionSheet	显示操作菜单
wx.hideToast	隐藏消息提示框
wx.hideLoading	隐藏 loading 提示框

导航栏

名称	功能说明
wx.showNavigationBarLoading	在当前页面显示导航条加载动画
wx.setNavigationBarTitle	动态设置当前页面的标题
wx.setNavigationBarColor	设置页面导航条颜色
wx.hideNavigationBarLoading	在当前页面隐藏导航条加载动画

背景

名称	功能说明
wx.setBackgroundTextStyle	动态设置下拉背景字体、loading 图的样式
wx.setBackgroundColor	动态设置窗口的背景色

Tab Bar

名称	功能说明
wx.showTabBarRedDot	显示 tabBar 某一项的右上角的红点
wx.showTabBar	显示 tabBar
wx.setTabBarStyle	动态设置 tabBar 的整体样式
wx.setTabBarItem	动态设置 tabBar 某一项的内容，`2.7.0` 起图片支持临时文件和网络文件
wx.setTabBarBadge	为 tabBar 某一项的右上角添加文本
wx.removeTabBarBadge	移除 tabBar 某一项右上角的文本
wx.hideTabBarRedDot	隐藏 tabBar 某一项的右上角的红点
wx.hideTabBar	隐藏 tabBar

字体

名称	功能说明
wx.loadFontFace	动态加载网络字体

下拉刷新

名称	功能说明
wx.stopPullDownRefresh	停止当前页面下拉刷新
wx.startPullDownRefresh	开始下拉刷新

滚动

名称	功能说明
wx.pageScrollTo	将页面滚动到目标位置

动画

名称	功能说明
wx.createAnimation	创建一个动画实例 animation

Animation

名称	功能说明
Animation.height	设置高度
Animation.left	设置 left 值
Animation.matrix	同 transform-function matrix
Animation.matrix3d	同 transform-function matrix3d
Animation.opacity	设置透明度
Animation.right	设置 right 值
Animation.rotate	从原点顺时针旋转一个角度
Animation.rotate3d	从 X 轴顺时针旋转一个角度
Animation.rotateX	从 X 轴顺时针旋转一个角度
Animation.rotateY	从 Y 轴顺时针旋转一个角度
Animation.rotateZ	从 Z 轴顺时针旋转一个角度
Animation.scale	缩放
Animation.scale3d	缩放
Animation.scaleX	缩放 X 轴
Animation.scaleY	缩放 Y 轴
Animation.scaleZ	缩放 Z 轴
Animation.skew	对 X、Y 轴坐标进行倾斜
Animation.skewX	对 X 轴坐标进行倾斜
Animation.skewY	对 Y 轴坐标进行倾斜
Animation.step	表示一组动画完成
Animation.top	设置 top 值
Animation.translate	平移变换
Animation.translate3d	对 xyz 坐标进行平移变换
Animation.translateX	对 X 轴平移
Animation.translateY	对 Y 轴平移
Animation.translateZ	对 Z 轴平移
Animation.width	设置宽度
Animation.backgroundColor	设置背景色
Animation.bottom	设置 bottom 值
Animation.export	导出动画队列

置顶

名称	功能说明
wx.setTopBarText	动态设置置顶栏文字内容

自定义组件

名称	功能说明
wx.nextTick	延迟一部分操作到下一个时间片再执行

菜单

名称	功能说明
wx.getMenuButtonBoundingClientRect	获取菜单按钮（右上角胶囊按钮）的布局位置信息

窗口

名称	功能说明
wx.onWindowResize	监听窗口尺寸变化事件
wx.offWindowResize	取消监听窗口尺寸变化事件

键盘

名称	功能说明
wx.onKeyboardHeightChange	监听键盘高度变化
wx.getSelectedTextRange	在input、textarea等focus之后，获取输入框的光标位置

网络

发起请求

名称	功能说明
wx.request	发起 HTTPS 网络请求

RequestTask

名称	功能说明
RequestTask.abort	中断请求任务
RequestTask.offHeadersReceived	取消监听 HTTP Response Header 事件
RequestTask.onHeadersReceived	监听 HTTP Response Header 事件

下载

名称	功能说明
wx.downloadFile	下载文件资源到本地

DownloadTask

名称	功能说明
DownloadTask.abort	中断下载任务
DownloadTask.offHeadersReceived	取消监听 HTTP Response Header 事件
DownloadTask.offProgressUpdate	取消监听下载进度变化事件
DownloadTask.onHeadersReceived	监听 HTTP Response Header 事件
DownloadTask.onProgressUpdate	监听下载进度变化事件

上传

名称	功能说明
wx.uploadFile	将本地资源上传到服务器

UploadTask

名称	功能说明
UploadTask.abort	中断上传任务
UploadTask.offHeadersReceived	取消监听 HTTP Response Header 事件
UploadTask.offProgressUpdate	取消监听上传进度变化事件
UploadTask.onHeadersReceived	监听 HTTP Response Header 事件
UploadTask.onProgressUpdate	监听上传进度变化事件

WebSocket

名称	功能说明
wx.sendSocketMessage	通过 WebSocket 连接发送数据
wx.onSocketOpen	监听 WebSocket 连接打开事件
wx.onSocketMessage	监听 WebSocket 接受到服务器的消息事件
wx.onSocketError	监听 WebSocket 错误事件
wx.onSocketClose	监听 WebSocket 连接关闭事件
wx.connectSocket	创建一个 WebSocket 连接
wx.closeSocket	关闭 WebSocket 连接

SocketTask

名称	功能说明
SocketTask.close	关闭 WebSocket 连接
SocketTask.onClose	监听 WebSocket 连接关闭事件
SocketTask.onError	监听 WebSocket 错误事件
SocketTask.onMessage	监听 WebSocket 接受到服务器的消息事件
SocketTask.onOpen	监听 WebSocket 连接打开事件
SocketTask.send	通过 WebSocket 连接发送数据

mDNS

名称	功能说明
wx.stopLocalServiceDiscovery	停止搜索 mDNS 服务
wx.startLocalServiceDiscovery	开始搜索局域网下的 mDNS 服务
wx.onLocalServiceResolveFail	监听 mDNS 服务解析失败的事件
wx.onLocalServiceLost	监听 mDNS 服务离开的事件
wx.onLocalServiceFound	监听 mDNS 服务发现的事件
wx.onLocalServiceDiscoveryStop	监听 mDNS 服务停止搜索的事件
wx.offLocalServiceResolveFail	取消监听 mDNS 服务解析失败的事件
wx.offLocalServiceLost	取消监听 mDNS 服务离开的事件
wx.offLocalServiceFound	取消监听 mDNS 服务发现的事件
wx.offLocalServiceDiscoveryStop	取消监听 mDNS 服务停止搜索的事件

UDP 通信

名称	功能说明
wx.createUDPSocket	创建一个 UDP Socket 实例

UDPSocket

名称	功能说明
UDPSocket.bind	绑定一个系统随机分配的可用端口
UDPSocket.close	关闭 UDP Socket 实例，相当于销毁
UDPSocket.offClose	取消监听关闭事件
UDPSocket.offError	取消监听错误事件
UDPSocket.offListening	取消监听开始监听数据包消息的事件
UDPSocket.offMessage	取消监听收到消息的事件
UDPSocket.onClose	监听关闭事件
UDPSocket.onError	监听错误事件
UDPSocket.onListening	监听开始监听数据包消息的事件
UDPSocket.onMessage	监听收到消息的事件
UDPSocket.send	向指定的 IP 和 port 发送消息

数据缓存

名称	功能说明
wx.setStorageSync	wx.setStorage 的同步版本
wx.setStorage	将数据存储在本地缓存中指定的 key 中
wx.removeStorageSync	wx.removeStorage 的同步版本
wx.removeStorage	从本地缓存中移除指定 key
wx.getStorageSync	wx.getStorage 的同步版本
wx.getStorageInfoSync	wx.getStorageInfo 的同步版本
wx.getStorageInfo	异步获取当前storage的相关信息
wx.getStorage	从本地缓存中异步获取指定 key 的内容
wx.clearStorageSync	wx.clearStorage 的同步版本
wx.clearStorage	清理本地数据缓存

媒体

地图

名称	功能说明
wx.createMapContext	创建 map 上下文 MapContext 对象

MapContext

名称	功能说明
MapContext.getCenterLocation	获取当前地图中心的经纬度
MapContext.getRegion	获取当前地图的视野范围
MapContext.getScale	获取当前地图的缩放级别
MapContext.includePoints	缩放视野展示所有经纬度
MapContext.moveToLocation	将地图中心移动到当前定位点
MapContext.translateMarker	平移marker，带动画

图片

名称	功能说明
wx.saveImageToPhotosAlbum	保存图片到系统相册
wx.previewImage	在新页面中全屏预览图片
wx.getImageInfo	获取图片信息
wx.compressImage	压缩图片接口，可选压缩质量
wx.chooseMessageFile	从客户端会话选择文件
wx.chooseImage	从本地相册选择图片或使用相机拍照

视频

名称	功能说明
wx.saveVideoToPhotosAlbum	保存视频到系统相册
wx.createVideoContext	创建 video 上下文 VideoContext 对象
wx.chooseVideo	拍摄视频或从手机相册中选视频

VideoContext

名称	功能说明
VideoContext.exitFullScreen	退出全屏
VideoContext.hideStatusBar	隐藏状态栏，仅在iOS全屏下有效
VideoContext.pause	暂停视频
VideoContext.play	播放视频
VideoContext.playbackRate	设置倍速播放
VideoContext.requestFullScreen	进入全屏
VideoContext.seek	跳转到指定位置
VideoContext.sendDanmu	发送弹幕
VideoContext.showStatusBar	显示状态栏，仅在iOS全屏下有效
VideoContext.stop	停止视频

音频

名称	功能说明
wx.stopVoice	结束播放语音
wx.setInnerAudioOption	设置 InnerAudioContext 的播放选项
wx.playVoice	开始播放语音
wx.pauseVoice	暂停正在播放的语音
wx.getAvailableAudioSources	获取当前支持的音频输入源
wx.createInnerAudioContext	创建内部 audio 上下文 InnerAudioContext 对象
wx.createAudioContext	创建 audio 上下文 AudioContext 对象

InnerAudioContext

名称	功能说明
InnerAudioContext.destroy	销毁当前实例
InnerAudioContext.offCanplay	取消监听音频进入可以播放状态的事件
InnerAudioContext.offEnded	取消监听音频自然播放至结束的事件
InnerAudioContext.offError	取消监听音频播放错误事件
InnerAudioContext.offPause	取消监听音频暂停事件
InnerAudioContext.offPlay	取消监听音频播放事件
InnerAudioContext.offSeeked	取消监听音频完成跳转操作的事件
InnerAudioContext.offSeeking	取消监听音频进行跳转操作的事件
InnerAudioContext.offStop	取消监听音频停止事件
InnerAudioContext.offTimeUpdate	取消监听音频播放进度更新事件
InnerAudioContext.offWaiting	取消监听音频加载中事件
InnerAudioContext.onCanplay	监听音频进入可以播放状态的事件
InnerAudioContext.onEnded	监听音频自然播放至结束的事件
InnerAudioContext.onError	监听音频播放错误事件
InnerAudioContext.onPause	监听音频暂停事件
InnerAudioContext.onPlay	监听音频播放事件
InnerAudioContext.onSeeked	监听音频完成跳转操作的事件
InnerAudioContext.onSeeking	监听音频进行跳转操作的事件
InnerAudioContext.onStop	监听音频停止事件
InnerAudioContext.onTimeUpdate	监听音频播放进度更新事件
InnerAudioContext.onWaiting	监听音频加载中事件
InnerAudioContext.pause	暂停
InnerAudioContext.play	播放
InnerAudioContext.seek	跳转到指定位置
InnerAudioContext.stop	停止

AudioContext

名称	功能说明
AudioContext.pause	暂停音频
AudioContext.play	播放音频
AudioContext.seek	跳转到指定位置
AudioContext.setSrc	设置音频地址

背景音频

名称	功能说明
wx.stopBackgroundAudio	停止播放音乐
wx.seekBackgroundAudio	控制音乐播放进度
wx.playBackgroundAudio	使用后台播放器播放音乐
wx.pauseBackgroundAudio	暂停播放音乐
wx.onBackgroundAudioStop	监听音乐停止事件
wx.onBackgroundAudioPlay	监听音乐播放事件
wx.onBackgroundAudioPause	监听音乐暂停事件
wx.getBackgroundAudioPlayerState	获取后台音乐播放状态
wx.getBackgroundAudioManager	获取全局唯一的背景音频管理器

BackgroundAudioManager

名称	功能说明
BackgroundAudioManager.onPlay	监听背景音频播放事件
BackgroundAudioManager.onPrev	监听用户在系统音乐播放面板点击上一曲事件（仅iOS）
BackgroundAudioManager.onSeeked	监听背景音频完成跳转操作事件
BackgroundAudioManager.onSeeking	监听背景音频开始跳转操作事件
BackgroundAudioManager.onStop	监听背景音频停止事件
BackgroundAudioManager.onTimeUpdate	监听背景音频播放进度更新事件，只有小程序在前台时会回调
BackgroundAudioManager.onWaiting	监听音频加载中事件
BackgroundAudioManager.pause	暂停音乐
BackgroundAudioManager.play	播放音乐
BackgroundAudioManager.seek	跳转到指定位置
BackgroundAudioManager.stop	停止音乐
BackgroundAudioManager.onCanplay	监听背景音频进入可播放状态事件
BackgroundAudioManager.onEnded	监听背景音频自然播放结束事件
BackgroundAudioManager.onError	监听背景音频播放错误事件
BackgroundAudioManager.onNext	监听用户在系统音乐播放面板点击下一曲事件（仅iOS）
BackgroundAudioManager.onPause	监听背景音频暂停事件

实时音视频

名称	功能说明
wx.createLivePusherContext	创建 live-pusher 上下文 LivePusherContext 对象
wx.createLivePlayerContext	创建 live-player 上下文 LivePlayerContext 对象

LivePlayerContext

名称	功能说明
LivePlayerContext.exitFullScreen	退出全屏
LivePlayerContext.mute	静音
LivePlayerContext.pause	暂停
LivePlayerContext.play	播放
LivePlayerContext.requestFullScreen	进入全屏
LivePlayerContext.resume	恢复
LivePlayerContext.snapshot	截图
LivePlayerContext.stop	停止

LivePusherContext

名称	功能说明
LivePusherContext.pause	暂停推流
LivePusherContext.pauseBGM	暂停背景音
LivePusherContext.playBGM	播放背景音
LivePusherContext.resume	恢复推流
LivePusherContext.resumeBGM	恢复背景音
LivePusherContext.setBGMVolume	设置背景音音量
LivePusherContext.snapshot	快照
LivePusherContext.start	开始推流，同时开启摄像头预览
LivePusherContext.startPreview	开启摄像头预览
LivePusherContext.stop	停止推流，同时停止摄像头预览
LivePusherContext.stopBGM	停止背景音
LivePusherContext.stopPreview	关闭摄像头预览
LivePusherContext.switchCamera	切换前后摄像头
LivePusherContext.toggleTorch	切换手电筒

录音

名称	功能说明
wx.stopRecord	停止录音
wx.startRecord	开始录音
wx.getRecorderManager	获取全局唯一的录音管理器 RecorderManager

RecorderManager

名称	功能说明
RecorderManager.onError	监听录音错误事件
RecorderManager.onFrameRecorded	监听已录制完指定帧大小的文件事件
RecorderManager.onInterruptionBegin	监听录音因为受到系统占用而被中断开始事件
RecorderManager.onInterruptionEnd	监听录音中断结束事件
RecorderManager.onPause	监听录音暂停事件
RecorderManager.onResume	监听录音继续事件
RecorderManager.onStart	监听录音开始事件
RecorderManager.onStop	监听录音结束事件
RecorderManager.pause	暂停录音
RecorderManager.resume	继续录音
RecorderManager.start	开始录音
RecorderManager.stop	停止录音

相机

名称	功能说明
wx.createCameraContext	创建 camera 上下文 CameraContext 对象

CameraContext

名称	功能说明
CameraContext.onCameraFrame	获取 Camera 实时帧数据
CameraContext.startRecord	开始录像
CameraContext.stopRecord	结束录像
CameraContext.takePhoto	拍摄照片

CameraFrameListener

名称	功能说明
CameraFrameListener.start	开始监听帧数据
CameraFrameListener.stop	停止监听帧数据

富文本

EditorContext

名称	功能说明
EditorContext.clear	清空编辑器内容
EditorContext.format	修改样式
EditorContext.getContents	获取编辑器内容
EditorContext.insertDivider	插入分割线
EditorContext.insertImage	插入图片
EditorContext.insertText	覆盖当前选区，设置一段文本
EditorContext.redo	恢复
EditorContext.removeFormat	清除当前选区的样式
EditorContext.setContents	初始化编辑器内容，hmlt和delta同时存在时仅delta生效
EditorContext.undo	撤销

位置

名称	功能说明
wx.openLocation	使用微信内置地图查看位置
wx.getLocation	获取当前的地理位置、速度
wx.chooseLocation	打开地图选择位置

名称	功能说明
wx.updateShareMenu	更新转发属性
wx.showShareMenu	显示当前页面的转发按钮
wx.hideShareMenu	隐藏转发按钮
wx.getShareInfo	获取转发详细信息

画布

名称	功能说明
wx.createOffscreenCanvas	创建离屏 canvas 实例
wx.createCanvasContext	创建 canvas 的绘图上下文 CanvasContext 对象
wx.canvasToTempFilePath	把当前画布指定区域的内容导出生成指定大小的图片
wx.canvasPutImageData	将像素数据绘制到画布
wx.canvasGetImageData	获取 canvas 区域隐含的像素数据