diff --git a/docs/apis/files/FileSystemManager.md b/docs/apis/files/FileSystemManager.md index 2bc75a2431ce..d60317bbbde5 100644 --- a/docs/apis/files/FileSystemManager.md +++ b/docs/apis/files/FileSystemManager.md @@ -15,7 +15,7 @@ sidebar_label: FileSystemManager 判断文件/目录是否存在 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.access.html) @@ -31,7 +31,7 @@ sidebar_label: FileSystemManager [FileSystemManager.access](#access) 的同步版本 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.accessSync.html) @@ -47,7 +47,7 @@ sidebar_label: FileSystemManager 在文件结尾追加内容 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.appendFile.html) @@ -63,7 +63,7 @@ sidebar_label: FileSystemManager [FileSystemManager.appendFile](#appendfile) 的同步版本 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.appendFileSync.html) @@ -113,7 +113,7 @@ sidebar_label: FileSystemManager 复制文件 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.copyFile.html) @@ -129,7 +129,7 @@ sidebar_label: FileSystemManager [FileSystemManager.copyFile](#copyfile) 的同步版本 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.copyFileSync.html) @@ -210,7 +210,7 @@ sidebar_label: FileSystemManager 获取该小程序下的 `本地临时文件` 或 `本地缓存文件` 信息 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.getFileInfo.html) @@ -226,7 +226,7 @@ sidebar_label: FileSystemManager 获取该小程序下已保存的本地缓存文件列表 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.getSavedFileList.html) @@ -242,7 +242,7 @@ sidebar_label: FileSystemManager 创建目录 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.mkdir.html) @@ -258,7 +258,7 @@ sidebar_label: FileSystemManager [FileSystemManager.mkdir](#mkdir) 的同步版本 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.mkdirSync.html) @@ -355,7 +355,7 @@ sidebar_label: FileSystemManager 读取目录内文件列表 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readdir.html) @@ -371,7 +371,7 @@ sidebar_label: FileSystemManager [FileSystemManager.readdir](#readdir) 的同步版本 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readdirSync.html) @@ -387,7 +387,7 @@ sidebar_label: FileSystemManager 读取本地文件内容 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readFile.html) @@ -403,7 +403,7 @@ sidebar_label: FileSystemManager [FileSystemManager.readFile](#readfile) 的同步版本 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.readFileSync.html) @@ -454,7 +454,7 @@ sidebar_label: FileSystemManager 删除该小程序下已保存的本地缓存文件 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.removeSavedFile.html) @@ -470,7 +470,7 @@ sidebar_label: FileSystemManager 重命名文件。可以把文件从 oldPath 移动到 newPath -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.rename.html) @@ -486,7 +486,7 @@ sidebar_label: FileSystemManager [FileSystemManager.rename](#rename) 的同步版本 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.renameSync.html) @@ -536,7 +536,7 @@ sidebar_label: FileSystemManager 保存临时文件到本地。此接口会移动临时文件,因此调用成功后,tempFilePath 将不可用。 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.saveFile.html) @@ -552,7 +552,7 @@ sidebar_label: FileSystemManager [FileSystemManager.saveFile](#savefile) 的同步版本 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.saveFileSync.html) @@ -569,7 +569,7 @@ sidebar_label: FileSystemManager 获取文件 Stats 对象 -支持情况: +支持情况: ```tsx (option: StatOption) => void @@ -583,7 +583,7 @@ sidebar_label: FileSystemManager [FileSystemManager.stat](#stat) 的同步版本 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.statSync.html) @@ -600,7 +600,7 @@ sidebar_label: FileSystemManager 对文件内容进行截断操作 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.truncate.html) @@ -616,7 +616,7 @@ sidebar_label: FileSystemManager 对文件内容进行截断操作 ([truncate](#truncate) 的同步版本) -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.truncateSync.html) @@ -632,7 +632,7 @@ sidebar_label: FileSystemManager 删除文件 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unlink.html) @@ -648,7 +648,7 @@ sidebar_label: FileSystemManager [FileSystemManager.unlink](#unlink) 的同步版本 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unlinkSync.html) @@ -664,7 +664,7 @@ sidebar_label: FileSystemManager 解压文件 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.unzip.html) @@ -696,7 +696,7 @@ sidebar_label: FileSystemManager 写文件 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.writeFile.html) @@ -712,7 +712,7 @@ sidebar_label: FileSystemManager [FileSystemManager.writeFile](#writefile) 的同步版本 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/FileSystemManager.writeFileSync.html) @@ -787,8 +787,8 @@ sidebar_label: FileSystemManager | --- | --- | :---: | --- | | data | string or ArrayBuffer | 是 | 要追加的文本或二进制数据 | | filePath | `string` | 是 | 要追加内容的文件路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | | encoding | `keyof Encoding` | 否 | 指定写入文件的字符编码 | +| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | | fail | `(result: AppendFileFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | | success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | @@ -816,12 +816,13 @@ sidebar_label: FileSystemManager ### getFileInfoOption -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| filePath | `string` | 是 | 要读取的文件路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | -| fail | `(result: GetFileInfoFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(result: GetFileInfoSuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | +| 参数 | 类型 | 默认值 | 必填 | 说明 | +| --- | --- | :---: | :---: | --- | +| filePath | `string` | | 是 | 要读取的文件路径 | +| digestAlgorithm | "md5" or "sha1" | `"md5"` | 否 | 计算文件摘要的算法 | +| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | +| fail | `(result: GetFileInfoFailCallbackResult) => void` | | 否 | 接口调用失败的回调函数 | +| success | `(result: GetFileInfoSuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | ### GetFileInfoFailCallbackResult @@ -831,10 +832,11 @@ sidebar_label: FileSystemManager ### GetFileInfoSuccessCallbackResult -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| size | `number` | 文件大小,以字节为单位 | -| errMsg | `string` | 调用结果 | +| 参数 | 类型 | 必填 | 说明 | +| --- | --- | :---: | --- | +| size | `number` | 是 | 文件大小,以字节为单位 | +| digest | `string` | 否 | 按照传入的 digestAlgorithm 计算得出的的文件摘要 | +| errMsg | `string` | 是 | 调用结果 | ### getSavedFileListOption @@ -863,13 +865,13 @@ sidebar_label: FileSystemManager ### MkdirOption -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| dirPath | `string` | 是 | 创建的目录路径 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | -| fail | `(result: MkdirFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| recursive | `boolean` | 否 | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | +| 参数 | 类型 | 默认值 | 必填 | 说明 | +| --- | --- | :---: | :---: | --- | +| dirPath | `string` | | 是 | 创建的目录路径 | +| recursive | `boolean` | `false` | 否 | 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。
如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,以此类推直至创建 a/b/c 目录下的 d 目录。 | +| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | +| fail | `(result: MkdirFailCallbackResult) => void` | | 否 | 接口调用失败的回调函数 | +| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | ### MkdirFailCallbackResult @@ -994,6 +996,7 @@ FailCallbackResult | SuccessCallbackResult | 参数 | 类型 | 必填 | 说明 | | --- | --- | :---: | --- | | filePath | `string` | 是 | 需要删除的文件路径 | +| apFilePath | `string` | 是 | 本地缓存文件路径
API 支持度: alipay | | complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | | fail | `(result: RemoveSavedFileFailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | | success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | @@ -1387,51 +1390,51 @@ FailCallbackResult | SuccessCallbackResult ## API 支持度 -| API | 微信小程序 | 抖音小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | :---: | -| FileSystemManager | ✔️ | ✔️ | | | | -| FileSystemManager.access | ✔️ | ✔️ | | | | -| FileSystemManager.accessSync | ✔️ | ✔️ | | | | -| FileSystemManager.appendFile | ✔️ | | | | | -| FileSystemManager.appendFileSync | ✔️ | | | | | -| FileSystemManager.close | ✔️ | | | | | -| FileSystemManager.closeSync | ✔️ | | | | | -| FileSystemManager.copyFile | ✔️ | ✔️ | | | | -| FileSystemManager.copyFileSync | ✔️ | ✔️ | | | | -| FileSystemManager.fstat | ✔️ | | | | | -| FileSystemManager.fstatSync | ✔️ | | | | | -| FileSystemManager.ftruncate | ✔️ | | | | | -| FileSystemManager.ftruncateSync | ✔️ | | | | | -| FileSystemManager.getFileInfo | ✔️ | ✔️ | | | | -| FileSystemManager.getSavedFileList | ✔️ | ✔️ | | | | -| FileSystemManager.mkdir | ✔️ | ✔️ | | | | -| FileSystemManager.mkdirSync | ✔️ | ✔️ | | | | -| FileSystemManager.open | ✔️ | | | | | -| FileSystemManager.openSync | ✔️ | | | | | -| FileSystemManager.read | ✔️ | | | | | -| FileSystemManager.readCompressedFile | ✔️ | | | | | -| FileSystemManager.readCompressedFileSync | ✔️ | | | | | -| FileSystemManager.readdir | ✔️ | ✔️ | | | | -| FileSystemManager.readdirSync | ✔️ | ✔️ | | | | -| FileSystemManager.readFile | ✔️ | ✔️ | | | | -| FileSystemManager.readFileSync | ✔️ | ✔️ | | | | -| FileSystemManager.readSync | ✔️ | | | | | -| FileSystemManager.readZipEntry | ✔️ | | | | | -| FileSystemManager.removeSavedFile | ✔️ | | | | | -| FileSystemManager.rename | ✔️ | ✔️ | | | | -| FileSystemManager.renameSync | ✔️ | ✔️ | | | | -| FileSystemManager.rmdir | ✔️ | ✔️ | | | | -| FileSystemManager.rmdirSync | ✔️ | ✔️ | | | | -| FileSystemManager.saveFile | ✔️ | ✔️ | | | | -| FileSystemManager.saveFileSync | ✔️ | ✔️ | | | | -| FileSystemManager.stat | ✔️ | | | | | -| FileSystemManager.statSync | ✔️ | ✔️ | | | | -| FileSystemManager.truncate | ✔️ | | | | | -| FileSystemManager.truncateSync | ✔️ | | | | | -| FileSystemManager.unlink | ✔️ | ✔️ | | | | -| FileSystemManager.unlinkSync | ✔️ | ✔️ | | | | -| FileSystemManager.unzip | ✔️ | ✔️ | | | | -| FileSystemManager.write | ✔️ | | | | | -| FileSystemManager.writeFile | ✔️ | ✔️ | | | | -| FileSystemManager.writeFileSync | ✔️ | ✔️ | | | | -| FileSystemManager.writeSync | ✔️ | | | | | +| API | 微信小程序 | 百度小程序 | 支付宝小程序 | 抖音小程序 | QQ 小程序 | 京东小程序 | H5 | React Native | Harmony | +| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | +| FileSystemManager | ✔️ | | | ✔️ | | | | | | +| FileSystemManager.access | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.accessSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.appendFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.appendFileSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.close | ✔️ | | | | | | | | | +| FileSystemManager.closeSync | ✔️ | | | | | | | | | +| FileSystemManager.copyFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.copyFileSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.fstat | ✔️ | | | | | | | | | +| FileSystemManager.fstatSync | ✔️ | | | | | | | | | +| FileSystemManager.ftruncate | ✔️ | | | | | | | | | +| FileSystemManager.ftruncateSync | ✔️ | | | | | | | | | +| FileSystemManager.getFileInfo | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.getSavedFileList | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.mkdir | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.mkdirSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.open | ✔️ | | | | | | | | | +| FileSystemManager.openSync | ✔️ | | | | | | | | | +| FileSystemManager.read | ✔️ | | | | | | | | | +| FileSystemManager.readCompressedFile | ✔️ | | | | | | | | | +| FileSystemManager.readCompressedFileSync | ✔️ | | | | | | | | | +| FileSystemManager.readdir | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.readdirSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.readFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.readFileSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.readSync | ✔️ | | | | | | | | | +| FileSystemManager.readZipEntry | ✔️ | | | | | | | | | +| FileSystemManager.removeSavedFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.rename | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.renameSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.rmdir | ✔️ | | | ✔️ | | | | | | +| FileSystemManager.rmdirSync | ✔️ | | | ✔️ | | | | | | +| FileSystemManager.saveFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.saveFileSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.stat | ✔️ | ✔️ | ✔️ | | ✔️ | ✔️ | | | | +| FileSystemManager.statSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.truncate | ✔️ | | | ✔️ | | | | | | +| FileSystemManager.truncateSync | ✔️ | | | ✔️ | | | | | | +| FileSystemManager.unlink | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.unlinkSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.unzip | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.write | ✔️ | | | | | | | | | +| FileSystemManager.writeFile | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.writeFileSync | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| FileSystemManager.writeSync | ✔️ | | | | | | | | | diff --git a/docs/apis/files/Stats.md b/docs/apis/files/Stats.md index af6d7b816853..e8f95ea64ba5 100644 --- a/docs/apis/files/Stats.md +++ b/docs/apis/files/Stats.md @@ -22,7 +22,7 @@ sidebar_label: Stats 判断当前文件是否一个目录 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/Stats.isDirectory.html) @@ -34,7 +34,7 @@ sidebar_label: Stats 判断当前文件是否一个普通文件 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/Stats.isFile.html) @@ -44,8 +44,8 @@ sidebar_label: Stats ## API 支持度 -| API | 微信小程序 | H5 | React Native | Harmony | -| :---: | :---: | :---: | :---: | :---: | -| Stats | ✔️ | | | | -| Stats.isDirectory | ✔️ | | | | -| Stats.isFile | ✔️ | | | | +| API | 微信小程序 | 支付宝小程序 | 抖音小程序 | QQ 小程序 | 京东小程序 | H5 | React Native | Harmony | +| :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | +| Stats | ✔️ | | | | | | | | +| Stats.isDirectory | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | | +| Stats.isFile | ✔️ | | ✔️ | ✔️ | ✔️ | | | | diff --git a/docs/apis/files/getFileInfo.md b/docs/apis/files/getFileInfo.md index ad210a09fb15..fbe2db3a5bfa 100644 --- a/docs/apis/files/getFileInfo.md +++ b/docs/apis/files/getFileInfo.md @@ -5,7 +5,7 @@ sidebar_label: getFileInfo 获取该小程序下的 本地临时文件 或 本地缓存文件 信息 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getFileInfo.html) @@ -26,7 +26,8 @@ sidebar_label: getFileInfo | 参数 | 类型 | 默认值 | 必填 | 说明 | | --- | --- | :---: | :---: | --- | | filePath | `string` | | 是 | 要读取的文件路径 | -| digestAlgorithm | "md5" or "sha1" | `'md5'` | 否 | 计算文件摘要的算法 | +| apFilePath | `string` | | 是 | 本地文件路径
API 支持度: alipay | +| digestAlgorithm | "md5" or "sha1" | `"md5"` | 否 | 计算文件摘要的算法 | | complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | | fail | `(result: FailCallbackResult) => void` | | 否 | 接口调用失败的回调函数 | | success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | diff --git a/docs/apis/files/getFileSystemManager.md b/docs/apis/files/getFileSystemManager.md index a8f02b24285f..08172540cfc4 100644 --- a/docs/apis/files/getFileSystemManager.md +++ b/docs/apis/files/getFileSystemManager.md @@ -5,7 +5,7 @@ sidebar_label: getFileSystemManager 获取全局唯一的文件管理器 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getFileSystemManager.html) diff --git a/docs/apis/files/getSavedFileInfo.md b/docs/apis/files/getSavedFileInfo.md index c7690bff124e..9d3497396401 100644 --- a/docs/apis/files/getSavedFileInfo.md +++ b/docs/apis/files/getSavedFileInfo.md @@ -5,7 +5,7 @@ sidebar_label: getSavedFileInfo 获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件,若需要获取临时文件信息,请使用 [Taro.getFileInfo](/docs/apis/files/getFileInfo) 接口。 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getSavedFileInfo.html) @@ -26,6 +26,7 @@ sidebar_label: getSavedFileInfo | 参数 | 类型 | 必填 | 说明 | | --- | --- | :---: | --- | | filePath | `string` | 是 | 文件路径 | +| apFilePath | `string` | 是 | 文件路径
API 支持度: alipay | | complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | | fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | | success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | diff --git a/docs/apis/files/getSavedFileList.md b/docs/apis/files/getSavedFileList.md index e3a41960cd88..41bb3678865b 100644 --- a/docs/apis/files/getSavedFileList.md +++ b/docs/apis/files/getSavedFileList.md @@ -5,7 +5,7 @@ sidebar_label: getSavedFileList 获取本地已保存的文件列表 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.getSavedFileList.html) @@ -44,6 +44,7 @@ sidebar_label: getSavedFileList | --- | --- | --- | | createTime | `number` | 文件保存时的时间戳,从1970/01/01 08:00:00 到当前时间的秒数 | | filePath | `string` | 本地路径 | +| apFilePath | `string` | 文件路径
API 支持度: alipay | | size | `number` | 本地文件大小,以字节为单位 | ## 示例代码 diff --git a/docs/apis/files/openDocument.md b/docs/apis/files/openDocument.md index 6b9212ce6af7..6a7775821e30 100644 --- a/docs/apis/files/openDocument.md +++ b/docs/apis/files/openDocument.md @@ -5,7 +5,7 @@ sidebar_label: openDocument 新开页面打开文档,支持格式 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.openDocument.html) diff --git a/docs/apis/files/saveFile.md b/docs/apis/files/saveFile.md index aa4be33331dc..bf569f6674be 100644 --- a/docs/apis/files/saveFile.md +++ b/docs/apis/files/saveFile.md @@ -5,7 +5,7 @@ sidebar_label: saveFile 保存文件到本地。**注意:saveFile 会把临时文件移动,因此调用成功后传入的 tempFilePath 将不可用** -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.saveFile.html) @@ -29,6 +29,7 @@ sidebar_label: saveFile | complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | | fail | `(result: FailCallbackResult) => void` | 否 | 接口调用失败的回调函数 | | filePath | `string` | 否 | 要存储的文件路径 | +| apFilePath | `string` | 是 | 要保存的本地临时文件路径
API 支持度: alipay | | success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | ### FailCallbackResult diff --git a/docs/apis/files/saveFileToDisk.md b/docs/apis/files/saveFileToDisk.md index b73eb1ac74c0..9cf2359cb2e5 100644 --- a/docs/apis/files/saveFileToDisk.md +++ b/docs/apis/files/saveFileToDisk.md @@ -5,7 +5,7 @@ sidebar_label: saveFileToDisk 保存文件系统的文件到用户磁盘,仅在 PC 端支持 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/file/wx.saveFileToDisk.html) diff --git a/docs/apis/location/chooseLocation.md b/docs/apis/location/chooseLocation.md index 2033c7b6f906..9d2eb3e00e3b 100644 --- a/docs/apis/location/chooseLocation.md +++ b/docs/apis/location/chooseLocation.md @@ -7,7 +7,7 @@ sidebar_label: chooseLocation `chooseLocation` api功能是依赖于腾讯位置服务,所以需要使用 api 密钥。如果您没有,可以前往腾讯位置服务[开发者控制台](https://lbs.qq.com/console/mykey.html?console=mykey)进行申请。 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.chooseLocation.html) @@ -30,19 +30,26 @@ sidebar_label: chooseLocation | latitude | `number` | 否 | 目标地纬度 | | longitude | `number` | 否 | 目标地经度 | | mapOpts | `Record` | 否 | 地图选点组件参数
API 支持度: h5
h5: 仅支持 H5 使用
[参考地址](https://lbs.qq.com/webApi/component/componentGuide/componentPicker) | +| title | `string` | 否 | 页面显示标题
API 支持度: alipay
alipay: 安卓默认值为 位置,iOS、IDE 默认值为 你在哪里?
[参考地址](https://opendocs.alipay.com/mini/api/location?pathHash=951b46a1) | | success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | | fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | | complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | ### SuccessCallbackResult -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| address | `string` | 详细地址 | -| latitude | `number` | 纬度,浮点数,范围为-90~90,负数表示南纬。使用 gcj02 国测局坐标系 | -| longitude | `number` | 经度,浮点数,范围为-180~180,负数表示西经。使用 gcj02 国测局坐标系 | -| name | `string` | 位置名称 | -| errMsg | `string` | 调用结果 | +| 参数 | 类型 | 必填 | 说明 | +| --- | --- | :---: | --- | +| address | `string` | 是 | 详细地址 | +| latitude | `number` | 是 | 纬度,浮点数,范围为-90~90,负数表示南纬。使用 gcj02 国测局坐标系 | +| longitude | `number` | 是 | 经度,浮点数,范围为-180~180,负数表示西经。使用 gcj02 国测局坐标系 | +| name | `string` | 是 | 位置名称 | +| adCode | `number` | 否 | 区县代码
API 支持度: alipay | +| adName | `string` | 否 | 区县名称
API 支持度: alipay | +| cityCode | `string` | 否 | 城市代码
API 支持度: alipay | +| cityName | `string` | 否 | 城市名称
API 支持度: alipay | +| provinceCode | `number` | 否 | 省份代码
API 支持度: alipay | +| provinceName | `string` | 否 | 省份名称
API 支持度: alipay | +| errMsg | `string` | 是 | 调用结果 | ## 示例代码 diff --git a/docs/apis/location/getFuzzyLocation.md b/docs/apis/location/getFuzzyLocation.md index 052f8d94c45b..62ae6433586c 100644 --- a/docs/apis/location/getFuzzyLocation.md +++ b/docs/apis/location/getFuzzyLocation.md @@ -25,11 +25,18 @@ sidebar_label: getFuzzyLocation | 参数 | 类型 | 必填 | 说明 | | --- | --- | :---: | --- | -| type | "wgs84" or "gcj02" | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 Taro.openLocation 的坐标 | +| type | `keyof Type` | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 Taro.openLocation 的坐标 | | complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | | fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | | success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | +### Type + +| 参数 | 说明 | +| --- | --- | +| wgs84 | 返回 gps 坐标 | +| gcj02 | 返回 gcj02 坐标 | + ### SuccessCallbackResult | 参数 | 类型 | 说明 | diff --git a/docs/apis/location/getLocation.md b/docs/apis/location/getLocation.md index 4e9f28a1ee5b..8a42c7980414 100644 --- a/docs/apis/location/getLocation.md +++ b/docs/apis/location/getLocation.md @@ -9,7 +9,7 @@ sidebar_label: getLocation - 工具中定位模拟使用IP定位,可能会有一定误差。且工具目前仅支持 gcj02 坐标。 - 使用第三方服务进行逆地址解析时,请确认第三方服务默认的坐标系,正确进行坐标转换。 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.getLocation.html) @@ -27,28 +27,38 @@ sidebar_label: getLocation ### Option -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| altitude | `string` | 否 | 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度 | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| highAccuracyExpireTime | `number` | 否 | 高精度定位超时时间(ms),指定时间内返回最高精度,该值3000ms以上高精度定位才有效果 | -| isHighAccuracy | `boolean` | 否 | 开启高精度定位 | -| success | `(result: SuccessCallbackResult) => void` | 否 | 接口调用成功的回调函数 | -| type | `string` | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 Taro.openLocation 的坐标 | +| 参数 | 类型 | 默认值 | 必填 | 说明 | +| --- | --- | :---: | :---: | --- | +| altitude | `boolean` | `false` | 否 | 传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度 | +| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | +| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | +| highAccuracyExpireTime | `number` | | 否 | 高精度定位超时时间(ms),指定时间内返回最高精度,该值3000ms以上高精度定位才有效果 | +| isHighAccuracy | `boolean` | `false` | 否 | 开启高精度定位 | +| success | `(result: SuccessCallbackResult) => void` | | 否 | 接口调用成功的回调函数 | +| type | `string` | `"wgs84"` | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 Taro.openLocation 的坐标 | +| needFullAccuracy | `boolean` | `false` | 否 | 针对 iOS14/Android12 及以上的新特性,其他情况本参数忽略。默认情况宿主是精确定位就返回精确定位信息。
传入 true 会强制使用精确定位信息,iOS14/Android12 及以上如果没有精确定位权限,会弹出精确定位授权弹框
API 支持度: swan | ### SuccessCallbackResult -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| accuracy | `number` | 位置的精确度 | -| altitude | `number` | 高度,单位 m | -| horizontalAccuracy | `number` | 水平精度,单位 m | -| latitude | `number` | 纬度,范围为 -90~90,负数表示南纬 | -| longitude | `number` | 经度,范围为 -180~180,负数表示西经 | -| speed | `number` | 速度,单位 m/s | -| verticalAccuracy | `number` | 垂直精度,单位 m(Android 无法获取,返回 0) | -| errMsg | `string` | 调用结果 | +| 参数 | 类型 | 必填 | 说明 | +| --- | --- | :---: | --- | +| accuracy | `number` | 是 | 位置的精确度 | +| altitude | `number` | 是 | 高度,单位 m | +| horizontalAccuracy | `number` | 是 | 水平精度,单位 m | +| latitude | `number` | 是 | 纬度,范围为 -90~90,负数表示南纬 | +| longitude | `number` | 是 | 经度,范围为 -180~180,负数表示西经 | +| speed | `number` | 是 | 速度,单位 m/s | +| verticalAccuracy | `number` | 是 | 垂直精度,单位 m(Android 无法获取,返回 0) | +| street | `string` | 否 | 城市名称
API 支持度: swan | +| cityCode | `string` | 否 | 国家代码
API 支持度: swan | +| city | `string` | 否 | 城市名称
API 支持度: swan, tt | +| country | `string` | 否 | 国家
API 支持度: swan | +| countryCode | `string` | 否 | 国家代码
API 支持度: swan | +| province | `string` | 否 | 省份
API 支持度: swan | +| streetNumber | `string` | 否 | 街道号码
API 支持度: swan | +| district | `string` | 否 | 区
API 支持度: swan | +| isFullAccuracy | `boolean` | 否 | 是不是精确定位信息
API 支持度: swan | +| errMsg | `string` | 是 | 调用结果 | ## 示例代码 diff --git a/docs/apis/location/offLocationChange.md b/docs/apis/location/offLocationChange.md index d6a7b01489d5..2346bf155d14 100644 --- a/docs/apis/location/offLocationChange.md +++ b/docs/apis/location/offLocationChange.md @@ -5,18 +5,18 @@ sidebar_label: offLocationChange 取消监听实时地理位置变化事件 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.offLocationChange.html) ## 类型 ```tsx -(callback: (res: TaroGeneral.CallbackResult) => void) => void +(callback?: Callback) => void ``` ## 参数 | 参数 | 类型 | 说明 | | --- | --- | --- | -| callback | `(res: TaroGeneral.CallbackResult) => void` | 实时地理位置变化事件的回调函数 | +| callback | `Callback` | 实时地理位置变化事件的回调函数 | diff --git a/docs/apis/location/offLocationChangeError.md b/docs/apis/location/offLocationChangeError.md index cfb7314565a9..c0cacc35fbff 100644 --- a/docs/apis/location/offLocationChangeError.md +++ b/docs/apis/location/offLocationChangeError.md @@ -12,7 +12,7 @@ sidebar_label: offLocationChangeError ## 类型 ```tsx -(callback: Callback) => void +(callback?: Callback) => void ``` ## 参数 diff --git a/docs/apis/location/onLocationChange.md b/docs/apis/location/onLocationChange.md index 3b4b600f9e47..e409fa055f20 100644 --- a/docs/apis/location/onLocationChange.md +++ b/docs/apis/location/onLocationChange.md @@ -5,7 +5,7 @@ sidebar_label: onLocationChange 监听实时地理位置变化事件,需结合 Taro.startLocationUpdateBackground、Taro.startLocationUpdate 使用。 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.onLocationChange.html) @@ -35,15 +35,24 @@ sidebar_label: onLocationChange ### CallbackResult -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| accuracy | `number` | 位置的精确度 | -| altitude | `number` | 高度,单位 m | -| horizontalAccuracy | `number` | 水平精度,单位 m | -| latitude | `number` | 纬度,范围为 -90~90,负数表示南纬 | -| longitude | `number` | 经度,范围为 -180~180,负数表示西经 | -| speed | `number` | 速度,单位 m/s | -| verticalAccuracy | `number` | 垂直精度,单位 m(Android 无法获取,返回 0) | +| 参数 | 类型 | 必填 | 说明 | +| --- | --- | :---: | --- | +| accuracy | `number` | 是 | 位置的精确度 | +| altitude | `number` | 是 | 高度,单位 m | +| horizontalAccuracy | `number` | 是 | 水平精度,单位 m | +| latitude | `number` | 是 | 纬度,范围为 -90~90,负数表示南纬 | +| longitude | `number` | 是 | 经度,范围为 -180~180,负数表示西经 | +| speed | `number` | 是 | 速度,单位 m/s | +| verticalAccuracy | `number` | 是 | 垂直精度,单位 m(Android 无法获取,返回 0) | +| street | `string` | 否 | 街道名称
API 支持度: swan | +| cityCode | `string` | 否 | 城市编码
API 支持度: swan | +| city | `string` | 否 | 城市名称
API 支持度: swan, tt
tt: iOS 不支持 | +| country | `string` | 否 | 国家
API 支持度: swan | +| countryCode | `string` | 否 | 国家代码
API 支持度: swan | +| province | `string` | 否 | 省份
API 支持度: swan | +| streetNumber | `string` | 否 | 街道号码
API 支持度: swan | +| district | `string` | 否 | 区
API 支持度: swan | +| isFullAccuracy | `boolean` | 否 | 是不是精确定位信息
API 支持度: swan | ## 示例代码 diff --git a/docs/apis/location/onLocationChangeError.md b/docs/apis/location/onLocationChangeError.md index 2459b4de6d7f..ceea7f0ef57a 100644 --- a/docs/apis/location/onLocationChangeError.md +++ b/docs/apis/location/onLocationChangeError.md @@ -35,6 +35,7 @@ sidebar_label: onLocationChangeError ### CallbackResult -| 参数 | 类型 | 说明 | -| --- | --- | --- | -| errCode | `number` | 错误码 | +| 参数 | 类型 | 必填 | 说明 | +| --- | --- | :---: | --- | +| errCode | `number` | 是 | 错误码 | +| errMsg | `string` | 否 | 错误信息
API 支持度: tt
tt: 最低支持版本 2.48.0 | diff --git a/docs/apis/location/openLocation.md b/docs/apis/location/openLocation.md index c2a8be458c2d..8a3c69ecb3ce 100644 --- a/docs/apis/location/openLocation.md +++ b/docs/apis/location/openLocation.md @@ -5,7 +5,7 @@ sidebar_label: openLocation 使用微信内置地图查看位置 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.openLocation.html) @@ -27,11 +27,12 @@ sidebar_label: openLocation | --- | --- | :---: | --- | | latitude | `number` | 是 | 纬度,范围为-90~90,负数表示南纬。使用 gcj02 国测局坐标系 | | longitude | `number` | 是 | 经度,范围为-180~180,负数表示西经。使用 gcj02 国测局坐标系 | +| scale | `number` | 否 | 缩放比例
weapp: 范围 5~18,默认值18
alipay: 范围 3~19,默认值15 | +| name | `string` | 否 | 位置名 | | address | `string` | 否 | 地址的详细说明 | +| ignoredApps | `any[]` | 否 | 定义在拉起的地图 App 面板中需要被屏蔽的地图类 App
API 支持度: swan | | complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | | fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| name | `string` | 否 | 位置名 | -| scale | `number` | 否 | 缩放比例,范围5~18 | | success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | ## 示例代码 diff --git a/docs/apis/location/startLocationUpdate.md b/docs/apis/location/startLocationUpdate.md index ed56304b4018..eacbbf7ee09c 100644 --- a/docs/apis/location/startLocationUpdate.md +++ b/docs/apis/location/startLocationUpdate.md @@ -8,7 +8,7 @@ sidebar_label: startLocationUpdate **注意** - 获取位置信息需配置[地理位置用途说明](https://developers.weixin.qq.com/miniprogram/dev/reference/configuration/app.html#permission)。 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.startLocationUpdate.html) @@ -26,8 +26,10 @@ sidebar_label: startLocationUpdate ### Option -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | +| 参数 | 类型 | 默认值 | 必填 | 说明 | +| --- | --- | :---: | :---: | --- | +| type | `string` | `"gcj02"` | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 wx.openLocation 的坐标 | +| needFullAccuracy | `boolean` | `false` | 否 | 针对 iOS14/Android12 及以上的新特性,其他情况本参数忽略。默认情况宿主是精确定位就返回精确定位信息。
传入 true 会强制使用精确定位信息,iOS14/Android12 及以上如果没有精确定位权限,会弹出精确定位授权弹框
API 支持度: swan | +| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | +| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | +| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | diff --git a/docs/apis/location/startLocationUpdateBackground.md b/docs/apis/location/startLocationUpdateBackground.md index a467de721265..cb94cf604d9e 100644 --- a/docs/apis/location/startLocationUpdateBackground.md +++ b/docs/apis/location/startLocationUpdateBackground.md @@ -28,8 +28,9 @@ sidebar_label: startLocationUpdateBackground ### Option -| 参数 | 类型 | 必填 | 说明 | -| --- | --- | :---: | --- | -| complete | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | -| fail | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用失败的回调函数 | -| success | `(res: TaroGeneral.CallbackResult) => void` | 否 | 接口调用成功的回调函数 | +| 参数 | 类型 | 默认值 | 必填 | 说明 | +| --- | --- | :---: | :---: | --- | +| type | `string` | `"gcj02"` | 否 | wgs84 返回 gps 坐标,gcj02 返回可用于 wx.openLocation 的坐标 | +| complete | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | +| fail | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用失败的回调函数 | +| success | `(res: TaroGeneral.CallbackResult) => void` | | 否 | 接口调用成功的回调函数 | diff --git a/docs/apis/location/stopLocationUpdate.md b/docs/apis/location/stopLocationUpdate.md index 139f0de6a335..47b9f49c965b 100644 --- a/docs/apis/location/stopLocationUpdate.md +++ b/docs/apis/location/stopLocationUpdate.md @@ -5,7 +5,7 @@ sidebar_label: stopLocationUpdate 关闭监听实时位置变化,前后台都停止消息接收 -支持情况: +支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.stopLocationUpdate.html) diff --git a/docs/components/forms/form.md b/docs/components/forms/form.md index 4da26219ea6b..fa39b05d9950 100755 --- a/docs/components/forms/form.md +++ b/docs/components/forms/form.md @@ -92,7 +92,7 @@ export default { | --- | --- | :---: | :---: | --- | | reportSubmit | `boolean` | `false` | 否 | 是否返回 `formId` 用于发送模板消息。 | | reportSubmitTimeout | `number` | `0` | 否 | 等待一段时间(毫秒数)以确认 `formId` 是否生效。
如果未指定这个参数,`formId` 有很小的概率是无效的(如遇到网络失败的情况)。
指定这个参数将可以检测 `formId` 是否有效,
以这个参数的时间作为这项检测的超时时间。
如果失败,将返回 `requestFormId:fail` 开头的 `formId`。 | -| reportType | `string` | `'default'` | 否 | 模板消息的类型,report-submit 为 true 时填写有效
取值:default / subscribe | +| reportType | `string` | `"default"` | 否 | 模板消息的类型,report-submit 为 true 时填写有效
取值:default / subscribe | | templateId | string or string[] | | 否 | 发送订阅类模板消息所用的模板库标题 ID ,可通过 getTemplateLibraryList 获取
当参数类型为 Array 时,可传递 1~3 个模板库标题 ID (注:此处填写模板库id。示例:BD0001) | | subscribeId | `string` | | 否 | 发送订阅类模板消息时所使用的唯一标识符,内容由开发者自定义,用来标识订阅场景
注意:同一用户在同一 subscribe-id 下的多次授权不累积下发权限,只能下发一条。若要订阅多条,需要不同 subscribe-id | | conversionTarget | `number` | `0` | 否 | 用于分发目的。取值:0 或 1,其中 0 表示默认,1 表示留资目标,需要和留资分发配置一起使用,详情见留资分发配置 | diff --git a/docs/components/media/video.md b/docs/components/media/video.md index d52b65f7fe49..c32c79fc0124 100755 --- a/docs/components/media/video.md +++ b/docs/components/media/video.md @@ -95,7 +95,7 @@ export default class PageView extends Component { | poster | `string` | | 否 | 视频封面的图片网络资源地址,如果 controls 属性值为 false 则设置 poster 无效 | | showMuteBtn | `boolean` | `false` | 否 | 是否显示静音按钮 | | title | `string` | | 否 | 视频的标题,全屏时在顶部展示 | -| playBtnPosition | `keyof PlayBtnPosition` | `'bottom'` | 否 | 播放按钮的位置
- `bottom`: controls bar 上
- `center`: 视频中间 | +| playBtnPosition | `keyof PlayBtnPosition` | `"bottom"` | 否 | 播放按钮的位置
- `bottom`: controls bar 上
- `center`: 视频中间 | | enablePlayGesture | `boolean` | `false` | 否 | 是否开启播放手势,即双击切换播放/暂停 | | autoPauseIfNavigate | `boolean` | `true` | 否 | 当跳转到其它小程序页面时,是否自动暂停本页面的视频 | | autoPauseIfOpenNative | `boolean` | `true` | 否 | 当跳转到其它微信原生页面时,是否自动暂停本页面的视频 | diff --git a/docs/components/navig/navigation-bar.md b/docs/components/navig/navigation-bar.md index fe36d5b60746..2f4dd6a82810 100644 --- a/docs/components/navig/navigation-bar.md +++ b/docs/components/navig/navigation-bar.md @@ -6,6 +6,11 @@ sidebar_label: NavigationBar 页面导航条配置节点,用于指定导航栏的一些属性。只能是 PageMeta 组件内的第一个节点,需要配合它一同使用。 通过这个节点可以获得类似于调用 Taro.setNavigationBarTitle Taro.setNavigationBarColor 等接口调用的效果。 +:::info +Taro v3.6.19 开始支持 +需要配合 PageMeta 组件使用 +::: + 支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/component/navigation-bar.html) diff --git a/docs/components/page-meta.md b/docs/components/page-meta.md index fbc135211963..0f7b066182d2 100644 --- a/docs/components/page-meta.md +++ b/docs/components/page-meta.md @@ -6,6 +6,11 @@ sidebar_label: PageMeta 页面属性配置节点,用于指定页面的一些属性、监听页面事件。只能是页面内的第一个节点。可以配合 navigation-bar 组件一同使用。 通过这个节点可以获得类似于调用 Taro.setBackgroundTextStyle Taro.setBackgroundColor 等接口调用的效果。 +:::info +Taro v3.6.19 开始支持 +开发者需要在页面配置里添加:`enablePageMeta: true` +::: + 支持情况: > [参考文档](https://developers.weixin.qq.com/miniprogram/dev/component/page-meta.html) @@ -16,6 +21,49 @@ sidebar_label: PageMeta ComponentType ``` +## 示例代码 + +import { ReactIcon, VueIcon } from '@site/static/icons' +import Tabs from '@theme/Tabs' +import TabItem from '@theme/TabItem' + +, value: "React" }, { label: , value: "Vue" }]}> + + +```tsx +// page.config.ts +export default definePageConfig({ enablePageMeta: true, ... }) + +// page.tsx +function Index () { + return ( + + + + + + ) +} +``` + + + +```html + + + + +