跳到主要内容

小程序应用

微信小程序、Taro

用户界面​

调试​

Taro微信说明基础库渲染框架状态说明
-vConsole----
-console向调试面板中打印日志---
Taro.wx.setEnableDebug设置是否打开调试开关---
Taro.wx.getLogManager获取日志管理器对象---
Taro.wx.getRealtimeLogManager获取实时日志管理器对象---

界面开发​

基础​

Taro微信说明基础库渲染框架状态说明
<PageMeta><page-meta>页面属性配置节点，用于指定页面的一些属性、监听页面事件2.9.0--
-tap-gesture-handler点击时触发手势-Skyline-
-double-tap-gesture-handler双击时触发手势-Skyline-
-long-press-gesture-handler长按时触发手势-Skyline-
-force-press-gesture-handleriPhone 设备重按时触发手势-Skyline-
-horizontal-drag-gesture-handler横向滑动时触发手势-Skyline-
-vertical-drag-gesture-handler纵向滑动时触发手势-Skyline-
-pan-gesture-handler拖动（横向/纵向）时触发手势-Skyline-
-scale-gesture-handler多指缩放时触发手势-Skyline-
-wx.env环境变量--基础环境
Taro.wx.canIUse判断小程序的API，回调，参数，组件等是否在当前版本可用---
Taro.wx.base64ToArrayBuffer将 Base64 字符串转成 ArrayBuffer 对象---
Taro.wx.arrayBufferToBase64将 ArrayBuffer 对象转成 Base64 字符串---
-wx.getSkylineInfo获取当前运行环境对于 Skyline 渲染引擎 的支持情况--系统-渲染引擎
-wx.getSkylineInfoSync获取当前运行环境对于 Skyline 渲染引擎 的支持情况---
Taro.wx.setBackgroundTextStyle动态设置下拉背景字体、loading 图的样式--背景
Taro.wx.setBackgroundColor动态设置窗口的背景色---
-wx.loadBuiltInFontFace加载内置字体--字体
Taro.wx.loadFontFace动态加载网络字体---

视图​

Taro微信说明基础库渲染框架状态说明
-<selection>局部文本选区3.6.4WebView-
<View><view>视图容器1.0.0--
<ScrollView><scroll-view>可滚动视图区域1.0.0--
<MovableView><movable-view>可移动的视图容器，在页面中可以拖拽滑动1.2.0WebView-
<MovableArea><movable-area>movable-view的可移动区域1.2.0WebView-
-<cover-view>覆盖在原生组件之上的文本视图1.4.0-目前原生组件均已支持同层渲染，建议使用 view 替代
-<cover-image>覆盖在原生组件之上的图片视图1.4.0-目前原生组件均已支持同层渲染，建议使用 image 替代
<Swiper><swiper>滑块视图容器1.0.0--
<SwiperItem><swiper-item>仅可放置在swiper组件中，宽高自动设置为100%1.0.0--
<PageContainer><page-container>页面容器2.16.0--
<RootPortal><root-portal>使整个子树从页面中脱离出来，类似于在 CSS 中使用 fixed position 的效果2.25.2--
<MatchMedia><match-media>media query 匹配检测节点2.11.1WebView-
-data页面的初始数据---
-onLoad(options)生命周期回调—监听页面加载---
-onShow()生命周期回调—监听页面显示---
-onReady()生命周期回调—监听页面初次渲染完成---
-onHide()生命周期回调—监听页面隐藏---
-onUnload()生命周期回调—监听页面卸载---
-onRouteDone()生命周期回调—监听路由动画完成---
-onPullDownRefresh()监听用户下拉动作---
-wx.startPullDownRefresh开始下拉刷新---
-wx.stopPullDownRefresh停止当前页面下拉刷新---
-onReachBottom()页面上拉触底事件的处理函数---
-onShareAppMessage()用户点击右上角转发---
-onShareTimeline()用户点击右上角转发到朋友圈2.11.3-仅 Android 支持
-onAddToFavorites()用户点击右上角收藏--仅 Android 支持
-onPageScroll()页面滚动触发事件的处理函数---
-wx.pageScrollTo将页面滚动到目标位置，支持选择器和滚动距离两种方式定位---
-onResize()页面尺寸改变时触发，详见 响应显示区域变化2.4.0--
-onTabItemTap()当前是 tab 页时，点击 tab 时触发1.9.0--
-onSaveExitState()页面销毁前保留状态回调2.7.4--
-getCurrentPages()获取当前页面栈。---

路由​

Taro微信说明基础库渲染框架状态说明
-<navigator>页面链接1.0.0--
-wx.navigateTo保留当前页面，跳转到应用内的某个页面--路由
-wx.redirectTo关闭当前页面，跳转到应用内的某个页面---
-wx.navigateBack关闭当前页面，返回上一页面或多级页面---
-wx.switchTab跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面---
-wx.reLaunch关闭所有页面，打开到应用内的某个页面---
-wx.routerrouter 对象，可以通过 wx.router 获取--自定义路由
-wx.onBeforeAppRoute监听路由事件下发后，执行路由逻辑前的事件监听---
-wx.offBeforeAppRoute移除路由事件的监听函数---
-wx.onAppRoute监听路由事件下发后，执行路由逻辑后的事件监听---
-wx.offAppRoute移除路由事件的监听函数---
-wx.onAppRouteDone监听当前路由动画执行完成的事件监听---
-wx.offAppRouteDone移除当前路由动画执行完成的事件的监听函数---
-wx.onBeforePageLoad监听路由事件引起新的页面实例化时，页面实例化前的事件监听---
-wx.offBeforePageLoad移除路由事件的监听函数---
-wx.onAfterPageLoad监听路由事件引起新的页面实例化时，页面实例化完成的事件监听---
-wx.offAfterPageLoad移除路由事件的监听函数---
-wx.onBeforePageUnload监听路由事件引起现有页面实例销毁时，页面实例销毁前的事件监听---
-wx.offBeforePageUnload移除路由事件的监听函数---
-wx.onAfterPageUnload监听路由事件引起现有页面实例销毁时，页面实例销毁后的事件监听---
-wx.offAfterPageUnload移除路由事件的监听函数---

网络请求​

Taro微信说明基础库渲染框架状态说明
-wx.request发起 HTTPS 网络请求---
-wx.downloadFile下载文件资源到本地---
-wx.uploadFile将本地资源上传到服务器---
-wx.onBackgroundFetchData监听收到 backgroundFetch 数据事件--数据预拉取和周期性更新
-wx.getBackgroundFetchData拉取 backgroundFetch 客户端缓存数据---
-wx.getBackgroundFetchToken获取设置过的自定义登录态---
-wx.setBackgroundFetchToken设置自定义登录态，在周期性拉取数据时带上，便于第三方服务器验证请求合法性---

动画​

Taro微信说明基础库渲染框架状态说明
-wx.createAnimation创建一个动画实例 animation---
-wx.workletworklet 对象，worklet 动画---

无障碍​

Taro微信说明基础库渲染框架状态说明
-wx.checkIsOpenAccessibility检测是否开启视觉无障碍功能---
-aria-component满足视障人士对于小程序的访问需求---

监控与分析​

Taro微信说明基础库渲染框架状态说明
-wx.reportMonitor自定义业务数据监控上报接口---
-wx.reportAnalytics自定义分析数据上报接口---
-wx.reportEvent事件上报---
-wx.getCommonConfig给定实验参数数组，获取对应的实验参数值---
-wx.getExptInfoSync给定实验参数数组，获取对应的实验参数值---

性能​

Taro微信说明基础库渲染框架状态说明
-wx.getPerformance获取当前小程序性能相关的信息---
-wx.reportPerformance小程序测速上报---
-wx.preloadAssets为视图层预加载媒体资源文件, 目前支持：font，image---
-wx.preloadWebview预加载下个页面的 WebView---
-wx.preloadSkylineView预加载下个页面所需要的 Skyline 运行环境---
-wx.preDownloadSubpackage触发分包预下载---
-wx.createWorker创建一个 Worker 线程---

安全​

Taro微信说明基础库渲染框架状态说明
-wx.getUserCryptoManager获取用户加密模块---
-wx.getRandomValues获取密码学安全随机数---

场景​

图形​

Taro微信说明基础库渲染框架状态说明
-<canvas>画布1.0.0-native-component
-wx.createOffscreenCanvas创建离屏 canvas 实例---
-wx.createCanvasContext创建 canvas 的绘图上下文 CanvasContext 对象---
-wx.canvasToTempFilePath把当前画布指定区域的内容导出生成指定大小的图片---
-wx.canvasPutImageData将像素数据绘制到画布---
-wx.canvasGetImageData获取 canvas 区域隐含的像素数据---

音视频​

Taro微信说明基础库渲染框架状态说明
-<audio>音频1.0.0-从基础库 1.6.0 开始，本接口停止维护，请使用 wx.createInnerAudioContext 代替
-wx.createInnerAudioContext创建内部 audio 上下文 InnerAudioContext 对象---
-wx.playVoice开始播放语音---
-wx.pauseVoice暂停正在播放的语音---
-wx.stopVoice结束播放语音---
-wx.getAvailableAudioSources获取当前支持的音频输入源---
-wx.setInnerAudioOption设置 InnerAudioContext 的播放选项---
-wx.createAudioContext创建 audio 上下文 AudioContext 对象---
-wx.createWebAudioContext创建 WebAudio 上下文---
-wx.createMediaAudioPlayer创建媒体音频播放器对象 MediaAudioPlayer 对象，可用于播放视频解码器 VideoDecoder 输出的音频---
-wx.playBackgroundAudio使用后台播放器播放音乐--背景音频
-wx.onBackgroundAudioPlay监听音乐播放事件---
-wx.pauseBackgroundAudio暂停播放音乐---
-wx.onBackgroundAudioPause监听音乐暂停事件---
-wx.stopBackgroundAudio停止播放音乐---
-wx.onBackgroundAudioStop监听音乐停止事件---
-wx.seekBackgroundAudio控制音乐播放进度---
-wx.getBackgroundAudioPlayerState获取后台音乐播放状态---
-wx.getBackgroundAudioManager获取全局唯一的背景音频管理器---
-<voip-room>多人音视频对话2.11.0WebView-
-wx.startRecord开始录音--录音
-wx.stopRecord停止录音---
-wx.getRecorderManager获取全局唯一的录音管理器 RecorderManager---
-wx.joinVoIPChat加入 (创建) 实时语音通话--实时语音
-wx.exitVoIPChat退出（销毁）实时语音通话---
-wx.updateVoIPChatMuteConfig更新实时语音静音设置---
-wx.onVoIPChatStateChanged监听房间状态变化事件---
-wx.offVoIPChatStateChanged移除房间状态变化事件的监听函数---
-wx.onVoIPChatInterrupted监听被动断开实时语音通话事件---
-wx.offVoIPChatInterrupted移除被动断开实时语音通话事件的监听函数---
-wx.onVoIPChatMembersChanged监听实时语音通话成员在线状态变化事件---
-wx.offVoIPChatMembersChanged移除实时语音通话成员在线状态变化事件的监听函数---
-wx.onVoIPChatSpeakersChanged监听实时语音通话成员通话状态变化事件---
-wx.offVoIPChatSpeakersChanged移除实时语音通话成员通话状态变化事件的监听函数---
-wx.subscribeVoIPVideoMembers订阅视频画面成员---
-wx.onVoIPVideoMembersChanged监听实时语音通话成员视频状态变化事件---
-wx.offVoIPVideoMembersChanged移除实时语音通话成员视频状态变化事件的监听函数---
-wx.join1v1Chat加入（创建）双人通话---
-wx.setEnable1v1Chat开启双人通话---
-<video>视频1.0.0-v2.4.0 起支持同层渲染，native-component
-wx.createVideoContext创建 video 上下文 VideoContext 对象---
-wx.chooseVideo拍摄视频或从手机相册中选视频---
-wx.chooseMedia拍摄或从手机相册中选择图片或视频---
-wx.checkDeviceSupportHevc查询设备是否支持 H.265 编码---
-wx.getVideoInfo获取视频详细信息---
-wx.openVideoEditor打开视频编辑器---
-wx.compressVideo压缩视频接口---
-wx.saveVideoToPhotosAlbum保存视频到系统相册---
-wx.createVideoDecoder创建视频解码器，可逐帧获取解码后的数据--视频解码器
-wx.createMediaRecorder创建 WebGL 画面录制器，可逐帧录制在 WebGL 上渲染的画面并导出视频文件--画面录制器
-<live-pusher>实时音视频录制1.7.0-v2.9.1 起支持同层渲染，native-component
-wx.createLivePusherContext创建 live-pusher 上下文 LivePusherContext 对象--=
-<live-player>实时音视频播放1.7.0-v2.9.1 起支持同层渲染，native-component
-wx.createLivePlayerContext创建 live-player 上下文 LivePlayerContext 对象---
-wx.createMediaContainer创建音视频处理容器，最终可将容器中的轨道合成一个视频--音视频合成

元宇宙​

Taro微信说明基础库渲染框架状态说明
-XR-FRAME小程序官方提供的XR/3D应用解决方案2.32.0--

AI​

Taro微信说明基础库渲染框架状态说明
-wx.createInferenceSession创建 AI 推理 Session--AI 推理
-wx.getInferenceEnvInfo获取通用AI推理引擎版本---
-wx.createVKSession创建 vision kit 会话对象--视觉算法
-wx.isVKSupport判断支持版本---
-wx.initFaceDetect初始化人脸检测--人脸检测
-wx.faceDetect人脸检测，使用前需要通过 wx.initFaceDetect 进行一次初始化，推荐使用相机接口返回的帧数据---
-wx.stopFaceDetect停止人脸检测---

UI 组件库​

通用​

Taro微信说明基础库渲染框架状态说明
-<icon>图标组件1.0.0WebView-
-<button>按钮1.0.0--

布局​

Taro微信说明基础库渲染框架状态说明
-<grid-view>Skyline 下网格布局容器 和 瀑布流布局容器2.29.0Skyline-
-<grid-builder>网格构造器，仅支持作为 <scroll-view type="custom"> 模式的直接子节点3.4.0Skyline-
-<list-view>列表布局容器，仅支持作为 <scroll-view type="custom"> 模式的直接子节点或 sticky-section 组件直接子节点2.29.0Skyline-
-<list-builder>列表构造器，仅支持作为 <scroll-view type="custom"> 模式的直接子节点3.3.0Skyline-
-<sticky-header>吸顶布局容器，仅支持作为 <scroll-view type="custom"> 模式的直接子节点或 sticky-section 组件直接子节点2.29.0Skyline-
-<sticky-section>吸顶布局容器，仅支持作为 <scroll-view type="custom"> 模式的直接子节点2.29.0Skyline-
-<nested-scroll-header>嵌套 scroll-view 场景中属于外层 scroll-view 的节点，仅支持作为 <scroll-view type="nested"> 模式的直接子节点3.2.0Skyline-
-<nested-scroll-body>嵌套 scroll-view 场景中属于里层 scroll-view 的节点，仅支持作为 <scroll-view type="nested"> 模式的直接子节点3.2.0Skyline-
-<draggable-sheet>半屏可拖拽组件3.2.0Skyline-
-<open-container>容器转场动画组件3.4.0Skyline-
-<share-element>共享元素2.16.0Skyline-
-<snapshot>截图组件3.0.1Skyline-
-<span>用于支持内联文本和 image / navigator 的混排-Skyline-

导航​

Taro微信说明基础库渲染框架状态说明
-<functional-page-navigator>仅在插件中有效，用于跳转到插件功能页2.1.0WebView-
-<navigation-bar>页面导航条配置节点，用于指定导航栏的一些属性2.9.0WebView导航栏
-wx.setNavigationBarTitle动态设置当前页面的标题---
-wx.setNavigationBarColor设置页面导航条颜色---
-wx.hideHomeButton隐藏返回首页按钮---
-wx.showNavigationBarLoading显示在当前页面显示导航条加载动画消息提示框---
-wx.hideNavigationBarLoading在当前页面隐藏导航条加载动画---
-wx.showTabBar显示 tabBar--Tab Bar
-wx.hideTabBar隐藏 tabBar---
-wx.setTabBarStyle动态设置 tabBar 的整体样式---
-wx.setTabBarItem动态设置 tabBar 某一项的内容，2.7.0 起图片支持临时文件和网络文件---
-wx.setTabBarBadge为 tabBar 某一项的右上角添加文本---
-wx.removeTabBarBadge移除 tabBar 某一项右上角的文本---
-wx.showTabBarRedDot显示 tabBar 某一项的右上角的红点---
-wx.hideTabBarRedDot隐藏 tabBar 某一项的右上角的红点---
-wx.getMenuButtonBoundingClientRect获取菜单按钮（右上角胶囊按钮）的布局位置信息--菜单
-wx.onMenuButtonBoundingClientRectWeightChange监听菜单按钮（右上角胶囊按钮）的布局位置信息变化事件---
-wx.offMenuButtonBoundingClientRectWeightChange移除菜单按钮（右上角胶囊按钮）的布局位置信息变化事件的监听函数---
-wx.onOnUserTriggerTranslation监听用户触发了小程序菜单中的翻译功能（）---
-wx.offOnUserTriggerTranslation移除用户触发了小程序菜单中的翻译功能（）的监听函数---

数据展示​

Taro微信说明基础库渲染框架状态说明
-<text>文本1.0.0--
-<image>图片1.0.0--
-wx.chooseImage从本地相册选择图片或使用相机拍照---
-wx.chooseMessageFile从客户端会话选择文件---
-wx.getImageInfo获取图片信息---
-wx.previewImage在新页面中全屏预览图片---
-wx.previewMedia预览图片和视频---
-wx.editImage编辑图片接口---
-wx.cropImage裁剪图片接口---
-wx.compressImage压缩图片接口，可选压缩质量---
-wx.saveImageToPhotosAlbum保存图片到系统相册---

数据录入​

Taro微信说明基础库渲染框架状态说明
-<form>表单1.0.0--
-<label>用来改进表单组件的可用性1.0.0--
-<input>输入框1.0.0-native-component
-<textarea>多行输入框1.0.0-native-component
-<keyboard-accessory>设置 input / textarea 聚焦时键盘上方 cover-view / cover-image 工具栏视图2.15.0WebView-
-<editor>富文本编辑器，可以对图片、文字进行编辑2.7.0WebView-
-<rich-text>富文本（HTML）1.4.0--
-<checkbox>多选项目1.0.0--
-<checkbox-group>多项选择器，内部由多个checkbox组成1.0.0--
-<radio>单选项目1.0.0--
-<radio-group>单项选择器，内部由多个 radio 组成1.0.0--
-<picker-view>嵌入页面的滚动选择器1.0.0--
-<picker-view-column>滚动选择器子项1.0.0--
-<picker>从底部弹起的滚动选择器1.0.0--
-<switch>开关选择器1.0.0--
-<slider>滑动选择器1.0.0WebView-

反馈​

Taro微信说明基础库渲染框架状态说明
-<progress>进度条1.0.0WebView-
-wx.showLoading显示 loading 提示框---
-wx.hideLoading隐藏 loading 提示框---
-wx.showToast显示消息提示框---
-wx.hideToast隐藏消息提示框---
-wx.showModal显示模态对话框---
-wx.showActionSheet显示操作菜单---
-wx.enableAlertBeforeUnload开启小程序页面返回询问对话框---
-wx.disableAlertBeforeUnload关闭小程序页面返回询问对话框---

杂项​

Taro微信说明基础库渲染框架状态说明
-wx.setTopBarText动态设置置顶栏文字内容---
-wx.nextTick延迟一部分操作到下一个时间片再执行---

平台​

位置​

Taro微信说明基础库渲染框架状态说明
-wx.getLocation获取当前的地理位置、速度---
-wx.getFuzzyLocation获取当前的模糊地理位置---
-wx.startLocationUpdate开启小程序进入前台时接收位置消息---
-wx.startLocationUpdateBackground开启小程序在前后台时均可接收位置消息，后台包括离开小程序后继续使用微信（微信仍在前台）、离开微信（微信在后台）两个场景，需引导用户开启授权---
-wx.onLocationChange监听实时地理位置变化事件，需结合 wx.startLocationUpdateBackground、wx.startLocationUpdate使用---
-wx.offLocationChange移除实时地理位置变化事件的监听函数---
-wx.onLocationChangeError监听持续定位接口返回失败时触发---
-wx.offLocationChangeError移除持续定位接口返回失败时触发---
-wx.stopLocationUpdate关闭监听实时位置变化，前后台都停止消息接收---
-wx.choosePoi打开POI列表选择位置，支持模糊定位（精确到市）和精确定位混选---
-wx.chooseLocation打开地图选择位置---
-wx.openLocation使用微信内置地图查看位置---

支付​

Taro微信说明基础库渲染框架状态说明
-wx.requestPayment发起微信支付---
-wx.requestPluginPayment插件中发起支付---
-wx.requestVirtualPayment发起米大师虚拟支付---
-wx.requestCommonPayment发起通用支付---
-wx.openHKOfflinePayView拉起WeChat Pay HK付款码---
-wx.requestMerchantTransfer商家转账用户确认模式下，在微信客户端通过小程序拉起页面请求用户确认收款---

网络协议​

Taro微信说明基础库渲染框架状态说明
-wx.connectSocket创建一个 WebSocket 连接--WebSocket
-wx.sendSocketMessage通过 WebSocket 连接发送数据---
-wx.closeSocket关闭 WebSocket 连接---
-wx.onSocketOpen监听 WebSocket 连接打开事件---
-wx.onSocketMessage监听 WebSocket 接收到服务器的消息事件---
-wx.onSocketError监听 WebSocket 错误事件---
-wx.onSocketClose监听 WebSocket 连接关闭事件---
-wx.startLocalServiceDiscovery开始搜索局域网下的 mDNS 服务--mDNS
-wx.stopLocalServiceDiscovery停止搜索 mDNS 服务---
-wx.onLocalServiceFound监听 mDNS 服务发现的事件---
-wx.offLocalServiceFound移除 mDNS 服务发现的事件的监听函数---
-wx.onLocalServiceResolveFail监听 mDNS 服务解析失败的事件---
-wx.offLocalServiceResolveFail移除 mDNS 服务解析失败的事件的监听函数---
-wx.onLocalServiceLost监听 mDNS 服务离开的事件---
-wx.offLocalServiceLost移除 mDNS 服务离开的事件的监听函数---
-wx.onLocalServiceDiscoveryStop监听 mDNS 服务停止搜索的事件---
-wx.offLocalServiceDiscoveryStop移除 mDNS 服务停止搜索的事件的监听函数---
-wx.createTCPSocket创建一个 TCP Socket 实例--TCP
-wx.createUDPSocket创建一个 UDP Socket 实例--UDP

本地存储​

Taro微信说明基础库渲染框架状态说明
-wx.setStorage将数据存储在本地缓存中指定的 key 中--本地缓存
-wx.setStorageSync将数据存储在本地缓存中指定的 key 中---
-wx.batchSetStorage将数据批量存储在本地缓存中指定的 key 中---
-wx.batchSetStorageSync将数据批量存储在本地缓存中指定的 key 中---
-wx.removeStorage从本地缓存中移除指定 key---
-wx.removeStorageSyncwx.removeStorage 的同步版本---
-wx.clearStorage清理本地数据缓存---
-wx.clearStorageSyncwx.clearStorage 的同步版本---
-wx.getStorage从本地缓存中异步获取指定 key 的内容---
-wx.getStorageSync从本地缓存中同步获取指定 key 的内容---
-wx.batchGetStorage从本地缓存中异步批量获取指定 key 的内容---
-wx.batchGetStorageSync从本地缓存中同步批量获取指定 key 的内容---
-wx.getStorageInfo异步获取当前storage的相关信息---
-wx.getStorageInfoSyncwx.getStorageInfo 的同步版本---
-wx.createBufferURL根据传入的 buffer 创建一个唯一的 URL 存在内存中--内存缓存
-wx.revokeBufferURL根据 URL 销毁存在内存中的数据---
-wx.createCacheManager创建缓存管理器--缓存管理器

系统​

基本​

Taro微信说明基础库渲染框架状态说明
-wx.getSystemInfo获取系统信息---
-wx.getSystemInfoAsync异步获取系统信息---
-wx.getSystemInfoSyncwx.getSystemInfo 的同步版本---
-wx.getUpdateManager获取全局唯一的版本更新管理器，用于管理小程序更新--更新
-UpdateManager.onCheckForUpdate监听向微信后台请求检查更新结果事件---
-UpdateManager.onUpdateFailed监听小程序更新失败事件---
-UpdateManager.onUpdateReady监听小程序有版本更新事件---
-UpdateManager.applyUpdate强制小程序重启并使用新版本---
-wx.openDocument新开页面打开文档--文件
-wx.saveFileToDisk保存文件系统的文件到用户磁盘，仅在 PC 端支持---
-wx.getFileSystemManager获取全局唯一的文件管理器---

界面​

Taro微信说明基础库渲染框架状态说明
-wx.openSystemBluetoothSetting跳转系统蓝牙设置页--系统设置
-wx.getSystemSetting获取设备设置---
-wx.getWindowInfo获取窗口信息---
-wx.setWindowSize设置窗口大小，该接口仅适用于 PC 平台，使用细则请参见指南--窗口
-wx.onWindowResize监听窗口尺寸变化事件---
-wx.offWindowResize移除窗口尺寸变化事件的监听函数---
-wx.checkIsPictureInPictureActive返回当前是否存在小窗播放（小窗在 video/live-player/live-pusher 下可用）---
-<camera>系统相机1.6.0-native-component
-wx.createCameraContext创建 camera 上下文 CameraContext 对象---
-<map>地图1.0.0-v2.7.0 起支持同层渲染，native-component
-wx.createMapContext创建 map 上下文 MapContext 对象---
-wx.addPhoneCalendar向系统日历添加事件---
-wx.addPhoneRepeatCalendar向系统日历添加重复事件---
-wx.addPhoneContact添加手机通讯录联系人---
-wx.chooseContact拉起手机通讯录，选择联系人---
-wx.makePhoneCall拨打电话---
-wx.sendSms拉起手机发送短信界面---
-<web-view>承载网页的容器1.6.4WebView-
-wx.getRendererUserAgent获取 Webview 小程序的 UserAgent---

设备​

物理设备​

Taro微信说明基础库渲染框架状态说明
-wx.getDeviceInfo获取设备基础信息---
-wx.getDeviceBenchmarkInfo获取设备性能得分和机型档位数据---
-wx.getScreenBrightness获取屏幕亮度--屏幕
-wx.setScreenBrightness设置屏幕亮度---
-wx.setKeepScreenOn设置是否保持常亮状态---
-wx.onUserCaptureScreen监听用户主动截屏事件---
-wx.offUserCaptureScreen移除用户主动截屏事件---
-wx.getScreenRecordingState查询用户是否在录屏---
-wx.onScreenRecordingStateChanged监听用户录屏事件---
-wx.offScreenRecordingStateChanged移除用户录屏事件的监听函数---
-wx.setVisualEffectOnCapture设置截屏/录屏时屏幕表现---
-wx.hideKeyboard在input、textarea等focus拉起键盘之后，手动调用此接口收起键盘--键盘
-wx.getSelectedTextRange在input、textarea等focus之后，获取输入框的光标位置---
-wx.onKeyDown监听小程序全局键盘按键按下事件---
-wx.offKeyDown移除小程序全局键盘按键按下事件的监听函数---
-wx.onKeyUp监听小程序全局键盘按键弹起事件---
-wx.offKeyUp移除小程序全局键盘按键弹起事件的监听函数---
-wx.onKeyboardHeightChange监听键盘高度变化事件---
-wx.offKeyboardHeightChange移除键盘高度变化事件的监听函数---
-wx.scanCode调起客户端扫码界面进行扫码--扫码
-wx.getNetworkType获取网络类型--移动网络
-wx.getLocalIPAddress获取局域网IP地址---
-wx.onNetworkStatusChange监听网络状态变化事件---
-wx.offNetworkStatusChange移除网络状态变化事件的监听函数---
-wx.onNetworkWeakChange监听弱网状态变化事件---
-wx.offNetworkWeakChange移除弱网状态变化事件的监听函数---
-wx.startWifi初始化 Wi-Fi 模块--Wi-Fi
-wx.stopWifi关闭 Wi-Fi 模块---
-wx.setWifiList设置 wifiList 中 AP 的相关信息---
-wx.getWifiList请求获取 Wi-Fi 列表---
-wx.connectWifi连接 Wi-Fi---
-wx.getConnectedWifi获取已连接中的 Wi-Fi 信息---
-wx.onGetWifiList监听获取到 Wi-Fi 列表数据事件---
-wx.offGetWifiList移除获取到 Wi-Fi 列表数据事件的监听函数---
-wx.onWifiConnected监听连接上 Wi-Fi 的事件---
-wx.offWifiConnected移除连接上 Wi-Fi 的事件的监听函数---
-wx.onWifiConnectedWithPartialInfo监听连接上 Wi-Fi 的事件---
-wx.offWifiConnectedWithPartialInfo移除连接上 Wi-Fi 的事件的监听函数---
-wx.openBluetoothAdapter初始化蓝牙模块--蓝牙-通用
-wx.closeBluetoothAdapter关闭蓝牙模块---
-wx.startBluetoothDevicesDiscovery开始搜寻附近的蓝牙外围设备---
-wx.stopBluetoothDevicesDiscovery停止搜寻附近的蓝牙外围设备---
-wx.getBluetoothAdapterState获取本机蓝牙适配器状态---
-wx.onBluetoothAdapterStateChange监听蓝牙适配器状态变化事件---
-wx.offBluetoothAdapterStateChange移除蓝牙适配器状态变化事件的全部监听函数---
-wx.getBluetoothDevices获取在蓝牙模块生效期间所有搜索到的蓝牙设备---
-wx.onBluetoothDeviceFound监听搜索到新设备的事件---
-wx.offBluetoothDeviceFound移除搜索到新设备的事件的全部监听函数---
-wx.getConnectedBluetoothDevices根据主服务 UUID 获取已连接的蓝牙设备---
-wx.isBluetoothDevicePaired查询蓝牙设备是否配对，仅安卓支持---
-wx.makeBluetoothPair蓝牙配对接口，仅安卓支持---
-wx.createBLEConnection连接蓝牙低功耗设备--蓝牙-低功耗中心设备
-wx.closeBLEConnection断开与蓝牙低功耗设备的连接---
-wx.onBLEConnectionStateChange监听蓝牙低功耗连接状态改变事件---
-wx.getBLEMTU获取蓝牙低功耗的最大传输单元---
-wx.setBLEMTU协商设置蓝牙低功耗的最大传输单元 (Maximum Transmission Unit, MTU)---
-wx.onBLEMTUChange监听蓝牙低功耗的最大传输单元变化事件（仅安卓触发）---
-wx.getBLEDeviceRSSI获取蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI)---
-wx.getBLEDeviceServices获取蓝牙低功耗设备所有服务 (service)---
-wx.getBLEDeviceCharacteristics获取蓝牙低功耗设备某个服务中所有特征 (characteristic)---
-wx.readBLECharacteristicValue读取蓝牙低功耗设备特征值的二进制数据---
-wx.writeBLECharacteristicValue向蓝牙低功耗设备特征值中写入二进制数据---
-wx.onBLECharacteristicValueChange监听蓝牙低功耗设备的特征值变化事件---
-wx.notifyBLECharacteristicValueChange启用蓝牙低功耗设备特征值变化时的 notify 功能，订阅特征---
-wx.createBLEPeripheralServer建立本地作为蓝牙低功耗外围设备的服务端，可创建多个--蓝牙-低功耗外围设备
-wx.onBLEPeripheralConnectionStateChanged监听当前外围设备被连接或断开连接事件---
-wx.offBLEPeripheralConnectionStateChanged移除当前外围设备被连接或断开连接事件的监听函数---
-wx.startBeaconDiscovery开始搜索附近的 Beacon 设备--蓝牙-信标（Beacon）
-wx.stopBeaconDiscovery停止搜索附近的 Beacon 设备---
-wx.getBeacons获取所有已搜索到的 Beacon 设备---
-wx.onBeaconUpdate监听 Beacon 设备更新事件，仅能注册一个监听---
-wx.offBeaconUpdate移除 Beacon 设备更新事件的全部监听函数---
-wx.onBeaconServiceChange监听 Beacon 服务状态变化事件，仅能注册一个监听---
-wx.offBeaconServiceChange移除 Beacon 服务状态变化事件的全部监听函数---
-wx.getNFCAdapter获取 NFC 实例--NFC-读写
-wx.getHCEState判断当前设备是否支持 HCE 能力--NFC-主机卡模拟
-wx.startHCE初始化 NFC 模块---
-wx.stopHCE关闭 NFC 模块---
-wx.sendHCEMessage发送 NFC 消息---
-wx.onHCEMessage监听接收 NFC 设备消息事件---
-wx.offHCEMessage移除接收 NFC 设备消息事件的监听函数---
-wx.getClipboardData获取系统剪贴板的内容--剪贴板
-wx.setClipboardData设置系统剪贴板的内容---
-wx.getBatteryInfo获取设备电池信息--电量
-wx.getBatteryInfoSyncwx.getBatteryInfo 的同步版本---
-wx.onBatteryInfoChange监听电池信息变化事件，目前只支持监听省电模式的切换---
-wx.offBatteryInfoChange移除电池信息变化事件的监听函数---
-wx.onMemoryWarning监听内存不足告警事件--内存
-wx.offMemoryWarning移除内存不足告警事件的监听函数---
-wx.startAccelerometer开始监听加速度数据--传感器-加速计
-wx.stopAccelerometer停止监听加速度数据---
-wx.onAccelerometerChange监听加速度数据事件---
-wx.offAccelerometerChange移除加速度数据事件的监听函数---
-wx.startCompass开始监听罗盘数据--传感器-罗盘
-wx.stopCompass停止监听罗盘数据---
-wx.onCompassChange监听罗盘数据变化事件---
-wx.offCompassChange移除罗盘数据变化事件的监听函数---
-wx.startGyroscope开始监听陀螺仪数据--传感器-陀螺仪
-wx.stopGyroscope停止监听陀螺仪数据---
-wx.onGyroscopeChange监听陀螺仪数据变化事件---
-wx.offGyroscopeChange移除陀螺仪数据变化事件的监听函数---
-wx.startDeviceMotionListening开始监听设备方向的变化--传感器-设备方向
-wx.stopDeviceMotionListening停止监听设备方向的变化---
-wx.onDeviceMotionChange监听设备方向变化事件---
-wx.offDeviceMotionChange移除设备方向变化事件的监听函数---
-wx.vibrateShort使手机发生较短时间的振动（15 ms）--振动
-wx.vibrateLong使手机发生较长时间的振动（400 ms）---

宿主容器​

微信​

Taro微信说明基础库渲染框架状态说明
-wx.getAppBaseInfo获取微信APP基础信息---
-wx.getAppAuthorizeSetting获取微信APP授权设置---
-wx.openAppAuthorizeSetting跳转系统微信授权管理页---
-wx.updateWeChatApp更新客户端版本---

小程序​

Taro微信说明基础库渲染框架状态说明
-onLaunch(options)生命周期回调——监听小程序初始化。---
-wx.getLaunchOptionsSync获取小程序启动时的参数---
-onShow(options)生命周期回调——监听小程序启动或切前台。---
-wx.onAppShow监听小程序切前台事件---
-wx.offAppShow移除小程序切前台事件的监听函数---
-onHide()生命周期回调——监听小程序切后台。---
-wx.onAppHide监听小程序切后台事件---
-wx.offAppHide移除小程序切后台事件的监听函数---
-onError(error)错误监听函数。---
-wx.onError监听小程序错误事件---
-wx.offError移除小程序错误事件的监听函数---
-onPageNotFound()页面不存在监听函数。1.9.90--
-wx.onPageNotFound监听小程序要打开的页面不存在事件---
-wx.offPageNotFound移除小程序要打开的页面不存在事件的监听函数---
-onUnhandledRejection()未处理的 Promise 拒绝事件监听函数。2.10.0--
-wx.onUnhandledRejection监听未处理的 Promise 拒绝事件---
-wx.offUnhandledRejection移除未处理的 Promise 拒绝事件的监听函数---
-onThemeChange()监听系统主题变化。2.11.0--
-wx.onThemeChange监听系统主题改变事件---
-wx.offThemeChange移除系统主题改变事件的监听函数---
-getApp()获取到小程序全局唯一的 App 实例。---
-wx.getApiCategory获取当前 API 类别---
-wx.onApiCategoryChange监听 API 类别变化事件---
-wx.offApiCategoryChange移除 API 类别变化事件的监听函数---
-wx.onLazyLoadError监听小程序异步组件加载失败事件---
-wx.offLazyLoadError移除小程序异步组件加载失败事件的监听函数---
-wx.onAudioInterruptionBegin监听音频因为受到系统占用而被中断开始事件---
-wx.offAudioInterruptionBegin移除音频因为受到系统占用而被中断开始事件的监听函数---
-wx.onAudioInterruptionEnd监听音频中断结束事件---
-wx.offAudioInterruptionEnd移除音频中断结束事件的监听函数---
-wx.openEmbeddedMiniProgram打开半屏小程序--转发
-wx.onEmbeddedMiniProgramHeightChange监听半屏小程序可视高度变化事件---
-wx.offEmbeddedMiniProgramHeightChange移除半屏小程序可视高度变化事件的监听函数---
-wx.restartMiniProgram重启当前小程序---
-wx.exitMiniProgram退出当前小程序---
-wx.navigateToMiniProgram打开另一个小程序---
-wx.navigateBackMiniProgram返回到上一个小程序---
-wx.getEnterOptionsSync获取本次小程序启动时的参数---
-wx.postMessageToReferrerPage向跳转的源页面发送消息---
-wx.postMessageToReferrerMiniProgram向跳转的源小程序发送消息，源小程序可在 wx.onShow 或 wx.getEnterOptionsSync 中通过 extraData 接收消息---

开放平台​

Taro微信说明基础库渲染框架状态说明
-wx.login调用接口获取登录凭证（code）--登录
-wx.pluginLogin该接口仅在小程序插件中可调用，调用接口获得插件用户标志凭证（code）---
-wx.checkSession检查登录态 session_key 是否过期---
-wx.authorize提前向用户发起授权请求--授权
-wx.authorizeForMiniProgram仅小程序插件中能调用该接口，用法同 wx.authorize---
-wx.getPrivacySetting查询隐私授权情况--隐私信息授权
-wx.openPrivacyContract跳转至隐私协议页面---
-wx.onNeedPrivacyAuthorization监听隐私接口需要用户授权事件---
-wx.requirePrivacyAuthorize模拟隐私接口调用，并触发隐私弹窗逻辑---
-wx.checkIsSoterEnrolledInDevice获取设备内是否录入如指纹等生物信息的接口--生物认证
-wx.checkIsSupportSoterAuthentication获取本机支持的 SOTER 生物认证方式---
-wx.startSoterAuthentication开始 SOTER 生物认证---
-<open-data>用于展示微信开放的数据-WebView用户信息相关功能已进行调整
-wx.getUserProfile获取用户信息--用户信息
-wx.getUserInfo获取用户信息---
-wx.getAccountInfoSync获取当前账号信息--账号信息
-wx.openStickerSetView打开表情专辑--微信表情
-wx.openStickerIPView打开表情IP合辑---
-wx.openSingleStickerView打开单个表情---
-wx.getDeviceVoIPList查询当前用户授权的音视频通话设备（组）信息--音视频通话
-wx.requestDeviceVoIP请求用户授权与设备（组）间进行音视频通话---
-wx.showRedPackage拉取h5领取红包封面页--微信红包
-wx.addVideoToFavorites收藏视频--收藏
-wx.addFileToFavorites收藏文件---
-wx.openCard查看微信卡包中的卡券--卡券
-wx.addCard批量添加卡券---
-wx.checkIsAddedToMyMiniProgram检查小程序是否被添加至 「我的小程序」--我的小程序
-<official-account>公众号关注组件2.3.0-公众号
-wx.openOfficialAccountProfile通过小程序打开任意公众号主页---
-wx.openOfficialAccountArticle通过小程序打开任意公众号文章（不包括临时链接等异常状态下的公众号文章），必须有点击行为才能调用成功---
-wx.requestSubscribeDeviceMessage订阅设备消息接口，调用后弹出授权框，用户同意后会允许开发者给用户发送订阅模版消息--订阅消息
-wx.requestSubscribeMessage调起客户端小程序订阅消息界面，返回用户订阅消息的操作结果---
-wx.openCustomerServiceChat打开微信客服，页面产生点击事件后才可调用--微信客服
-<channel-live>小程序内嵌视频号直播组件，展示视频号直播状态和封面，并无弹窗跳转至视频号2.29.0-视频号
-<channel-video>小程序内嵌视频号视频组件，支持在小程序中播放视频号视频，并无弹窗跳转至视频号2.25.1--
-wx.getChannelsLiveNoticeInfo获取视频号直播预告信息---
-wx.getChannelsLiveInfo获取视频号直播信息---
-wx.getChannelsShareKey获取视频号直播卡片/视频卡片的分享来源---
-wx.reserveChannelsLive预约视频号直播---
-wx.openChannelsUserProfile打开视频号主页---
-wx.openChannelsEvent打开视频号活动页---
-wx.openChannelsActivity打开视频号视频---
-wx.openChannelsLive打开视频号直播---
-<store-home>小程序内嵌微信小店首页，展示小店首页，并进行跳转交易3.5.5WebView微信小店
-<store-product>小程序内嵌微信小店商品，展示小店商品，并进行跳转交易3.5.5WebView-
-wx.openStoreOrderDetail打开微信小店订单详情页---
-wx.getGroupEnterInfo获取微信群聊场景下的小程序启动信息--微信群
-wx.getWeRunData获取用户过去三十一天微信运动步数--微信运动
-wx.shareToWeRun分享数据到微信运动---
-wx.openSetting调起客户端小程序设置界面，返回用户设置的操作结果--设置
-wx.getSetting获取用户的当前设置---
-wx.chooseAddress获取用户收货地址--收货地址
-wx.chooseInvoiceTitle选择用户的发票抬头--发票
-wx.chooseInvoice选择用户已有的发票---
-wx.chooseLicensePlate选择车牌号--车牌
-wx.openChatTool进入聊天工具模式--聊天工具-转发
-wx.shareImageToGroup转发图片到聊天---
-wx.shareVideoToGroup转发视频到聊天---
-wx.shareFileToGroup转发文件到聊天---
-wx.shareEmojiToGroup转发表情到聊天---
-wx.shareAppMessageToGroup转发小程序卡片到聊天---
-wx.getChatToolInfo获取聊天工具模式下的群聊信息---
-wx.selectGroupMembers选择聊天室的成员，并返回选择成员的 group_openid---
-wx.notifyGroupMembers提醒用户完成任务---
-wx.showShareMenu设置右上角点开的详情界面中的分享按钮是否可用--分享-转发
-wx.hideShareMenu隐藏当前页面的转发按钮---
-wx.updateShareMenu更新转发属性---
-wx.showShareImageMenu打开分享图片弹窗，可以将图片发送给朋友、收藏或下载---
-wx.shareVideoMessage转发视频到聊天---
-wx.shareFileMessage转发文件到聊天---
-wx.onCopyUrl监听用户点击右上角菜单的「复制链接」按钮时触发的事件---
-wx.offCopyUrl移除用户点击右上角菜单的「复制链接」按钮时触发的事件的全部监听函数---
-wx.getShareInfo获取转发详细信息（主要是获取群ID）---
-wx.authPrivateMessage验证私密消息---
-<ad>Banner 广告1.9.94-广告
-<ad-custom>原生模板 广告2.10.4--
-wx.createInterstitialAd创建插屏广告组件---
-wx.createRewardedVideoAd创建激励视频广告组件---
-wx.getShowSplashAdStatus获取封面广告组件展示状态---

WXML​

Taro微信说明基础库渲染框架状态说明
-wx.createSelectorQuery返回一个 SelectorQuery 对象实例---
-wx.createIntersectionObserver创建并返回一个 IntersectionObserver 对象实例---

第三方平台​

Taro微信说明基础库渲染框架状态说明
-wx.getExtConfig获取第三方平台自定义的数据字段---
-wx.getExtConfigSyncwx.getExtConfig 的同步版本---

参考​