微信小程序开发助手
微信小程序开发助手 for VSCode，代码提示 + 语法高亮
Installation
- 打开 VSCode
- 拓展中心搜索 "小程序开发助手"
- 点击安装
Features
- 支持 js，json，wxml 文件的代码提示
- wxml 文件语法高亮
Snippets
js
| 前缀 | 描述 |
| :-- | :-- |
| animation-backgroundColor | 设置背景色 |
| animation-bottom | 底部距离 |
| animation-height | 长度 |
| animation-left | 左侧距离 |
| animation-matrix | 平面矩阵变换 |
| animation-matrix3d | 立体矩阵变换 |
| animation-opacity | 透明度，参数范围 0~1 |
| animation-right | 右侧距离 |
| animation-rotate | 绕原点旋转 |
| animation-rotate3d | 3D 旋转 |
| animation-rotateX | 绕 x 轴旋转 |
| animation-rotateY | 绕 Y 轴旋转 |
| animation-rotateZ | 从 Z 轴顺时针旋转一个角度 |
| animation-scale | x轴[y轴]缩放。一个参数时，表示在X轴、Y轴两个相同；两个参数时表示在X轴，在Y轴不同 |
| animation-scale3d | 3D 缩放 |
| animation-scaleX | x 轴缩放 |
| animation-scaleY | y 轴缩放 |
| animation-scaleZ | z 轴缩放 |
| animation-skew | x轴[y轴]倾斜。一个参数时，表示在X轴；两个参数时表示在X轴，在Y轴 |
| animation-skewX | x 轴倾斜 |
| animation-skewY | y 轴倾斜 |
| animation-top | 顶部距离 |
| animation-translate | x轴[y轴]偏移。一个参数时，表示在X轴；两个参数时表示在X轴，在Y轴 |
| animation-translate3d | 3D 偏移 |
| animation-translateX | x 轴偏移 |
| animation-translateY | y 轴偏移 |
| animation-translateZ | z 轴偏移 |
| animation-width | 宽度 |
| audioContext-pause | 暂停。1.6.0 起不再维护 |
| audioContext-play | 播放。1.6.0 起不再维护 |
| audioContext-seek | 跳转到指定位置，单位 s。1.6.0 起不再维护 |
| audioContext-setSrc | 设置音频的地址。1.6.0 起不再维护 |
| backAudioManager-onCanplay | 背景音频进入可以播放状态，但不保证后面可以流畅播放 |
| backAudioManager-onEnded | 背景音频自然播放结束事件 |
| backAudioManager-onError | 背景音频播放错误事件 |
| backAudioManager-onNext | 用户在系统音乐播放面板点击下一曲事件（iOS only） |
| backAudioManager-onPause | 背景音频暂停事件 |
| backAudioManager-onPlay | 背景音频播放事件 |
| backAudioManager-onPrev | 用户在系统音乐播放面板点击上一曲事件（iOS only） |
| backAudioManager-onStop | 背景音频停止事件 |
| backAudioManager-onTimeUpdate | 背景音频播放进度更新事件 |
| backAudioManager-onWaiting | 音频加载中事件，当音频因为数据不足，需要停下来加载时会触发 |
| backAudioManager-pause | 暂停 |
| backAudioManager-play | 播放 |
| backAudioManager-seek | 跳转到指定位置，单位 s。精确到小数点后 3 位，即支持 ms 级别精确度 |
| backAudioManager-src | 音频的数据源，默认为空字符串，当设置了新的 src 时，会自动开始播放 ，目前支持的格式有 m4a, aac, mp3, wav |
| backAudioManager-stop | 停止 |
| cameraContext-startRecord | 开始录像 |
| cameraContext-stopRecord | 结束录像，成功则返回封面与视频 |
| cameraContext-takePhoto | 拍照，可指定质量(high, normal, low，默认normal)，成功则返回图片 |
| cvsCtx-addColorStop | 创建一个颜色的渐变点 |
| cvsCtx-arc | 画一条弧线 |
| cvsCtx-arcTo | 根据控制点和半径绘制圆弧路径 |
| cvsCtx-beginPath | 开始创建一个路径，需要调用 fill 或者 stroke 才会使用路径进行填充或描边 |
| cvsCtx-bezierCurveTo | 创建三次方贝塞尔曲线路径。曲线的起始点为路径中前一个点 |
| cvsCtx-clearRect | 清除画布上在该矩形区域内的内容 |
| cvsCtx-clip | 从原始画布中剪切任意形状和尺寸 |
| cvsCtx-closePath | 关闭一个路径 |
| cvsCtx-createCircularGradient | 创建一个圆形的渐变颜色。需要使用 addColorStop() 来指定渐变点，至少要两个 |
| cvsCtx-createLinearGradient | 创建一个线性的渐变颜色。需要使用 addColorStop() 来指定渐变点，至少要两个 |
| cvsCtx-createPattern | 对指定的图像创建模式的方法，可在指定的方向上重复元图像 |
| cvsCtx-draw | 将之前在绘图上下文中的描述（路径、变形、样式）画到 canvas 中 |
| cvsCtx-drawImage | 绘制图像到画布 |
| cvsCtx-fill | 对当前路径中的内容进行填充 |
| cvsCtx-fillRect | 填充一个矩形 |
| cvsCtx-fillStyle | 设置填充色。基础库 1.9.90 起支持 |
| cvsCtx-fillText | 在画布上绘制被填充的文本 |
| cvsCtx-font | 设置当前字体样式的属性 |
| cvsCtx-globalAlpha | 设置全局画笔透明度。基础库 1.9.90 起支持 |
| cvsCtx-globalCompositeOperation | 该属性是设置要在绘制新形状时应用的合成操作的类型 |
| cvsCtx-lineCap | 设置线条的端点样式。基础库 1.9.90 起支持 |
| cvsCtx-lineDashOffset | 设置虚线偏移量的属性 |
| cvsCtx-lineJoin | 设置线条的交点样式。基础库 1.9.90 起支持 |
| cvsCtx-lineTo | lineTo 方法增加一个新点，然后创建一条从上次指定点到目标点的线 |
| cvsCtx-lineWidth | 设置线条的宽度。基础库 1.9.90 起支持 |
| cvsCtx-measureText | 测量文本尺寸信息，目前仅返回文本宽度。同步接口 |
| cvsCtx-moveTo | 把路径移动到画布中的指定点，不创建线条 |
| cvsCtx-quadraticCurveTo | 创建二次贝塞尔曲线路径。曲线的起始点为路径中前一个点 |
| cvsCtx-rect | 创建一个矩形 |
| cvsCtx-restore | 恢复之前保存的绘图上下文 |
| cvsCtx-rotate | 以原点为中心，原点可以用 translate 方法修改。顺时针旋转当前坐标轴 |
| cvsCtx-save | 保存当前的绘图上下文 |
| cvsCtx-scale | 在调用 scale 方法后，之后创建的路径其横纵坐标会被缩放。多次调用 scale，倍数会相乘 |
| cvsCtx-setFillStyle | 设置填充色 |
| cvsCtx-setFontSize | 设置字体的字号 |
| cvsCtx-setGlobalAlpha | 设置全局画笔透明度 |
| cvsCtx-setLineCap | 设置线条的端点样式 |
| cvsCtx-setLineDash | 设置线条的宽度 |
| cvsCtx-setLineJoin | 设置线条的交点样式 |
| cvsCtx-setLineWidth | 设置线条的宽度 |
| cvsCtx-setMiterLimit | 设置最大斜接长度，斜接长度指的是在两条线交汇处内角和外角之间的距离。 当 setLineJoin() 为 miter 时才有效 |
| cvsCtx-setShadow | 设置阴影样式 |
| cvsCtx-setStrokeStyle | 设置边框颜色 |
| cvsCtx-setTextAlign | 用于设置文字的对齐 |
| cvsCtx-setTextBaseline | 用于设置文字的水平对齐 |
| cvsCtx-setTransform | 使用矩阵重新设置（覆盖）当前变换的方法 |
| cvsCtx-shadowBlur | 设置阴影的模糊级别 |
| cvsCtx-shadowColor | 设置阴影的颜色 |
| cvsCtx-shadowOffsetX | 设置阴影相对于形状在水平方向的偏移 |
| cvsCtx-shadowOffsetY | 设置阴影相对于形状在竖直方向的偏移 |
| cvsCtx-stroke | 画出当前路径的边框 |
| cvsCtx-strokeRect | 画一个矩形(非填充) |
| cvsCtx-strokeStyle | 设置边框颜色。基础库 1.9.90 起支持 |
| cvsCtx-strokeText | 给定的 (x, y) 位置绘制文本描边的方法 |
| cvsCtx-textAlign | 用于设置文字的对齐，基础库 1.9.90 起支持 |
| cvsCtx-textBaseline | 用于设置文字的水平对齐，基础库 1.9.90 起支持 |
| cvsCtx-translate | 对当前坐标系的原点(0, 0)进行变换，默认的坐标系原点为页面左上角 |
| downTask-abort | 中断下载任务 |
| downTask-onProgressUpdate | 监听下载进度变化事件 |
| fileManager-access | 判断文件/目录是否存在 |
| fileManager-accessSync | 判断文件/目录是否存在，同步接口 |
| fileManager-appendFile | 在文件结尾追加内容 |
| fileManager-appendFileSync | 在文件结尾追加内容，同步接口 |
| fileManager-copyFile | 复制文件 |
| fileManager-copyFileSync | 复制文件，同步接口 |
| fileManager-getFileInfo | 获取该小程序下的本地临时文件或本地缓存文件信息 |
| fileManager-getSavedFileList | 获取该小程序下已保存的本地缓存文件列表 |
| fileManager-mkdir | 创建目录 |
| fileManager-mkdirSync | 创建目录，同步接口 |
| fileManager-readFile | 读取本地文件内容 |
| fileManager-readFileSync | 读取本地文件内容，同步接口 |
| fileManager-readdir | 读取目录内文件列表 |
| fileManager-readdirSync | 读取目录内文件列表，同步接口 |
| fileManager-removeSavedFile | 删除该小程序下已保存的本地缓存文件 |
| fileManager-rename | 重命名文件，可以把文件从 oldPath 移动到 newPath |
| fileManager-renameSync | 重命名文件，可以把文件从 oldPath 移动到 newPath，同步接口 |
| fileManager-rmdir | 删除目录 |
| fileManager-rmdirSync | 删除目录，同步接口 |
| fileManager-saveFile | 保存临时文件到本地。此接口会移动临时文件，因此调用成功后，tempFilePath 将不可用 |
| fileManager-saveFileSync | 保存临时文件到本地。此接口会移动临时文件，因此调用成功后，tempFilePath 将不可用，同步接口 |
| fileManager-stat | 获取文件 Stats 对象 |
| fileManager-statSync | 获取文件 Stats 对象，同步接口 |
| fileManager-unlink | 删除文件 |
| fileManager-unlinkSync | 删除文件,同步接口 |
| fileManager-unzip | 解压文件 |
| fileManager-writeFile | 写文件 |
| fileManager-writeFileSync | 写文件，同步接口 |
| fileStat-isDirectory | 判断当前文件是否一个目录 |
| fileStat-isFile | 判断当前文件是否一个普通文件 |
| getApp | 获取小程序实例 |
| getCurrentPages | 获取当前页面栈 |
| innerAudioContext-destroy | 销毁当前实例 |
| innerAudioContext-offCanplay | 取消监听 onCanplay 事件 |
| innerAudioContext-offEnded | 取消监听 onEnded 事件 |
| innerAudioContext-offError | 取消监听 onError 事件 |
| innerAudioContext-offPlay | 取消监听 onPlay 事件 |
| innerAudioContext-offSeeked | 取消监听 onSeeked 事件 |
| innerAudioContext-offSeeking | 取消监听 onSeeking 事件 |
| innerAudioContext-offStop | 取消监听 onStop 事件 |
| innerAudioContext-offTimeUpdate | 取消监听 onTimeUpdate 事件 |
| innerAudioContext-offWaiting | 取消监听 onWaiting 事件 |
| innerAudioContext-onCanplay | 音频进入可以播放状态，但不保证后面可以流畅播放 |
| innerAudioContext-onEnded | 音频自然播放结束事件 |
| innerAudioContext-onError | 音频播放错误事件 |
| innerAudioContext-onPause | 音频暂停播放事件 |
| innerAudioContext-onPlay | 音频播放事件 |
| innerAudioContext-onSeeked | 音频完成 seek 操作事件 |
| innerAudioContext-onSeeking | 音频进行 seek 操作事件 |
| innerAudioContext-onStop | 音频停止播放事件 |
| innerAudioContext-onTimeUpdate | 音频播放进度更新事件 |
| innerAudioContext-onWaiting | 音频加载中事件，当音频因为数据不足，需要停下来加载时会触发 |
| innerAudioContext-pause | ???? |
| innerAudioContext-play | 播放 |
| innerAudioContext-seek | 跳转到指定位置，单位 s。精确到小数点后 3 位，即支持 ms 级别精确度 |
| innerAudioContext-stop | 停止 |
| interObser-disconnect | 停止监听，回调函数将不再触发 |
| interObser-observe | 指定目标节点并开始监听相交状态变化情况 |
| interObser-relativeTo | 使用选择器指定一个节点，作为参照区域之一 |
| interObser-relativeToViewport | 指定页面显示区域作为参照区域之一 |
| livePlayerContext-exitFullScreen | 退出全屏 |
| livePlayerContext-mute | 静音 |
| livePlayerContext-pause | 暂停 |
| livePlayerContext-play | 播放 |
| livePlayerContext-requestFullScreen | 进入全屏 |
| livePlayerContext-resume | 恢复 |
| livePlayerContext-stop | 停止 |
| livePusherContext-pause | 暂停推流 |
| livePusherContext-play | 播放推流 |
| livePusherContext-resume | 恢复推流 |
| livePusherContext-snapshot | 快照 |
| livePusherContext-stop | 停止推流 |
| livePusherContext-switchCamera | 切换前后摄像头 |
| livePusherContext-toggleTorch | 切换闪光灯 |
| logger-debug | 写 debug 日志，可以提供任意个参数 |
| logger-info | 写 info 日志，可以提供任意个参数 |
| logger-log | 写 log 日志，可以提供任意个参数 |
| logger-warn | 写 warn 日志，可以提供任意个参数 |
| mapContext-getCenterLocation | 获取当前地图中心的经纬度，返回的是 gcj02 坐标系，可以用于 wx.openLocation |
| mapContext-getRegion | 获取当前地图的视野范围 |
| mapContext-getScale | 获取当前地图的缩放级别 |
| mapContext-includePoints | 缩放视野展示所有经纬度 |
| mapContext-moveToLocation | 将地图中心移动到当前定位点，需要配合 map 组件的 show-location 使用 |
| mapContext-translateMarker | 平移 marker，带动画 |
| recordManager-onError | 录音错误事件, 会回调错误信息 |
| recordManager-onFrameRecorded | 已录制完指定帧大小的文件，会回调录音分片结果数据 |
| recordManager-onPause | 录音暂停事件 |
| recordManager-onStart | 录音开始事件 |
| recordManager-onStop | 录音停止事件，会回调文件地址 |
| recordManager-pause | 暂停录音 |
| recordManager-resume | 恢复录音 |
| recordManager-start | ?? |
| recordManager-stop | 停止录音 |
| reqTask-abort | 中断请求任务 |
| selQuery-exec | 执行所有的请求，请求结果按请求次序构成数组，在 callback 的第一个参数中返回 |
| selQuery-in | 将选择器的选取范围更改为自定义组件 component 内（初始时，选择器仅选取页面范围的节点，不会选取任何自定义组件中的节点） |
| selQuery-select | 在当前页面下选择第一个匹配选择器 selector 的节点，返回一个 NodesRef 对象实例，可以用于获取节点信息 |
| selQuery-selectAll | 在当前页面下选择匹配选择器 selector 的所有节点 |
| selQuery-selectViewport | 选择显示区域，可用于获取显示区域的尺寸、滚动位置等信息 |
| sockTask-close | 关闭 WebSocket 连接 |
| sockTask-onClose | 监听 WebSocket 连接关闭事件 |
| sockTask-onError | 监听 WebSocket 错误 |
| sockTask-onMessage | 监听 WebSocket 接受到服务器的消息事件 |
| sockTask-onOpen | 监听 WebSocket 连接打开事件 |
| sockTask-send | 通过 WebSocket 连接发送数据 |
| upTask-abort | 中断上传任务 |
| upTask-onProgressUpdate | 监听上传进度变化事件 |
| updateManager-applyUpdate | 当新版本下载完成，调用该方法会强制当前小程序应用上新版本并重启 |
| updateManager-onCheckForUpdate | 当向微信后台请求完新版本信息，会进行回调 |
| updateManager-onUpdateFailed | 当新版本下载失败，会进行回调 |
| updateManager-onUpdateReady | 当新版本下载完成，会进行回调 |
| videoContext-exitFullScreen | 退出全屏 |
| videoContext-hideStatusBar | 隐藏状态栏，仅在 iOS 全屏下有效 |
| videoContext-pause | 暂停 |
| videoContext-play | 播放 |
| videoContext-playbackRate | 设置倍速播放，支持的倍率有 0.5/0.8/1.0/1.25/1.5 |
| videoContext-requestFullScreen | 进入全屏，可传入 direction 参数, 有效值为 0, 90, -90 |
| videoContext-seek | 跳转到指定位置，单位 s |
| videoContext-sendDanmu | 发送弹幕，包含两个属性 text, color |
| videoContext-showStatusBar | 显示状态栏，仅在 iOS 全屏下有效 |
| videoContext-stop | 停止 |
| worker-onMessage | 监听 Worker 线程向当前线程发送的消息 |
| worker-postMessage | 向 Worker 线程发送的消息 |
| worker-terminate | 结束当前 Worker 线程，仅限在主线程 Worker 实例上调用 |
| wx-addCard | 批量添加卡券 |
| wx-addPhoneContact | 调用后，用户可以选择将该表单以“新增联系人”或“添加到已有联系人”的方式，写入手机系统通讯录，完成手机通讯录联系人和联系方式的增加。此 API 参数非常多，请参考文档 |
| wx-authorize | 提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功 |
| wx-canIUse | 判断小程序的 API，回调，参数，组件等是否在当前版本可用 |
| wx-canvasGetImageData | 返回一个数组，用来描述 canvas 区域隐含的像素数据 |
| wx-canvasPutImageData | 将像素数据绘制到画布的方法 |
| wx-canvasToTempFilePath | 把当前画布指定区域的内容导出生成指定大小的图片，并返回文件路径 |
| wx-checkIsSoterEnrolledInDevice | 获取设备内是否录入如指纹等生物信息的接口 |
| wx-checkIsSupportSoterAuthentication | 获取本机支持的 SOTER 生物认证方式 |
| wx-checkSession | 校验用户当前 session_key 是否有效 |
| wx-chooseAddress | 调起用户编辑收货地址原生界面，并在编辑完成后返回用户选择的地址 |
| wx-chooseImage | 从本地相册选择图片或使用相机拍照 |
| wx-chooseInvoice | 选择用户已有的发票 |
| wx-chooseInvoiceTitle | 选择用户的发票抬头 |
| wx-chooseLocation | 打开地图选择位置。需要用户授权 scope.userLocation |
| wx-chooseVideo | 拍摄视频或从手机相册中选视频，返回视频的临时文件路径 |
| wx-clearStorage | 异步清除本地数据缓存 |
| wx-clearStorageSync | 同步清除本地数据缓存 |
| wx-closeBLEConnection | 断开与低功耗蓝牙设备的连接 |
| wx-closeBluetoothAdapter | 关闭蓝牙模块，使其进入未初始化状态。调用该方法将断开所有已建立的链接并释放系统资源 |
| wx-closeSocket | 关闭 WebSocket 连接 |
| wx-connectSocket | 创建一个 WebSocket 连接 |
| wx-connectWifi | 连接 WiFi。若已知 WiFi 信息，可以直接利用该接口连接 |
| wx-createAnimation | 创建一个动画实例 animation。调用实例的方法来描述动画 |
| wx-createAudioContext | 创建并返回 audio 上下文 audioContext 对象。在自定义组件下，第二个参数传入组件实例 this，以操作组件内
json
| 前缀 | 描述 |
| :-- | :-- |
| debug | App 对应的 JSON 文件 debug 配置项，是否是调试模式 |
| functionalPages | 是否启用插件功能页 |
| networktimeout | App 对应的 JSON 文件 networktimeout 配置项，超时设置 |
| pages | App 对应的 JSON 文件 pages 配置项 |
| plugins | 使用到的插件 |
| preloadRule | 分包预下载规则 |
| requiredBackgroundModes | 需要在后台使用的能力，如“音乐播放” |
| resizable | iPad 小程序是否支持屏幕旋转，默认关闭 |
| subPackages | App 对应的 JSON 文件 subPackages 配置项，分包结构配置 |
| tabbar | App 对应的 JSON 文件 tabbar 配置项 |
| window | App 对应的 JSON 文件 window 配置项 |
| workers | Worker 代码放置的目录 |
| page | Page 页面对应的 JSON 文件配置项 |
wxml
| 前缀 | 描述 |
| :-- | :-- |
| ad | 广告 |
| audio | 音频。1.6.0 版本开始，该组件不再维护 |
| block | block 标签，不是组件，只是包装元素，不会在页面中做任何渲染，只接受控制属性 |
| button | 按钮 |
| camera | 系统相机。需要用户授权 scope.camera |
| canvas | 画布 |
| checkbox-group | 多项选择器，内部由多个 checkbox 组成 |
| checkbox | 多选项目 |
| cover-image | 覆盖在原生组件之上的图片视图，可覆盖的原生组件同 cover-view，支持嵌套在 cover-view 里 |
| cover-view | 覆盖在原生组件之上的文本视图，可覆盖的原生组件包括 map、video、canvas、camera、live-player、live-pusher，只支持嵌套 cover-view、cover-image，可在 cover-view 中使用 button |
| form | 表单，将组件内的用户输入的 提交 |
| functional-page-navigator | 页面链接 |
| icon | 图标 |
| image | 图片。默认宽度 300px、高度 225px。image 组件中二维码/小程序码图片不支持长按识别 |
| input | 输入框 |
| label | 用来改进表单组件的可用性，使用 for 属性找到对应的 id，或者将控件放在该标签下，当点击时，就会触发对应的控件。for 优先级高于内部控件，内部有多个控件的时候默认触发第一个控件。目前可以绑定的控件有
License
MIT
Reference
代码提示部分内容参考自拓展：ChandZhang/wechat-snippet-vscode
Enjoy!
| |
