From 608f7cf61be2bbdc84b844e5c429076c23355bbe Mon Sep 17 00:00:00 2001 From: DCloud_LXH <283700113@qq.com> Date: Fri, 8 Sep 2023 17:53:20 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20uni-app-x=20=E4=BA=8B=E4=BB=B6=E3=80=81?= =?UTF-8?q?dom?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vuepress/markdown/inject-json-to-md.js | 12 +++ docs/.vuepress/utils/customTypeJson.json | 1 + docs/.vuepress/utils/utsApiJson.json | 2 +- docs/.vuepress/utils/utsComJson.json | 2 +- docs/uni-app-x/_sidebar.md | 14 +++- docs/uni-app-x/common/customevent.md | 20 +++++ docs/uni-app-x/common/error.md | 10 +++ docs/uni-app-x/common/event.md | 10 +++ docs/uni-app-x/common/mouseevent.md | 10 +++ docs/uni-app-x/common/touch.md | 10 +++ docs/uni-app-x/common/touchevent.md | 10 +++ docs/uni-app-x/common/unierror.md | 10 +++ docs/uni-app-x/dom/cssstyledeclaration.md | 49 +++---------- docs/uni-app-x/dom/drawablecontext.md | 10 ++- docs/uni-app-x/dom/inode.md | 77 +------------------- 15 files changed, 130 insertions(+), 117 deletions(-) create mode 100644 docs/.vuepress/utils/customTypeJson.json create mode 100644 docs/uni-app-x/common/customevent.md create mode 100644 docs/uni-app-x/common/error.md create mode 100644 docs/uni-app-x/common/event.md create mode 100644 docs/uni-app-x/common/mouseevent.md create mode 100644 docs/uni-app-x/common/touch.md create mode 100644 docs/uni-app-x/common/touchevent.md create mode 100644 docs/uni-app-x/common/unierror.md diff --git a/docs/.vuepress/markdown/inject-json-to-md.js b/docs/.vuepress/markdown/inject-json-to-md.js index 02b942817..9dc9e16d2 100644 --- a/docs/.vuepress/markdown/inject-json-to-md.js +++ b/docs/.vuepress/markdown/inject-json-to-md.js @@ -3,6 +3,7 @@ let utsJson = {}; let utsApiJson = {}; let utsComJson = {}; let utsUnicloudApiJson = {}; +let customTypeJson = {}; try { cssJson = require('../utils/cssJson.json'); } catch (error) {} @@ -18,6 +19,9 @@ try { try { utsUnicloudApiJson = require('../utils/utsUnicloudApiJson.json'); } catch (error) {} +try { + customTypeJson = require('../utils/customTypeJson.json'); +} catch (error) {} function getRegExp(key) { @@ -65,6 +69,14 @@ const getJSON = text => { }; } + match = text.match(getRegExp('CUSTOMTYPEJSON')); + if (match) { + return { + match, + json: customTypeJson, + }; + } + return { match: null, json: {}, diff --git a/docs/.vuepress/utils/customTypeJson.json b/docs/.vuepress/utils/customTypeJson.json new file mode 100644 index 000000000..631be6792 --- /dev/null +++ b/docs/.vuepress/utils/customTypeJson.json @@ -0,0 +1 @@ +{"Event":{"name":"## Event","description":"","package":"> Package name: io.dcloud.uniapp.runtime","extends":"","param":"\n### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | - |\n\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n"},"INode":{"name":"## INode","description":"","package":"> Package name: io.dcloud.uniapp.runtime","extends":"","param":"\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| firstChild | INode | 是 | - |\n| lastChild | INode | 是 | - |\n| parentNode | INode | 是 | - |\n| previousSibling | INode | 是 | - |\n| nextSibling | INode | 是 | - |\n| nextElementSibling | INode | 是 | - |\n| childNodes | Array\\<[INode](/uni-app-x/dom/inode.md)\\> | 是 | 获取当前节点包含的子节点的集合 |\n| nodeName | string | 是 | 获取当前节点的节点名称 |\n| dataset | Map\\ | 是 | 获取节点上自定义数据属性（data-*）的集合 |\n| attributes | Map\\ | 是 | 获取节点上所有属性节点的集合 |\n| style | [CSSStyleDeclaration](/uni-app-x/dom/cssstyledeclaration.md) | 是 | CSSStyleDeclaration表示一个CSS 声明块对象，它是一个 CSS 属性键值对的集合，暴露样式信息和各种与样式相关的方法和属性。 |\n| scrollHeight | number | 是 | 表示节点的滚动视图高度 |\n| scrollLeft | number | 是 | 表示该节点横向滚动条距离最左的位移。 |\n| scrollTop | number | 是 | 表示该节点纵向滚动条距离 |\n| scrollWidth | Float | 是 | 表示节点的滚动视图宽度 |\n| getNodeId | () => string | 是 | 获取节点标识。 |\n| appendChild | ([INode](/uni-app-x/dom/inode.md)) => void | 是 | 将一个节点添加到指定父节点的子节点列表的末尾处。如果将被插入的节点已经存在于当前文档的文档树中，那么将会它从原先的位置移动到新的位置。 |\n| insertBefore | ([INode](/uni-app-x/dom/inode.md), [INode](/uni-app-x/dom/inode.md)) => void | 是 | 在参考节点之前插入一个拥有指定父节点的子节点。如果给定的子节点是对文档中现有节点的引用，insertBefore() 会将其从当前位置移动到新位置。 |\n| setAttribute | (string, any?) => void | 是 | 设置指定节点上的某个属性值。如果设置的属性已经存在，则更新该属性值；否则使用指定的名称和值添加一个新的属性。 |\n| getAttribute | (string) => any | 是 | 获取节点指定的属性值，如果指定的属性不存在则返回null。 |\n| hasAttribute | (string) => boolean | 是 | 返回改节点是否包含有指定的属性，属性存在则返回true，否则返回false。 |\n| removeAttribute | (string) => void | 是 | 从节点中删除一个属性，如果指定的属性不存在，则不做任何操作，也不会产生错误。 |\n| getBoundingClientRect | () => [DOMRect](/uni-app-x/dom/domrect.md) | 是 | 获取节点的大小及其相对于窗口的位置信息。 |\n| getDrawableContext | () => [DrawableContext](/uni-app-x/dom/drawablecontext.md) | 是 | 获取组件的绘制对象，仅uvue页面中的 view 组件支持，其它组件不支持则返回null。 |\n| addEventListener | (string, (T) => R) => void | 是 | 将指定的监听器注册到节点对象上，当该对象触发指定的事件时，指定的回调函数就会被执行。 |\n| removeEventListener | (string) => void | 是 | 删除使用 addEventListener 方法添加的事件监听器。 |\n| removeChild | ([INode](/uni-app-x/dom/inode.md)) => [INode](/uni-app-x/dom/inode.md) | 是 | 从节点中删除一个子节点，返回删除的节点。 |\n| remove | () => void | 是 | 把节点对象从它所属的 DOM 树中删除。 |\n| dispatchEvent | (string, [Event](/uni-app-x/common/event.md)) => void | 是 | 向一个指定的事件目标派发一个 Event，并以合适的顺序（同步地）调用此事件的监听器回调函数。 |\n| scrollTo | (number, number) => void | 是 | 使界面滚动到给定元素的指定坐标位置 |\n| scrollBy | (number, number) => void | 是 | 使得元素滚动一段特定距离 |\n"},"CSSStyleDeclaration":{"name":"## CSSStyleDeclaration","description":"\nCSSStyleDeclaration表示一个CSS 声明块对象，它是一个 CSS 属性键值对的集合，暴露样式信息和各种与样式相关的方法和属性。","package":"> Package name: io.dcloud.uniapp.runtime","extends":"","param":"\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| setProperty | (string, any?) => void | 是 | 对CSS指定样式设置一个新值，如有此样式已存在则更新。 |\n| getPropertyValue | (string) => any | 是 | 获取CSS指定的样式值，如果指定的样式不存在则返回null。 |\n"},"DOMRect":{"name":"## DOMRect","description":"\r\n一个 DOMRect 代表一个矩形。","package":"> Package name: io.dcloud.uniapp.runtime","extends":"","param":"\n### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 否 | - |\n| y | number | 否 | - |\n| width | number | 否 | - |\n| height | number | 否 | - |\n\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| width | number | 是 | 矩形的宽 |\n| height | number | 是 | 矩形的高 |\n| x | number | 是 | 矩形原点的x坐标 |\n| y | number | 是 | 矩形原点的y坐标 |\n| left | number | 是 | 矩形的左坐标值 |\n| right | number | 是 | 矩形的右坐标值 |\n| top | number | 是 | 矩形的顶坐标值 |\n| bottom | number | 是 | 矩形的底坐标值 |\n"},"DrawableContext":{"name":"## DrawableContext","description":"","package":"> Package name: io.dcloud.uniapp.runtime","extends":"","param":"\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| font | string | 是 | 设置字体大小，默认为`10px` |\n| fillStyle | string | 是 | 设置填充颜色，默认为`#000 (黑色)` |\n| lineCap | string | 是 | 指定如何绘制每一条线条末端的属性，默认为`butt` |\n| lineDashOffset | number | 是 | 设置虚线偏移量 |\n| lineJoin | string | 是 | 设置 2 个长度不为 0 的线条相连部分如何连接在一起的属性，默认值`miter` |\n| lineWidth | number | 是 | 设置线条的宽度，默认为`1px` |\n| strokeStyle | string | 是 | 设置边框的颜色，默认为`#000 (黑色)` |\n| textAlign | string | 是 | 设置文本的对齐方式，默认为`left` |\n| beginPath | () => void | 是 | 创建一个新的空路径 |\n| arc | (number, number, number, number, number, boolean) => void | 是 | 绘制一段弧线 |\n| moveTo | (number, number) => void | 是 | 将一个新的路径的起始点移动到 (x，y) 坐标 |\n| rect | (number, number, number, number) => void | 是 | 创建一个矩形路径 |\n| lineTo | (number, number) => void | 是 | 将路径的最后一个点连接到 (x，y) 坐标 |\n| closePath | () => void | 是 | 闭合路径，将最后一个点与起点连接起来。如果图形已经封闭，或者只有一个点，那么此方法不会产生任何效果。 |\n| stroke | () => void | 是 | 绘制当前或已经存在的路径的边框。 |\n| strokeRect | (number, number, number, number) => void | 是 | 绘制一个矩形框 |\n| strokeText | (string, number, number) => void | 是 | 绘制空心字符 |\n| fill | (string) => void | 是 | 填充当前或已存在的路径 |\n| fillRect | (number, number, number, number) => void | 是 | 绘制一个实心矩形 |\n| fillText | (string, number, number) => void | 是 | 绘制实心字符 |\n| reset | () => void | 是 | 清空绘制数据 |\n| update | () => void | 是 | 将所有绘制内容更新到画布上 |\n| setLineDash | (number\\[\\]) => void | 是 | 设置虚线样式 |\n"},"CustomEvent":{"name":"## CustomEvent","description":"","package":"> Package name: io.dcloud.uniapp.runtime","extends":"```mermaid\nclassDiagram\n\nEvent <|-- CustomEvent : Extend\n```","param":"\n### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | - |\n| CustomEventOptions | [CustomEventOptions\\](#customeventoptions) | 是 | |\n\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n"},"CustomEventOptions":{"name":"## CustomEventOptions","description":"","package":"> Package name: io.dcloud.uniapp.runtime","extends":"","param":"\n### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n"},"MouseEvent":{"name":"## MouseEvent","description":"","package":"> Package name: io.dcloud.uniapp.runtime","extends":"```mermaid\nclassDiagram\n\nEvent <|-- MouseEvent : Extend\n```","param":"\n### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | - |\n| x | number | 是 | - |\n| y | number | 是 | - |\n| clientX | number | 是 | - |\n| clientY | number | 是 | - |\n| pageX | number | 是 | - |\n| pageY | number | 是 | - |\n| screenX | number | 是 | - |\n| screenY | number | 是 | - |\n\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| clientX | number | 是 | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | 相对于页面可显示区域顶部的距离 |\n| x | number | 是 | 相对于页面可显示区域左边的距离，同`clientX` |\n| y | number | 是 | 相对于页面可显示区域顶部的距离，同`clientY` |\n| pageX | number | 是 | 相对于文档左边的距离 |\n| pageY | number | 是 | 相对于文档顶部的距离 |\n| screenX | number | 是 | 相对于屏幕左边距离 |\n| screenY | number | 是 | 相对于屏幕顶部的距离 |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n"},"TouchEvent":{"name":"## TouchEvent","description":"","package":"> Package name: io.dcloud.uniapp.runtime","extends":"```mermaid\nclassDiagram\n\nEvent <|-- TouchEvent : Extend\n```","param":"\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| touches | Array\\<[Touch](/uni-app-x/common/touch.md)\\> | 是 | 当前停留在屏幕中的触摸点信息的数组 |\n| changedTouches | Array\\<[Touch](/uni-app-x/common/touch.md)\\> | 是 | 当前变化的触摸点信息的数组 |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n"},"Touch":{"name":"## Touch","description":"","package":"> Package name: io.dcloud.uniapp.runtime","extends":"","param":"\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| clientX | number | 是 | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | 相对于页面可显示区域顶部的距离 |\n| identifier | number | 是 | 当前`Touch`对象的唯一标识符 |\n| pageX | number | 是 | 相对于文档左边的距离 |\n| pageY | number | 是 | 相对于文档顶部的距离 |\n| screenX | number | 是 | 相对于屏幕左边距离 |\n| screenY | number | 是 | 相对于屏幕顶部的距离 |\n| force | number | 否 | 返回当前触摸点按下的压力大小 |\n"},"UniError":{"name":"## UniError","description":"\r\nuni api统一错误信息对象 ","package":"> Package name: io.dcloud.uniapp","extends":"```mermaid\nclassDiagram\n\nError <|-- UniError : Extend\n```","param":"\n### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errSubject | string | 是 | - |\n| errCode | number | 是 | - |\n| errMsg | string | 是 | - |\n\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 否 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/common/error.md) | 否 | - |\n"},"UTSJSONObject":{"name":"## UTSJSONObject","description":"","package":"> Package name: ","extends":"","param":"\n### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n"}} \ No newline at end of file diff --git a/docs/.vuepress/utils/utsApiJson.json b/docs/.vuepress/utils/utsApiJson.json index 1923bb84a..a6af79851 100644 --- a/docs/.vuepress/utils/utsApiJson.json +++ b/docs/.vuepress/utils/utsApiJson.json @@ -1 +1 @@ -{"getApp":{"name":"## getApp(opts?) @getapp","description":"","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| opts | GetAppOption | 否 | - |","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [AppInstance\\ & T](#appinstance) | \n\n#### AppInstance\\ & T @appinstance \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| globalData | AnyObject | 否 | - |\n| onLaunch | (LaunchShowOption?) => void | 否 | 生命周期回调 监听应用初始化 应用初始化完成时触发，全局只触发一次。 文档: \\[https://uniapp.dcloud.io/collocation/frame/lifecycle\\](https://uniapp.dcloud.io/collocation/frame/lifecycle) |\n| onShow | (LaunchShowOption?) => void | 否 | 生命周期回调 监听应用显示 应用启动，或从后台进入前台显示时触发 文档: \\[https://uniapp.dcloud.io/collocation/frame/lifecycle\\](https://uniapp.dcloud.io/collocation/frame/lifecycle) |\n| onHide | () => void | 否 | 生命周期回调 监听应用隐藏 应用从前台进入后台时触发 文档: \\[https://uniapp.dcloud.io/collocation/frame/lifecycle\\](https://uniapp.dcloud.io/collocation/frame/lifecycle) |\n| onError | (string) => void | 否 | 错误监听函数 小程序发生脚本错误或 API 调用报错时触发 |\n| onPageNotFound | (PageNotFoundOption) => void | 否 | 页面不存在监听函数 应用要打开的页面不存在时触发，会带上页面信息回调该函数 **注意：** 1. 如果开发者没有添加 `onPageNotFound` 监听，当跳转页面不存在时，将推入微信客户端原生的页面不存在提示页面。 2. 如果 `onPageNotFound` 回调中又重定向到另一个不存在的页面，将推入微信客户端原生的页面不存在提示页面，并且不再回调 `onPageNotFound`。 文档: \\[https://uniapp.dcloud.io/collocation/frame/lifecycle\\](https://uniapp.dcloud.io/collocation/frame/lifecycle) |\n| onUnhandledRejection | (UniNamespace.OnUnhandledRejectionCallbackResult) => void | 否 | 未处理的 Promise 拒绝事件监听函数 文档: \\[https://uniapp.dcloud.io/collocation/frame/lifecycle\\](https://uniapp.dcloud.io/collocation/frame/lifecycle) |\n| onThemeChange | (UniNamespace.OnThemeChangeCallbackResult) => void | 否 | 监听系统主题变化 文档: \\[https://uniapp.dcloud.io/collocation/frame/lifecycle\\](https://uniapp.dcloud.io/collocation/frame/lifecycle) |\n| onUniNViewMessage | (AnyObject) => void | 否 | 监听 nvue 页面消息 nvue 页面使用 `uni.postMessage` 发送消息时触发 文档: \\[https://uniapp.dcloud.io/collocation/frame/lifecycle\\](https://uniapp.dcloud.io/collocation/frame/lifecycle) |\n| onExit | () => void | 否 | 监听应用退出。app-uvue-android 3.9+ 文档: \\[https://uniapp.dcloud.io/collocation/frame/lifecycle\\](https://uniapp.dcloud.io/collocation/frame/lifecycle) |\n| onLastPageBackPress | () => void | 否 | 最后一个页面按下Android back键，常用于自定义退出。app-uvue-android 3.9+ 文档: \\[https://uniapp.dcloud.io/collocation/frame/lifecycle\\](https://uniapp.dcloud.io/collocation/frame/lifecycle) |\n","compatibility":"","tutorial":""},"getCurrentPages":{"name":"## getCurrentPages() @getcurrentpages","description":"","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PageInstance\\ & T](#pageinstance)\\> | \n\n#### PageInstance\\ & T @pageinstance \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| onInit | (Map?) => void | 否 | 生命周期回调 监听页面初始化 页面初始化时触发。一个页面只会调用一次，可以在 onInit 的参数中获取打开当前页面路径中的参数。 |\n| onLoad | (Map?) => void | 否 | 生命周期回调 监听页面加载 页面加载时触发。一个页面只会调用一次，可以在 onLoad 的参数中获取打开当前页面路径中的参数。 |\n| onShow | () => void | 否 | 生命周期回调 监听页面显示 页面显示/切入前台时触发。 文档: \\[https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle\\](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle) |\n| onReady | () => void | 否 | 生命周期回调 监听页面初次渲染完成 页面初次渲染完成时触发。一个页面只会调用一次，代表页面已经准备妥当，可以和视图层进行交互。 文档: \\[https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle\\](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle) |\n| onHide | () => void | 否 | 生命周期回调 监听页面隐藏 页面隐藏/切入后台时触发。 如 `navigateTo` 或底部 `tab` 切换到其他页面，应用切入后台等。 文档: \\[https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle\\](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle) |\n| onUnload | () => void | 否 | 生命周期回调 监听页面卸载 页面卸载时触发。如 `redirectTo` 或 `navigateBack` 到其他页面时。 文档: \\[https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle\\](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle) |\n| onPullDownRefresh | () => void | 否 | 监听用户下拉动作 - 需要在 `pages.json` 的页面配置中开启 `enablePullDownRefresh` 。 - 可以通过 `uni.startPullDownRefresh` 触发下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。 - 当处理完数据刷新后，`uni.stopPullDownRefresh` 可以停止当前页面的下拉刷新。 文档: \\[https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle\\](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle) |\n| onReachBottom | () => void | 否 | 页面上拉触底事件的处理函数 - 可以在 `pages.json` 的页面配置中设置触发距离 `onReachBottomDistance` 。 - 在触发距离内滑动期间，本事件只会被触发一次。 文档: \\[https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle\\](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle) |\n| onShareAppMessage | (ShareAppMessageOption) => CustomShareContent | 否 | 用户点击右上角转发 监听用户点击页面内转发按钮（`\\` 组件 `open-type=\"share\"`）或右上角菜单“转发”按钮的行为，并自定义转发内容。 |\n| onShareTimeline | () => ShareTimelineContent | 否 | 用户点击右上角转发到朋友圈 监听右上角菜单“分享到朋友圈”按钮的行为，并自定义发享内容。 文档: \\[https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle\\](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle) |\n| onAddToFavorites | (AddToFavoritesOption) => CustomFavoritesContent | 否 | 用户点击右上角收藏 监听用户点击右上角菜单“收藏”按钮的行为，并自定义收藏内容。 文档: \\[https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle\\](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle) |\n| onPageScroll | (PageScrollOption) => void | 否 | 页面滚动触发事件的处理函数 监听用户滑动页面事件。 |\n| onResize | (ResizeOption) => void | 否 | 页面尺寸改变时触发 |\n| onTabItemTap | (TabItemTapOption) => void | 否 | 当前是 tab 页时，点击 tab 时触发 |\n| onNavigationBarButtonTap | (NavigationBarButtonTapOption) => void | 否 | 监听原生标题栏按钮点击事件 |\n| onBackPress | (BackPressOption) => any | 否 | 监听页面返回 |\n| onNavigationBarSearchInputChanged | (NavigationBarSearchInputEvent) => void | 否 | 监听原生标题栏搜索输入框输入内容变化事件 文档: \\[https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle\\](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle) |\n| onNavigationBarSearchInputConfirmed | (NavigationBarSearchInputEvent) => void | 否 | 监听原生标题栏搜索输入框搜索事件，用户点击软键盘上的“搜索”按钮时触发。 文档: \\[https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle\\](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle) |\n| onNavigationBarSearchInputClicked | () => void | 否 | 监听原生标题栏搜索输入框点击事件 文档: \\[https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle\\](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle) |\n| route | string | 否 | 到当前页面的路径，类型为 `String` |\n| $getAppWebview | () => PlusWebviewWebviewObject | 否 | 获取当前页面的webview对象实例。仅 App 平台支持 |\n| $vm | any | 否 | 当前页面的 Vue 实例 |\n","compatibility":"","tutorial":""},"$on":{"name":"## uni.$on(eventName, callback) @$on","description":"\n监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| eventName | string | 是 | - |\n| callback | Function | 是 | - |","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[$on](http://uniapp.dcloud.io/api/window/communication?id=on)\n"},"$off":{"name":"## uni.$off(eventName, callback) @$off","description":"\n移除自定义事件监听器。如果没有指定事件名，则移除所有事件监听器。如果提供事件名，则移除该事件的所有监听器。如果提供了事件名和回调，则只移除这个回调的监听器。\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| eventName | string | 是 | - |\n| callback | Function | 是 | - |","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[$off](http://uniapp.dcloud.io/api/window/communication?id=off)\n"},"$once":{"name":"## uni.$once(eventName, callback) @$once","description":"\n监听一个自定义事件。事件只触发一次，在第一次触发之后移除事件监听器。\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| eventName | string | 是 | - |\n| callback | Function | 是 | - |","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[$once](http://uniapp.dcloud.io/api/window/communication?id=once)\n"},"$emit":{"name":"## uni.$emit(eventName, args) @$emit","description":"\n触发自定义事件，附加的参数会传递给事件监听器。\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| eventName | string | 是 | - |\n| args | any | 是 | - |","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[$emit](http://uniapp.dcloud.io/api/window/communication?id=emit)\n"},"getLaunchOptionsSync":{"name":"## uni.getLaunchOptionsSync() @getlaunchoptionssync","description":"\n获取本次启动时的参数。返回值与App.onLaunch的回调参数一致\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [OnLaunchOptions](#onlaunchoptions) | \n\n#### OnLaunchOptions @onlaunchoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| path | string | 是 | - |\n","compatibility":"","tutorial":"\n### 参见\n[getLaunchOptionsSync](http://uniapp.dcloud.io/api/plugins/getLaunchOptionsSync)\n"},"navigateTo":{"name":"## uni.navigateTo(options) @navigateto","description":"\n保留当前页面，跳转到应用内的某个页面\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [NavigateToOptions](#navigatetooptions) | 是 | - |\n#### NavigateToOptions @navigatetooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| animationType | string | 否 | 窗口显示的动画类型 - auto: 自动选择动画效果 - none: 无动画效果 - slide-in-right: 从右侧横向滑动效果 - slide-in-left: 左侧横向滑动效果 - slide-in-top: 从上侧竖向滑动效果 - slide-in-bottom: 从下侧竖向滑动效果 - fade-in: 从透明到不透明逐渐显示效果 - zoom-out: 从小到大逐渐放大显示效果 - zoom-fade-out: 从小到大逐渐放大并且从透明到不透明逐渐显示效果 - pop-in: 从右侧平移入栈动画效果 - UnionType =\\> 'auto' \\| 'none' \\| 'slide-in-right' \\| 'slide-in-left' \\| 'slide-in-top' \\| 'slide-in-bottom' \\| 'fade-in' \\| 'zoom-out' \\| 'zoom-fade-out' \\| 'pop-in' |\n| animationDuration | number | 否 | 窗口显示动画的持续时间，单位为 ms |\n| events | any | 否 | 页面间通信接口，用于监听被打开页面发送到当前页面的数据 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[navigateTo](http://uniapp.dcloud.io/api/router?id=navigateto)\n"},"redirectTo":{"name":"## uni.redirectTo(options) @redirectto","description":"\n关闭当前页面，跳转到应用内的某个页面\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [RedirectToOptions](#redirecttooptions) | 是 | - |\n#### RedirectToOptions @redirecttooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[redirectTo](http://uniapp.dcloud.io/api/router?id=redirectto)\n"},"reLaunch":{"name":"## uni.reLaunch(options) @relaunch","description":"\n关闭所有页面，打开到应用内的某个页面\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ReLaunchOptions](#relaunchoptions) | 是 | - |\n#### ReLaunchOptions @relaunchoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[reLaunch](http://uniapp.dcloud.io/api/router?id=relaunch)\n"},"switchTab":{"name":"## uni.switchTab(options) @switchtab","description":"\n跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SwitchTabOptions](#switchtaboptions) | 是 | - |\n#### SwitchTabOptions @switchtaboptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 需要跳转的 tabBar 页面的路径，路径后不能带参数 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[switchTab](http://uniapp.dcloud.io/api/router?id=switchtab)\n"},"navigateBack":{"name":"## uni.navigateBack(options?) @navigateback","description":"\n关闭当前页面，返回上一页面或多级页面\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [NavigateBackOptions](#navigatebackoptions) | 否 | - |\n#### NavigateBackOptions @navigatebackoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| delta | number | 否 | 返回的页面数，如果 delta 大于现有页面数，则返回到首页 |\n| animationType | string | 否 | 窗口关闭的动画类型 - auto: 自动选择动画效果 - none: 无动画效果 - slide-out-right: 横向向右侧滑出屏幕动画 - slide-out-left: 横向向左侧滑出屏幕动画 - slide-out-top: 竖向向上侧滑出屏幕动画 - slide-out-bottom: 竖向向下侧滑出屏幕动画 - fade-out: 从不透明到透明逐渐隐藏动画 - zoom-in: 从大逐渐缩小关闭动画 - zoom-fade-in: 从大逐渐缩小并且从不透明到透明逐渐隐藏关闭动画 - pop-out: 从右侧平移出栈动画效果 - UnionType =\\> 'auto' \\| 'none' \\| 'slide-out-right' \\| 'slide-out-left' \\| 'slide-out-top' \\| 'slide-out-bottom' \\| 'fade-out' \\| 'zoom-in' \\| 'zoom-fade-in' \\| 'pop-out' |\n| animationDuration | number | 否 | 窗口关闭动画的持续时间，单位为 ms |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[navigateBack](http://uniapp.dcloud.io/api/router?id=navigateback)\n"},"createSelectorQuery":{"name":"## uni.createSelectorQuery() @createselectorquery","description":"\n返回一个SelectorQuery对象实例\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| SelectorQuery | \n","compatibility":"","tutorial":"\n### 参见\n[createSelectorQuery](http://uniapp.dcloud.io/api/ui/nodes-info?id=createselectorquery)\n"},"loadFontFace":{"name":"## uni.loadFontFace(options) @loadfontface","description":"\n动态加载网络字体\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [LoadFontFaceOptions](#loadfontfaceoptions) | 是 | - |\n#### LoadFontFaceOptions @loadfontfaceoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| global | boolean | 否 | 是否全局生效 |\n| family | string | 是 | 定义的字体名称 |\n| source | string | 是 | 字体资源的地址。建议格式为 TTF 和 WOFF，WOFF2 在低版本的iOS上会不兼容。 |\n| desc | LoadFontFaceOptionDesc | 否 | - |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### LoadFontFaceOptionDesc @loadfontfaceoptiondesc \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| style | string | 是 | - |\n| weight | string | 是 | - |\n| variant | string | 是 | - |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[loadFontFace](http://uniapp.dcloud.io/api/ui/font?id=loadfontface)\n"},"pageScrollTo":{"name":"## uni.pageScrollTo(options) @pagescrollto","description":"\n将页面滚动到目标位置\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [PageScrollToOptions](#pagescrolltooptions) | 是 | - |\n#### PageScrollToOptions @pagescrolltooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| scrollTop | number | 是 | 滚动到页面的目标位置 |\n| selector | string | 是 | 选择器 |\n| offsetTop | number | 是 | 偏移距离，可以滚动到 selector 加偏移距离的位置 |\n| duration | number | 是 | 滚动动画的时长 |\n| success | (AsyncApiSuccessResult) => void | 是 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 是 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 是 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[pageScrollTo](http://uniapp.dcloud.io/api/ui/scroll?id=pagescrollto)\n"},"stopPullDownRefresh":{"name":"## uni.stopPullDownRefresh() @stoppulldownrefresh","description":"\n停止当前页面下拉刷新\n","param":"","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[stopPullDownRefresh](http://uniapp.dcloud.io/api/ui/pulldown?id=stoppulldownrefresh)\n"},"setNavigationBarColor":{"name":"## uni.setNavigationBarColor(options) @setnavigationbarcolor","description":"\n设置导航条颜色\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SetNavigationBarColorOptions](#setnavigationbarcoloroptions) | 是 | - |\n#### SetNavigationBarColorOptions @setnavigationbarcoloroptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| frontColor | string | 是 | 前景颜色值，包括按钮、标题、状态栏的颜色 |\n| backgroundColor | string | 是 | 背景颜色值，有效值为十六进制颜色 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[setNavigationBarColor](http://uniapp.dcloud.io/api/ui/navigationbar?id=setnavigationbarcolor)\n"},"setTabBarBadge":{"name":"## uni.setTabBarBadge(options) @settabbarbadge","description":"\n为 tabBar 某一项的右上角添加文本\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SetTabBarBadgeOptions](#settabbarbadgeoptions) | 是 | - |\n#### SetTabBarBadgeOptions @settabbarbadgeoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar的哪一项，从左边算起，索引从0开始 |\n| text | string | 是 | 显示的文本，不超过 3 个半角字符 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[setTabBarBadge](http://uniapp.dcloud.io/api/ui/tabbar?id=settabbarbadge)\n"},"removeTabBarBadge":{"name":"## uni.removeTabBarBadge(options) @removetabbarbadge","description":"\n移除 tabBar 某一项右上角的文本\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [RemoveTabBarBadgeOptions](#removetabbarbadgeoptions) | 是 | - |\n#### RemoveTabBarBadgeOptions @removetabbarbadgeoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar的哪一项，从左边算起，索引从0开始 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[removeTabBarBadge](http://uniapp.dcloud.io/api/ui/tabbar?id=removetabbarbadge)\n"},"setTabBarItem":{"name":"## uni.setTabBarItem(options) @settabbaritem","description":"\n动态设置 tabBar 某一项的内容\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SetTabBarItemOptions](#settabbaritemoptions) | 是 | - |\n#### SetTabBarItemOptions @settabbaritemoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar 的哪一项，从左边算起，索引从0开始 |\n| text | string | 否 | tab 上按钮文字 |\n| iconPath | string | 否 | 图片路径 |\n| selectedIconPath | string | 否 | 选中时的图片路径 |\n| pagePath | string | 否 | 页面绝对路径 |\n| iconfont | SetTabBarItemIconFontOptions | 否 | 字体图标，优先级高于 iconPath |\n| visible | boolean | 否 | tab 是否显示 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### SetTabBarItemIconFontOptions @settabbaritemiconfontoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 是 | 字库 Unicode 码 |\n| selectedText | string | 是 | 选中后字库 Unicode 码 |\n| fontSize | string | 否 | 字体图标字号(px) |\n| color | string | 否 | 字体图标颜色 |\n| selectedColor | string | 否 | 字体图标选中颜色 |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[setTabBarItem](http://uniapp.dcloud.io/api/ui/tabbar?id=settabbaritem)\n"},"setTabBarStyle":{"name":"## uni.setTabBarStyle(options) @settabbarstyle","description":"\n动态设置 tabBar 的整体样式\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SetTabBarStyleOptions](#settabbarstyleoptions) | 是 | - |\n#### SetTabBarStyleOptions @settabbarstyleoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| color | string | 否 | tab 上的文字默认颜色 |\n| selectedColor | string | 否 | tab 上的文字选中时的颜色 {HBuilderX.ColorString} |\n| backgroundColor | string | 否 | tab 的背景色 |\n| backgroundImage | string | 否 | 图片背景 |\n| backgroundRepeat | string | 否 | 背景图平铺方式 |\n| borderStyle | string | 否 | tabbar上边框的颜色 |\n| midButton | MidButtonOptions | 否 | tabbar 中间按钮 仅在 list 项为偶数时有效 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### MidButtonOptions @midbuttonoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| width | string | 否 | 中间按钮的宽度，tabBar 其它项为减去此宽度后平分，默认值为与其它项平分宽度。默认 80px |\n| height | string | 否 | 中间按钮的高度，可以大于 tabBar 高度，达到中间凸起的效果。默认 50px |\n| text | string | 否 | 中间按钮的文字 |\n| iconPath | string | 否 | 中间按钮的图片路径 |\n| iconWidth | string | 否 | 图片宽度（高度等比例缩放）。默认 24px |\n| backgroundImage | string | 否 | 中间按钮的背景图片路径 |\n| iconfont | MidButtonIconFont | 否 | 字体图标，优先级高于 iconPath |\n\n###### MidButtonIconFont @midbuttoniconfont \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 否 | 字库 Unicode 码 |\n| selectedText | string | 否 | 选中后字库 Unicode 码 |\n| fontSize | string | 否 | 字体图标字号(px) |\n| color | string | 否 | 字体图标颜色 |\n| selectedColor | string | 否 | 字体图标选中颜色 |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[setTabBarStyle](http://uniapp.dcloud.io/api/ui/tabbar?id=settabbarstyle)\n"},"hideTabBar":{"name":"## uni.hideTabBar(options?) @hidetabbar","description":"\n隐藏 tabBar\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [HideTabBarOptions](#hidetabbaroptions) | 否 | - |\n#### HideTabBarOptions @hidetabbaroptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| animation | boolean | 否 | 是否需要动画效果 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[hideTabBar](http://uniapp.dcloud.io/api/ui/tabbar?id=hidetabbar)\n"},"showTabBar":{"name":"## uni.showTabBar(options?) @showtabbar","description":"\n显示 tabBar\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowTabBarOptions](#showtabbaroptions) | 否 | - |\n#### ShowTabBarOptions @showtabbaroptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| animation | boolean | 否 | 是否需要动画效果 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[showTabBar](http://uniapp.dcloud.io/api/ui/tabbar?id=showtabbar)\n"},"showTabBarRedDot":{"name":"## uni.showTabBarRedDot(options) @showtabbarreddot","description":"\n显示 tabBar 某一项的右上角的红点\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowTabBarRedDotOptions](#showtabbarreddotoptions) | 是 | - |\n#### ShowTabBarRedDotOptions @showtabbarreddotoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar的哪一项，从左边算起，索引从0开始 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[showTabBarRedDot](http://uniapp.dcloud.io/api/ui/tabbar?id=showtabbarreddot)\n"},"hideTabBarRedDot":{"name":"## uni.hideTabBarRedDot(options) @hidetabbarreddot","description":"\n隐藏 tabBar 某一项的右上角的红点\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [HideTabBarRedDotOptions](#hidetabbarreddotoptions) | 是 | - |\n#### HideTabBarRedDotOptions @hidetabbarreddotoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar的哪一项，从左边算起，索引从0开始 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[hideTabBarRedDot](http://uniapp.dcloud.io/api/ui/tabbar?id=hidetabbarreddot)\n"},"exit":{"name":"## uni.exit(options?) @exit","description":"\n退出当前应用","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ExitOptions](#exitoptions) | 否 | - |\n#### ExitOptions @exitoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (ExitSuccess) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ExitSuccess @exitsuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 3.8.15 | 3.9.0 | x | x | x |\n","tutorial":""},"getAppAuthorizeSetting":{"name":"## uni.getAppAuthorizeSetting() @getappauthorizesetting","description":"获取 APP 授权设置。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetAppAuthorizeSettingResult](#getappauthorizesettingresult) | \n\n#### GetAppAuthorizeSettingResult @getappauthorizesettingresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| albumAuthorized | string | 是 | 允许 App 使用相册的开关（仅 iOS 支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） |\n| bluetoothAuthorized | string | 是 | 允许 App 使用蓝牙的开关（仅 iOS 支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: Android平台没有该值；iOS平台：表示没有在 `manifest.json -\\> App模块配置` 中配置 `BlueTooth(低功耗蓝牙)` 模块 |\n| cameraAuthorized | string | 是 | 允许 App 使用摄像头的开关 - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: Android平台：表示没有授予 `android.permission.CAMERA` 权限；iOS平台没有该值 |\n| locationAuthorized | string | 是 | 允许 App 使用定位的开关 - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: Android平台：表示没有授予 `android.permission.ACCESS_COARSE_LOCATION` 权限；iOS平台：表示没有在 `manifest.json -\\> App模块配置` 中配置 `Geolocation(定位)` 模块 |\n| locationAccuracy | string | 是 | 定位准确度。true 表示模糊定位，false 表示精确定位（仅 iOS 支持） - reduced: 模糊定位 - full: 精准定位 - unsupported: 不支持（包括用户拒绝定位权限和没有在 `manifest.json -\\> App模块配置` 中配置 `Geolocation(定位)` 模块） |\n| locationReducedAccuracy | boolean | 是 | 定位准确度（推荐使用 locationAccuracy 属性）。true 表示模糊定位，false 表示精确定位（仅 iOS 支持） |\n| microphoneAuthorized | string | 是 | 允许 App 使用麦克风的开关 - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: Android平台：表示没有授予 `android.permission.RECORD_AUDIO` 权限；iOS平台没有该值 |\n| notificationAuthorized | string | 是 | 允许 App 通知的开关 - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: Android平台没有该值；iOS平台：表示没有在 `manifest.json -\\> App模块配置` 中配置 `Push(推送)` 模块 |\n| notificationAlertAuthorized | string | 是 | 允许 App 通知带有提醒的开关（仅 iOS 10.0+ 支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: 没有在 `manifest.json -\\> App模块配置` 中配置 `Push(推送)` 模块 |\n| notificationBadgeAuthorized | string | 是 | 允许 App 通知带有标记的开关（仅 iOS 10.0+ 支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: 没有在 `manifest.json -\\> App模块配置` 中配置 `Push(推送)` 模块 |\n| notificationSoundAuthorized | string | 是 | 允许 App 通知带有声音的开关（仅 iOS 10.0+ 支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: 没有在 `manifest.json -\\> App模块配置` 中配置 `Push(推送)` 模块 |\n| phoneCalendarAuthorized | string | 是 | 允许读写日历的开关（仅微信小程序支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） |\n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getAppAuthorizeSetting](http://uniapp.dcloud.io/api/system/getappauthorizesetting)\n"},"getAppBaseInfo":{"name":"## uni.getAppBaseInfo(config?) @getappbaseinfo","description":"获取app基本信息","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| config | [GetAppBaseInfoOptions](#getappbaseinfooptions) | 否 | - |\n#### GetAppBaseInfoOptions @getappbaseinfooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| filter | Array\\ | 是 | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetAppBaseInfoResult](#getappbaseinforesult) | \n\n#### GetAppBaseInfoResult @getappbaseinforesult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| appId | string | 否 | manifest.json 中应用appid，即DCloud appid。\t |\n| appName | string | 否 | manifest.json 中应用名称\t |\n| appVersion | string | 否 | manifest.json 中应用版本名称。\t |\n| appVersionCode | string | 否 | manifest.json 中应用版本名号。\t |\n| appLanguage | string | 否 | 应用设置的语言en、zh-Hans、zh-Hant、fr、es\t |\n| language | string | 否 | 应用设置的语言\t |\n| version | string | 否 | 引擎版本号 |\n| appWgtVersion | string | 否 | 应用资源（wgt）的版本名称。\t |\n| hostLanguage | string | 否 | 小程序宿主语言\t |\n| hostVersion | string | 否 | App、小程序宿主版本。 |\n| hostName | string | 否 | 小程序宿主名称\t |\n| hostPackageName | string | 否 | 小程序宿主包名\t |\n| hostSDKVersion | string | 否 | uni小程序SDK版本、小程序客户端基础库版本\t |\n| hostTheme | string | 否 | 系统当前主题，取值为light或dark。微信小程序全局配置\"darkmode\":true时才能获取，否则为 null （不支持小游戏） |\n| isUniAppX | boolean | 是 | 是否uni-app x |\n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getAppBaseInfo](https://uniapp.dcloud.net.cn/api/system/getAppBaseInfo.html)\n"},"getDeviceInfo":{"name":"## uni.getDeviceInfo(config?) @getdeviceinfo","description":"获取设备信息","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| config | [GetDeviceInfoOptions](#getdeviceinfooptions) | 否 | - |\n#### GetDeviceInfoOptions @getdeviceinfooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| filter | Array\\ | 是 | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetDeviceInfoResult](#getdeviceinforesult) | \n\n#### GetDeviceInfoResult @getdeviceinforesult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| brand | string | 否 | 设备品牌 |\n| deviceBrand | string | 否 | 设备品牌 |\n| deviceId | string | 否 | 设备 id 。由 uni-app 框架生成并存储，清空 Storage 会导致改变 |\n| model | string | 否 | 设备型号\t |\n| deviceModel | string | 否 | 设备型号\t |\n| deviceType | string | 否 | 设备类型phone、pad、pc\t |\n| deviceOrientation | string | 否 | 设备方向 竖屏 portrait、横屏 landscape\t |\n| devicePixelRatio | string | 否 | 设备像素比\t |\n| system | string | 否 | 操作系统及版本\t |\n| platform | string | 否 | 客户端平台\t |\n| oaid | string | 否 | oaid标识 Android专有 |\n| isRoot | boolean | 否 | 是否root |\n| isSimulator | boolean | 否 | 是否是模拟器 |\n| isUSBDebugging | boolean | 否 | adb是否开启 |\n| idfa | string | 否 | idfa标识 iOS专有 |\n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getDeviceInfo](https://uniapp.dcloud.net.cn/api/system/getDeviceInfo.html)\n"},"getLocation":{"name":"## uni.getLocation(options) @getlocation","description":"获取当前的地理位置、速度","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetLocationOptions](#getlocationoptions) | 是 | - |\n#### GetLocationOptions @getlocationoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 否 | 默认为 wgs84 返回 gps 坐标，gcj02 返回可用于uni.openLocation的坐标 |\n| altitude | boolean | 否 | 传入 true 会返回高度信息，由于获取高度需要较高精确度，会减慢接口返回速度 |\n| geocode | boolean | 否 | 传入 true 会解析地址 |\n| highAccuracyExpireTime | number | 否 | 高精度定位超时时间(ms)，指定时间内返回最高精度，该值3000ms以上高精度定位才有效果 |\n| isHighAccuracy | boolean | 否 | 开启高精度定位 |\n| success | (GetLocationSuccess) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetLocationSuccess @getlocationsuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| latitude | number | 是 | 纬度，浮点数，范围为-90~90，负数表示南纬 |\n| longitude | number | 是 | 经度，范围为-180~180，负数表示西经 |\n| speed | number | 是 | 速度，浮点数，单位m/s |\n| accuracy | number | 是 | 位置的精确度 |\n| altitude | number | 是 | 高度，单位 m |\n| verticalAccuracy | number | 是 | 垂直精度，单位 m（Android 无法获取，返回 0） |\n| horizontalAccuracy | number | 是 | 水平精度，单位 m |\n| address | any | 是 | 地址信息 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | √ | 3.9.0 | x | x | x |\n","tutorial":"\n### 参见\n[getLocation]([](http://uniapp.dcloud.io/api/location/location?id=getlocation))\n"},"getNetworkType":{"name":"## uni.getNetworkType(options) @getnetworktype","description":"获取网络类型","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetNetworkTypeOptions](#getnetworktypeoptions) | 是 | - |\n#### GetNetworkTypeOptions @getnetworktypeoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (GetNetworkTypeSuccess) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetNetworkTypeSuccess @getnetworktypesuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| networkType | string | 是 | 网络类型 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getNetworkType](http://uniapp.dcloud.io/api/system/network?id=getnetworktype)\n"},"getSystemInfo":{"name":"## uni.getSystemInfo(options) @getsysteminfo","description":"异步获取系统信息","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetSystemInfoOptions](#getsysteminfooptions) | 是 | - |\n#### GetSystemInfoOptions @getsysteminfooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (GetSystemInfoResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetSystemInfoResult @getsysteminforesult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| SDKVersion | string | 是 | 客户端基础库版本 |\n| appId | string | 是 | 当前运行的客户端 |\n| appLanguage | string | 是 | 应用设置的语言。仅 App、H5 支持 |\n| appName | string | 是 | `manifest.json` 中应用名称。和`字节跳动小程序、飞书小程序`字段冲突，原字端与`hostName`一致 |\n| appVersion | string | 是 | `manifest.json` 中应用版本名称。 |\n| appVersionCode | number | 是 | `manifest.json` 中应用版本名号 |\n| appWgtVersion | string | 是 | 应用资源（wgt）的版本名称。（仅 App 支持） |\n| brand | string | 是 | 手机品牌。H5 不支持 |\n| browserName | string | 是 | 浏览器名称。`App` 端是系统 webview 的名字，比如 wkwebview、chrome。小程序端为空 |\n| browserVersion | string | 是 | 浏览器版本、webview 版本。小程序端为空 |\n| deviceId | string | 是 | 设备 ID |\n| deviceBrand | string | 是 | 设备品牌。如：`apple`、`huawei`。H5 不支持 |\n| deviceModel | string | 是 | 设备型号 |\n| deviceType | string | 是 | 设备类型。`phone`、`pad`、`pc` |\n| devicePixelRatio | number | 是 | 设备像素比 |\n| deviceOrientation | string | 是 | 设备方向。如：`竖屏 portrait`、`横屏 landscape` - portrait: 竖屏 - landscape: 横屏 |\n| language | string | 是 | 用户字体大小设置 |\n| model | string | 是 | 手机型号 |\n| osName | string | 是 | ios、android、windows、mac、linux |\n| osVersion | string | 是 | 操作系统版本。如 ios 版本，andriod 版本 |\n| osLanguage | string | 是 | 操作系统语言，小程序端与 `version` 相同，H5 与浏览器语言一致 |\n| osTheme | string | 是 | \\|操作系统主题 light、dark。小程序端为小程序主题，H5 端为空 |\n| pixelRatio | number | 是 | 设备像素比 |\n| platform | string | 是 | 客户端平台 |\n| screenWidth | number | 是 | 屏幕宽度 |\n| screenHeight | number | 是 | 屏幕高度 |\n| statusBarHeight | number | 是 | 状态栏的高度 |\n| system | string | 是 | 设备磁盘容量 |\n| safeArea | SafeArea | 是 | 在竖屏正方向下的安全区域 |\n| safeAreaInsets | SafeAreaInsets | 是 | 在竖屏正方向下的安全区域插入位置 |\n| ua | string | 是 | 用户标识。小程序端为空 |\n| uniCompileVersion | string | 是 | uni 编译器版本号 |\n| uniPlatform | string | 是 | uni-app 运行平台。如：`app`、`mp-weixin`、`web` |\n| uniRuntimeVersion | string | 是 | uni 运行时版本 |\n| version | string | 是 | 引擎版本号 |\n| romName | string | 是 | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios` |\n| romVersion | string | 是 | rom 版本号。Android 部分机型获取不到值。iOS 恒为 `ios 版本号` |\n| windowWidth | number | 是 | 可使用窗口宽度 |\n| windowHeight | number | 是 | 可使用窗口高度 |\n| windowTop | number | 是 | 导航栏的高度 |\n| windowBottom | number | 是 | 可使用窗口的底部位置 |\n| oaid | string | 是 | 允许微信使用相册的开关（仅 iOS 有效） |\n| osAndroidAPILevel | number | 是 | Android 系统API库的版本。 |\n\n###### SafeArea @safearea \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| left | number | 是 | 安全区域左上角横坐标 |\n| right | number | 是 | 安全区域右下角横坐标 |\n| top | number | 是 | 安全区域左上角纵坐标 |\n| bottom | number | 是 | 安全区域右下角纵坐标 |\n| width | number | 是 | 安全区域的宽度，单位逻辑像素 |\n| height | number | 是 | 安全区域的高度，单位逻辑像素 |\n\n###### SafeAreaInsets @safeareainsets \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| left | number | 是 | 安全区域左侧插入位置 |\n| right | number | 是 | 安全区域右侧插入位置 |\n| top | number | 是 | 安全区顶部插入位置 |\n| bottom | number | 是 | 安全区域底部插入位置 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getSystemInfo](http://uniapp.dcloud.io/api/system/info?id=getsysteminfo)\n"},"getWindowInfo":{"name":"## uni.getWindowInfo() @getwindowinfo","description":"同步获取窗口信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetWindowInfoResult](#getwindowinforesult) | \n\n#### GetWindowInfoResult @getwindowinforesult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| pixelRatio | number | 是 | 设备像素比 |\n| screenWidth | number | 是 | 屏幕宽度 |\n| screenHeight | number | 是 | 屏幕高度 |\n| windowWidth | number | 是 | 可使用窗口宽度 |\n| windowHeight | number | 是 | 可使用窗口高度 |\n| statusBarHeight | number | 是 | 状态栏的高度 |\n| windowTop | number | 是 | 可使用窗口的顶部位置 |\n| windowBottom | number | 是 | 可使用窗口的底部位置 |\n| safeArea | SafeArea | 是 | 在竖屏正方向下的安全区域 |\n| safeAreaInsets | SafeAreaInsets | 是 | 在竖屏正方向下的安全区域插入位置 |\n| screenTop | number | 是 | 窗口上边缘的 y 值 |\n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getWindowInfo](http://uniapp.dcloud.io/api/system/getWindowInfo.html)\n"},"getSystemSetting":{"name":"## uni.getSystemSetting() @getsystemsetting","description":"获取系统设置","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetSystemSettingResult](#getsystemsettingresult) | \n\n#### GetSystemSettingResult @getsystemsettingresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| bluetoothEnabled | boolean | 否 | 蓝牙是否开启 |\n| bluetoothError | string | 否 | 蓝牙的报错信息 |\n| locationEnabled | boolean | 否 | 位置是否开启 |\n| wifiEnabled | boolean | 否 | wifi是否开启 |\n| wifiError | string | 否 | wifi的报错信息 |\n| deviceOrientation | string | 否 | 设备方向 |\n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getSystemSetting](https://uniapp.dcloud.net.cn/api/system/getsystemsetting.html)\n"},"chooseImage":{"name":"## uni.chooseImage(options) @chooseimage","description":"从本地相册选择图片或使用相机拍照","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ChooseImageOptions](#chooseimageoptions) | 是 | - |\n#### ChooseImageOptions @chooseimageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| count | number | 否 | 最多可以选择的图片张数，默认9 |\n| sizeType | Array\\ | 否 | original 原图，compressed 压缩图，默认二者都有 |\n| sourceType | Array\\ | 否 | album 从相册选图，camera 使用相机，默认二者都有 |\n| extension | Array\\ | 否 | 根据文件拓展名过滤，每一项都不能是空字符串。默认不过滤。 |\n| crop | ChooseImageCropOptions | 否 | 图像裁剪参数，设置后 sizeType 失效。 |\n| success | (ChooseImageSuccessCallback) => void | 否 | 成功则返回图片的本地文件路径列表 tempFilePaths |\n| fail | (ChooseImageFailCallback) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ChooseImageCropOptions @chooseimagecropoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| width | number | 是 | 裁剪的宽度，单位为px，用于计算裁剪宽高比。 |\n| height | number | 是 | 裁剪的高度，单位为px，用于计算裁剪宽高比。 |\n| quality | number | 是 | 取值范围为1-100，数值越小，质量越低（仅对jpg格式有效）。默认值为80。 |\n| resize | boolean | 是 | 是否将width和height作为裁剪保存图片真实的像素值。默认值为true。注：设置为false时在裁剪编辑界面显示图片的像素值，设置为true时不显示。 |\n| saveToAlbum | boolean | 是 | 是否将裁剪的图片保存到手机相册里，默认值为false。 |\n\n##### ChooseImageSuccessCallback @chooseimagesuccesscallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errSubject | string | 是 | 调用API的名称 |\n| errMsg | string | 是 | - |\n| tempFilePaths | Array\\ | 是 | - |\n| tempFiles | any | 是 | - |\n\n##### ChooseImageFailCallback @chooseimagefailcallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errCode | number | 是 | 错误码 |\n| errSubject | string | 是 | 调用API的名称 |\n| errMsg | string | 是 | 错误的详细信息 |\n| cause | any | 是 | 错误来源 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | - | - | - |\n","tutorial":"\n### 参见\n[chooseImage](http://uniapp.dcloud.io/api/media/image?id=chooseimage)\n"},"previewImage":{"name":"## uni.previewImage(options) @previewimage","description":"预览图片","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [PreviewImageOptions](#previewimageoptions) | 是 | - |\n#### PreviewImageOptions @previewimageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| count | string | 否 | 当前显示图片的链接，不填则默认为 urls 的第一张 |\n| current | any | 否 | current 为当前显示图片的链接/索引值，不填或填写的值无效则为 urls 的第一张。App平台在 1.9.5至1.9.8之间，current为必填。不填会报错 |\n| urls | Array\\ | 是 | 需要预览的图片链接列表 |\n| indicator | string | 否 | 图片指示器样式 - default: 底部圆点指示器 - number: 顶部数字指示器 - none: 不显示指示器 |\n| loop | boolean | 否 | 是否可循环预览 |\n| longPressActions | LongPressActionsOptions | 否 | 长按图片显示操作菜单，如不填默认为保存相册，1.9.5 起支持。 |\n| success | (PreviewImageSuccessCallback) => void | 否 | 接口调用成功的回调函数 |\n| fail | (PreviewImageFailCallback) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### LongPressActionsOptions @longpressactionsoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| itemList | Array\\ | 是 | 按钮的文字数组 |\n| itemColor | string | 是 | 按钮的文字颜色，字符串格式，默认为\"#000000\" |\n| success | (LongPressActionsSuccessData) => void | 是 | 接口调用成功的回调函数 |\n| fail | (any) => void | 是 | 接口调用失败的回调函数 |\n| complete | (any) => void | 是 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n###### LongPressActionsSuccessData @longpressactionssuccessdata \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| tapIndex | number | 是 | 接口调用失败的回调函数 |\n| index | number | 是 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### PreviewImageSuccessCallback @previewimagesuccesscallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errSubject | string | 是 | - |\n| errMsg | string | 是 | - |\n\n##### PreviewImageFailCallback @previewimagefailcallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errCode | number | 是 | 错误码 |\n| errSubject | string | 是 | 调用API的名称 |\n| errMsg | string | 是 | 错误的详细信息 |\n| cause | any | 是 | 错误来源 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | - | - | - |\n","tutorial":"\n### 参见\n[previewImage](http://uniapp.dcloud.io/api/media/image?id=previewimage)\n"},"closePreviewImage":{"name":"## uni.closePreviewImage(options) @closepreviewimage","description":"关闭图片预览","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ClosePreviewImageOptions](#closepreviewimageoptions) | 是 | - |\n#### ClosePreviewImageOptions @closepreviewimageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (ClosePreviewImageSuccessCallback) => void | 否 | 接口调用成功的回调函数 |\n| fail | (ClosePreviewImageFailCallback) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ClosePreviewImageSuccessCallback @closepreviewimagesuccesscallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | 错误信息 |\n\n##### ClosePreviewImageFailCallback @closepreviewimagefailcallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errCode | number | 是 | 错误码 |\n| errSubject | string | 是 | 调用API的名称 |\n| errMsg | string | 是 | 错误的详细信息 |\n| cause | any | 是 | 错误来源 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | - | - | - |\n","tutorial":"\n### 参见\n[closePreviewImage](http://uniapp.dcloud.io/api/media/image?id=closepreviewimage)\n"},"request":{"name":"## uni.request(param) @request","description":"发起网络请求。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| param | [RequestOptions\\](#requestoptions) | 是 | 网络请求参数 |\n#### RequestOptions\\ @requestoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 开发者服务器接口地址 |\n| data | any | 否 | 请求的参数 Object\\|String类型 |\n| header | UTSJSONObject | 否 | - |\n| method | string | 否 | 请求类型 默认值GET\t GET\\|POST\\|PUT\\|DELETE\\|HEAD\\|OPTIONS |\n| timeout | number | 否 | 超时时间，单位 ms |\n| dataType | string | 否 | 如果设为 json，会对返回的数据进行一次 JSON.parse，非 json 不会进行 JSON.parse |\n| responseType | string | 否 | 设置响应的数据类型。 |\n| sslVerify | boolean | 否 | 验证 ssl 证书 |\n| withCredentials | boolean | 否 | 跨域请求时是否携带凭证（cookies） |\n| firstIpv4 | boolean | 否 | DNS解析时优先使用ipv4 |\n| success | (RequestSuccess) => void | 否 | 网络请求成功回调。 |\n| fail | (UniError) => void | 否 | 网络请求失败回调。 |\n| complete | (any) => void | 否 | 网络请求完成回调，成功或者失败都会调用。 |\n\n##### RequestSuccess\\ @requestsuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | any | 是 | 开发者服务器返回的数据 |\n| statusCode | number | 是 | 开发者服务器返回的 HTTP 状态码 |\n| header | any | 是 | 开发者服务器返回的 HTTP Response Header |\n| cookies | Array\\ | 是 | 开发者服务器返回的 cookies，格式为字符串数组 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| RequestTask | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[request](https://uniapp.dcloud.net.cn/api/request/request.html)\n"},"uploadFile":{"name":"## uni.uploadFile(options) @uploadfile","description":"将本地资源上传到开发者服务器。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [UploadFileOptions](#uploadfileoptions) | 是 | - |\n#### UploadFileOptions @uploadfileoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 开发者服务器 url |\n| filePath | string | 否 | 要上传文件资源的路径 |\n| name | string | 否 | 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容 |\n| files | Array\\ | 否 | 需要上传的文件列表。 |\n| header | UTSJSONObject | 否 | HTTP 请求 Header, header 中不能设置 Referer |\n| formData | UTSJSONObject | 否 | HTTP 请求中其他额外的 form data |\n| timeout | number | 否 | 超时时间，单位 ms |\n| success | (UploadFileSuccess) => void | 否 | 成功返回的回调函数 |\n| fail | (UniError) => void | 否 | 失败的回调函数 |\n| complete | (any) => void | 否 | 结束的回调函数（调用成功、失败都会执行） |\n\n##### UploadFileOptionFiles @uploadfileoptionfiles \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| name | string | 是 | multipart 提交时，表单的项目名，默认为 file，如果 name 不填或填的值相同，可能导致服务端读取文件时只能读取到一个文件。 |\n| uri | string | 是 | 要上传文件资源的路径 |\n| file | any | 是 | 要上传的文件对象，仅H5（2.6.15+）支持 |\n\n##### UploadFileSuccess @uploadfilesuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | string | 是 | 开发者服务器返回的数据 |\n| statusCode | number | 是 | 开发者服务器返回的 HTTP 状态码 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| UploadTask | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[uploadFile](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n"},"downloadFile":{"name":"## uni.downloadFile(options) @downloadfile","description":"下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [DownloadFileOptions](#downloadfileoptions) | 是 | - |\n#### DownloadFileOptions @downloadfileoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 下载资源的 url |\n| header | UTSJSONObject | 否 | HTTP 请求 Header，header 中不能设置 Referer |\n| timeout | number | 否 | 超时时间，单位 ms |\n| success | (DownloadFileSuccess) => void | 否 | 下载成功后以 tempFilePath 的形式传给页面，res = {tempFilePath: '文件的临时路径'} |\n| fail | (UniError) => void | 否 | 失败的回调函数 |\n| complete | (any) => void | 否 | 结束的回调函数（调用成功、失败都会执行） |\n\n##### DownloadFileSuccess @downloadfilesuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| tempFilePath | string | 是 | 临时文件路径，下载后的文件会存储到一个临时文件 |\n| statusCode | number | 是 | 开发者服务器返回的 HTTP 状态码 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| DownloadTask | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[downloadFile](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n"},"showToast":{"name":"## uni.showToast(options) @showtoast","description":"\r\nuni.showToast函数定义\r\n弹出toast \r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowToastOptions](#showtoastoptions) | 是 | uni.showToast参数定义 |\n#### ShowToastOptions @showtoastoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| title | string | 是 | 提示的内容，长度与 icon 取值有关。 |\n| icon | string | 否 | icon值说明 success: 显示成功图标，error: 显示错误图标； fail: 显示错误图标，此时title文本无长度显示； exception: 显示异常图标，此时title文本无长度显示； loading: 显示加载图标；none: 不显示图标。 |\n| image | string | 否 | 自定义图标的本地路径（app端暂不支持gif） |\n| mask | boolean | 否 | 是否显示透明蒙层，防止触摸穿透，默认：false |\n| duration | number | 否 | 提示的延迟时间，单位毫秒，默认：1500 |\n| position | string | 否 | position值说明（仅App生效） top: 居上显示； center: 居中显示；bottom： 居底显示 |\n| success | (ShowToastSuccess) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[showToast](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showtoast)\n"},"showLoading":{"name":"## uni.showLoading(options) @showloading","description":"\r\nuni.showLoading函数定义\r\n弹出loading\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowLoadingOptions](#showloadingoptions) | 是 | uni.showLoading参数定义 |\n#### ShowLoadingOptions @showloadingoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| title | string | 是 | 提示的内容，长度与 icon 取值有关。 |\n| mask | boolean | 否 | 是否显示透明蒙层，防止触摸穿透，默认：false |\n| success | (ShowLoadingSuccess) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[showLoading](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showloading)\n"},"showModal":{"name":"## uni.showModal(options) @showmodal","description":"\r\nuni.showModal 函数定义\r\n\r\n弹出modal\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowModalOptions](#showmodaloptions) | 是 | uni.showModal 参数定义 |\n#### ShowModalOptions @showmodaloptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| title | string | 否 | 提示的标题 |\n| content | string | 否 | 提示的内容 |\n| showCancel | boolean | 否 | |\n| cancelText | string | 否 | 取消按钮的文字，默认为\"取消\" |\n| cancelColor | string | 否 | 取消按钮的文字颜色，默认为\"#000000\" |\n| confirmText | string | 否 | 确定按钮的文字，默认为\"确定\" |\n| confirmColor | string | 否 | 确定按钮的文字颜色 |\n| editable | boolean | 否 | |\n| placeholderText | string | 否 | 显示输入框时的提示文本 |\n| success | (ShowModalSuccess) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ShowModalSuccess @showmodalsuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| confirm | boolean | 是 | 为 true 时，表示用户点击了确定按钮 |\n| cancel | boolean | 是 | 为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭） |\n| content | string | 是 | editable 为 true 时，用户输入的文本 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[showModal](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showmodal)\n"},"setStorage":{"name":"## uni.setStorage(options) @setstorage","description":"\nuni.setStorage函数定义\n将数据存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个异步接口。 \n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SetStorageOptions](#setstorageoptions) | 是 | uni.setStorage参数定义 |\n#### SetStorageOptions @setstorageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |\n| data | any | 是 | 需要存储的内容，只支持原生类型、及能够通过 JSON.stringify 序列化的对象 |\n| success | (SetStorageSuccess) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[setStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstorage)\n"},"setStorageSync":{"name":"## uni.setStorageSync(key, data) @setstoragesync","description":"\nuni.setStorageSync函数定义\n将 data 存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个同步接口。\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |\n| data | any | 是 | 需要存储的内容，只支持原生类型、及能够通过 JSON.stringify 序列化的对象 |","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[setStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstoragesync)\n"},"getStorage":{"name":"## uni.getStorage(options) @getstorage","description":"\nuni.getStorage函数定义\n从本地缓存中异步获取指定 key 对应的内容。\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetStorageOptions](#getstorageoptions) | 是 | uni.getStorage参数定义 |\n#### GetStorageOptions @getstorageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |\n| success | (GetStorageSuccess) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetStorageSuccess @getstoragesuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | any | 是 | key 对应的内容 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[getStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorage)\n"},"getStorageSync":{"name":"## uni.getStorageSync(key) @getstoragesync","description":"\nuni.getStorageSync函数定义\n从本地缓存中同步获取指定 key 对应的内容。\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[getStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstoragesync)\n"},"getStorageInfo":{"name":"## uni.getStorageInfo(options) @getstorageinfo","description":"\nuni.getStorageInfo函数定义\n异步获取当前 storage 的相关信息。\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetStorageInfoOptions](#getstorageinfooptions) | 是 | uni.getStorageInfo参数定义 |\n#### GetStorageInfoOptions @getstorageinfooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (GetStorageInfoSuccess) => void | 是 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 是 | 接口调用失败的回调函数 |\n| complete | (any) => void | 是 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetStorageInfoSuccess @getstorageinfosuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| keys | Array\\ | 是 | 当前 storage 中所有的 key |\n| currentSize | number | 是 | 当前占用的空间大小, 单位：kb |\n| limitSize | number | 是 | 限制的空间大小, 单位：kb |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[getStorageInfo](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfo)\n"},"getStorageInfoSync":{"name":"## uni.getStorageInfoSync() @getstorageinfosync","description":"\nuni.getStorageInfoSync函数定义\n同步获取当前 storage 的相关信息。\n\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetStorageInfoSuccess](#getstorageinfosuccess) | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[getStorageInfoSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfosync)\n"},"removeStorage":{"name":"## uni.removeStorage(options) @removestorage","description":"\nuni.removeStorage函数定义\n从本地缓存中异步移除指定 key。\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [RemoveStorageOptions](#removestorageoptions) | 是 | uni.removeStorage参数定义 |\n#### RemoveStorageOptions @removestorageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |\n| success | (RemoveStorageSuccess) => void | 否 | 接口调用的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[removeStorage](hhttps://uniapp.dcloud.net.cn/api/storage/storage.html#removestorage)\n"},"removeStorageSync":{"name":"## uni.removeStorageSync(key) @removestoragesync","description":"\nuni.removeStorageSync函数定义\n从本地缓存中同步移除指定 key。\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[removeStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#removestoragesync)\n"},"clearStorage":{"name":"## uni.clearStorage(option?) @clearstorage","description":"\nuni.clearStorage函数定义\n清理本地数据缓存。\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| option | [ClearStorageOptions](#clearstorageoptions) | 否 | - |\n#### ClearStorageOptions @clearstorageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (ClearStorageSuccess) => void | 否 | 接口调用的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[clearStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstorage)\n"},"clearStorageSync":{"name":"## uni.clearStorageSync() @clearstoragesync","description":"\nuni.clearStorageSync函数定义\n清理本地数据缓存。\n","param":"","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[clearStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstoragesync)\n"},"connectSocket":{"name":"## uni.connectSocket(options) @connectsocket","description":"创建一个 WebSocket 连接。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ConnectSocketOptions](#connectsocketoptions) | 是 | - |\n#### ConnectSocketOptions @connectsocketoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 开发者服务器接口地址，必须是 wss 协议，且域名必须是后台配置的合法域名 |\n| header | UTSJSONObject | 是 | HTTP 请求 Header，header 中不能设置 Referer |\n| protocols | Array\\ | 是 | 子协议数组 |\n| success | (ConnectSocketSuccess) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ConnectSocketSuccess @connectsocketsuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| SocketTask | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[connectSocket](https://uniapp.dcloud.net.cn/api/request/websocket.html#connectsocket)\n"},"onSocketOpen":{"name":"## uni.onSocketOpen(options) @onsocketopen","description":"监听WebSocket连接打开事件。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | (OnSocketOpenCallbackResult) => void | 是 | - |\n#### OnSocketOpenCallbackResult @onsocketopencallbackresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| header | any | 是 | 连接成功的 HTTP 响应 Header |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[onSocketOpen](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketopen)\n"},"onSocketError":{"name":"## uni.onSocketError(callback) @onsocketerror","description":"下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | (OnSocketErrorCallbackResult) => void | 是 | - |\n#### OnSocketErrorCallbackResult @onsocketerrorcallbackresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | 错误信息 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[onSocketError](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketerror)\n"},"sendSocketMessage":{"name":"## uni.sendSocketMessage(options) @sendsocketmessage","description":"通过 WebSocket 连接发送数据，需要先 uni.connectSocket，并在 uni.onSocketOpen 回调之后才能发送。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SendSocketMessageOptions](#sendsocketmessageoptions) | 是 | - |\n#### SendSocketMessageOptions @sendsocketmessageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | any | 是 | 需要发送的内容 |\n| success | (GeneralCallbackResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (GeneralCallbackResult) => void | 否 | 接口调用失败的回调函数 |\n| complete | (GeneralCallbackResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[sendSocketMessage](https://uniapp.dcloud.net.cn/api/request/websocket.html#sendsocketmessage)\n"},"onSocketMessage":{"name":"## uni.onSocketMessage(callback) @onsocketmessage","description":"监听WebSocket接受到服务器的消息事件。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | (OnSocketMessageCallbackResult) => void | 是 | - |\n#### OnSocketMessageCallbackResult @onsocketmessagecallbackresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | any | 是 | 服务器返回的消息 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[onSocketMessage](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketmessage)\n"},"closeSocket":{"name":"## uni.closeSocket(options) @closesocket","description":"关闭 WebSocket 连接。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [CloseSocketOptions](#closesocketoptions) | 是 | - |\n#### CloseSocketOptions @closesocketoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| code | number | 否 | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭） |\n| reason | string | 否 | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符） |\n| success | (GeneralCallbackResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (GeneralCallbackResult) => void | 否 | 接口调用失败的回调函数 |\n| complete | (GeneralCallbackResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[closeSocket](https://uniapp.dcloud.net.cn/api/request/websocket.html#closesocket)\n"},"onSocketClose":{"name":"## uni.onSocketClose(callback) @onsocketclose","description":"监听WebSocket关闭。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | (OnSocketCloseCallbackResult) => void | 是 | - |\n#### OnSocketCloseCallbackResult @onsocketclosecallbackresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| code | number | 是 | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。\t |\n| reason | string | 是 | 一个可读的字符串，表示连接被关闭的原因。\t |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[onSocketClose](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketclose)\n"},"general_type":{"name":"## 通用类型\n","param":"### GeneralCallbackResult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | 错误信息 |\n"}} \ No newline at end of file +{"getApp":{"name":"## getApp(opts?) @getapp","description":"","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| opts | GetAppOption | 否 | - |","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [AppInstance](#appinstance) | \n\n#### AppInstance\\ & T @appinstance \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| globalData | AnyObject | 否 | - |\n| onLaunch | (LaunchShowOption?) => void | 否 | 生命周期回调 监听应用初始化 应用初始化完成时触发，全局只触发一次。 |\n| onShow | (LaunchShowOption?) => void | 否 | 生命周期回调 监听应用显示 应用启动，或从后台进入前台显示时触发 |\n| onHide | () => void | 否 | 生命周期回调 监听应用隐藏 应用从前台进入后台时触发 |\n| onError | (string) => void | 否 | 错误监听函数 小程序发生脚本错误或 API 调用报错时触发 |\n| onPageNotFound | (PageNotFoundOption) => void | 否 | 页面不存在监听函数 应用要打开的页面不存在时触发，会带上页面信息回调该函数 **注意：** 1. 如果开发者没有添加 `onPageNotFound` 监听，当跳转页面不存在时，将推入微信客户端原生的页面不存在提示页面。 2. 如果 `onPageNotFound` 回调中又重定向到另一个不存在的页面，将推入微信客户端原生的页面不存在提示页面，并且不再回调 `onPageNotFound`。 |\n| onUnhandledRejection | (UniNamespace.OnUnhandledRejectionCallbackResult) => void | 否 | 未处理的 Promise 拒绝事件监听函数 |\n| onThemeChange | (UniNamespace.OnThemeChangeCallbackResult) => void | 否 | 监听系统主题变化 |\n| onUniNViewMessage | (AnyObject) => void | 否 | 监听 nvue 页面消息 nvue 页面使用 `uni.postMessage` 发送消息时触发 |\n| onExit | () => void | 否 | 监听应用退出。app-uvue-android 3.9+ |\n| onLastPageBackPress | () => void | 否 | 最后一个页面按下Android back键，常用于自定义退出。app-uvue-android 3.9+ |\n","compatibility":"","tutorial":""},"getCurrentPages":{"name":"## getCurrentPages() @getcurrentpages","description":"","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| Array\\<[PageInstance](#pageinstance)\\> | \n\n#### PageInstance\\ & T @pageinstance \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| onInit | (Map\\?) => void | 否 | 生命周期回调 监听页面初始化 页面初始化时触发。一个页面只会调用一次，可以在 onInit 的参数中获取打开当前页面路径中的参数。 |\n| onLoad | (Map\\?) => void | 否 | 生命周期回调 监听页面加载 页面加载时触发。一个页面只会调用一次，可以在 onLoad 的参数中获取打开当前页面路径中的参数。 |\n| onShow | () => void | 否 | 生命周期回调 监听页面显示 页面显示/切入前台时触发。 |\n| onReady | () => void | 否 | 生命周期回调 监听页面初次渲染完成 页面初次渲染完成时触发。一个页面只会调用一次，代表页面已经准备妥当，可以和视图层进行交互。 |\n| onHide | () => void | 否 | 生命周期回调 监听页面隐藏 页面隐藏/切入后台时触发。 如 `navigateTo` 或底部 `tab` 切换到其他页面，应用切入后台等。 |\n| onUnload | () => void | 否 | 生命周期回调 监听页面卸载 页面卸载时触发。如 `redirectTo` 或 `navigateBack` 到其他页面时。 |\n| onPullDownRefresh | () => void | 否 | 监听用户下拉动作 - 需要在 `pages.json` 的页面配置中开启 `enablePullDownRefresh` 。 - 可以通过 `uni.startPullDownRefresh` 触发下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。 - 当处理完数据刷新后，`uni.stopPullDownRefresh` 可以停止当前页面的下拉刷新。 |\n| onReachBottom | () => void | 否 | 页面上拉触底事件的处理函数 - 可以在 `pages.json` 的页面配置中设置触发距离 `onReachBottomDistance` 。 - 在触发距离内滑动期间，本事件只会被触发一次。 |\n| onShareAppMessage | (ShareAppMessageOption) => CustomShareContent | 否 | 用户点击右上角转发 监听用户点击页面内转发按钮（`\\` 组件 `open-type=\"share\"`）或右上角菜单“转发”按钮的行为，并自定义转发内容。 |\n| onShareTimeline | () => ShareTimelineContent | 否 | 用户点击右上角转发到朋友圈 监听右上角菜单“分享到朋友圈”按钮的行为，并自定义发享内容。 |\n| onAddToFavorites | (AddToFavoritesOption) => CustomFavoritesContent | 否 | 用户点击右上角收藏 监听用户点击右上角菜单“收藏”按钮的行为，并自定义收藏内容。 |\n| onPageScroll | (PageScrollOption) => void | 否 | 页面滚动触发事件的处理函数 监听用户滑动页面事件。 |\n| onResize | (ResizeOption) => void | 否 | 页面尺寸改变时触发 |\n| onTabItemTap | (TabItemTapOption) => void | 否 | 当前是 tab 页时，点击 tab 时触发 |\n| onNavigationBarButtonTap | (NavigationBarButtonTapOption) => void | 否 | 监听原生标题栏按钮点击事件 |\n| onBackPress | (BackPressOption) => any | 否 | 监听页面返回 |\n| onNavigationBarSearchInputChanged | (NavigationBarSearchInputEvent) => void | 否 | 监听原生标题栏搜索输入框输入内容变化事件 |\n| onNavigationBarSearchInputConfirmed | (NavigationBarSearchInputEvent) => void | 否 | 监听原生标题栏搜索输入框搜索事件，用户点击软键盘上的“搜索”按钮时触发。 |\n| onNavigationBarSearchInputClicked | () => void | 否 | 监听原生标题栏搜索输入框点击事件 |\n| route | string | 否 | 到当前页面的路径，类型为 `String` |\n| $getAppWebview | () => PlusWebviewWebviewObject | 否 | 获取当前页面的webview对象实例。仅 App 平台支持 |\n| $vm | any | 否 | 当前页面的 Vue 实例 |\n","compatibility":"","tutorial":""},"$on":{"name":"## uni.$on(eventName, callback) @$on","description":"\r\n监听自定义事件。事件可以由 uni.$emit 触发。回调函数会接收 uni.$emit 传递的参数。\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| eventName | string | 是 | - |\n| callback | Function\\ | 是 | - |","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[$on](http://uniapp.dcloud.io/api/window/communication?id=on)\n"},"$off":{"name":"## uni.$off(eventName, callback) @$off","description":"\r\n移除自定义事件监听器。如果没有指定事件名，则移除所有事件监听器。如果提供事件名，则移除该事件的所有监听器。如果提供了事件名和回调，则只移除这个回调的监听器。\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| eventName | string | 是 | - |\n| callback | Function\\ | 是 | - |","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[$off](http://uniapp.dcloud.io/api/window/communication?id=off)\n"},"$once":{"name":"## uni.$once(eventName, callback) @$once","description":"\r\n监听一个自定义事件。事件只触发一次，在第一次触发之后移除事件监听器。\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| eventName | string | 是 | - |\n| callback | Function\\ | 是 | - |","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[$once](http://uniapp.dcloud.io/api/window/communication?id=once)\n"},"$emit":{"name":"## uni.$emit(eventName, args) @$emit","description":"\r\n触发自定义事件，附加的参数会传递给事件监听器。\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| eventName | string | 是 | - |\n| args | any | 是 | - |","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[$emit](http://uniapp.dcloud.io/api/window/communication?id=emit)\n"},"getLaunchOptionsSync":{"name":"## uni.getLaunchOptionsSync() @getlaunchoptionssync","description":"\r\n获取本次启动时的参数。返回值与App.onLaunch的回调参数一致\r\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [OnLaunchOptions](#onlaunchoptions) | \n\n#### OnLaunchOptions @onlaunchoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| path | string | 是 | - |\n","compatibility":"","tutorial":"\n### 参见\n[getLaunchOptionsSync](http://uniapp.dcloud.io/api/plugins/getLaunchOptionsSync)\n"},"navigateTo":{"name":"## uni.navigateTo(options) @navigateto","description":"\r\n保留当前页面，跳转到应用内的某个页面\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [NavigateToOptions](#navigatetooptions) | 是 | - |\n#### NavigateToOptions @navigatetooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| animationType | string | 否 | 窗口显示的动画类型 - `auto`: 自动选择动画效果 - `none`: 无动画效果 - `slide-in-right`: 从右侧横向滑动效果 - `slide-in-left`: 左侧横向滑动效果 - `slide-in-top`: 从上侧竖向滑动效果 - `slide-in-bottom`: 从下侧竖向滑动效果 - `fade-in`: 从透明到不透明逐渐显示效果 - `zoom-out`: 从小到大逐渐放大显示效果 - `zoom-fade-out`: 从小到大逐渐放大并且从透明到不透明逐渐显示效果 - `pop-in`: 从右侧平移入栈动画效果 - @type 'auto' \\| 'none' \\| 'slide-in-right' \\| 'slide-in-left' \\| 'slide-in-top' \\| 'slide-in-bottom' \\| 'fade-in' \\| 'zoom-out' \\| 'zoom-fade-out' \\| 'pop-in' |\n| animationDuration | number | 否 | 窗口显示动画的持续时间，单位为 ms |\n| events | any | 否 | 页面间通信接口，用于监听被打开页面发送到当前页面的数据 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[navigateTo](http://uniapp.dcloud.io/api/router?id=navigateto)\n"},"redirectTo":{"name":"## uni.redirectTo(options) @redirectto","description":"\r\n关闭当前页面，跳转到应用内的某个页面\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [RedirectToOptions](#redirecttooptions) | 是 | - |\n#### RedirectToOptions @redirecttooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[redirectTo](http://uniapp.dcloud.io/api/router?id=redirectto)\n"},"reLaunch":{"name":"## uni.reLaunch(options) @relaunch","description":"\r\n关闭所有页面，打开到应用内的某个页面\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ReLaunchOptions](#relaunchoptions) | 是 | - |\n#### ReLaunchOptions @relaunchoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[reLaunch](http://uniapp.dcloud.io/api/router?id=relaunch)\n"},"switchTab":{"name":"## uni.switchTab(options) @switchtab","description":"\r\n跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SwitchTabOptions](#switchtaboptions) | 是 | - |\n#### SwitchTabOptions @switchtaboptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 需要跳转的 tabBar 页面的路径，路径后不能带参数 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[switchTab](http://uniapp.dcloud.io/api/router?id=switchtab)\n"},"navigateBack":{"name":"## uni.navigateBack(options?) @navigateback","description":"\r\n关闭当前页面，返回上一页面或多级页面\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [NavigateBackOptions](#navigatebackoptions) | 否 | - |\n#### NavigateBackOptions @navigatebackoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| delta | number | 否 | 返回的页面数，如果 delta 大于现有页面数，则返回到首页 |\n| animationType | string | 否 | 窗口关闭的动画类型 - `auto`: 自动选择动画效果 - `none`: 无动画效果 - `slide-out-right`: 横向向右侧滑出屏幕动画 - `slide-out-left`: 横向向左侧滑出屏幕动画 - `slide-out-top`: 竖向向上侧滑出屏幕动画 - `slide-out-bottom`: 竖向向下侧滑出屏幕动画 - `fade-out`: 从不透明到透明逐渐隐藏动画 - `zoom-in`: 从大逐渐缩小关闭动画 - `zoom-fade-in`: 从大逐渐缩小并且从不透明到透明逐渐隐藏关闭动画 - `pop-out`: 从右侧平移出栈动画效果 - @type 'auto' \\| 'none' \\| 'slide-out-right' \\| 'slide-out-left' \\| 'slide-out-top' \\| 'slide-out-bottom' \\| 'fade-out' \\| 'zoom-in' \\| 'zoom-fade-in' \\| 'pop-out' |\n| animationDuration | number | 否 | 窗口关闭动画的持续时间，单位为 ms |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[navigateBack](http://uniapp.dcloud.io/api/router?id=navigateback)\n"},"createSelectorQuery":{"name":"## uni.createSelectorQuery() @createselectorquery","description":"\r\n返回一个SelectorQuery对象实例\r\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| SelectorQuery | \n","compatibility":"","tutorial":"\n### 参见\n[createSelectorQuery](http://uniapp.dcloud.io/api/ui/nodes-info?id=createselectorquery)\n"},"loadFontFace":{"name":"## uni.loadFontFace(options) @loadfontface","description":"\r\n动态加载网络字体\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [LoadFontFaceOptions](#loadfontfaceoptions) | 是 | - |\n#### LoadFontFaceOptions @loadfontfaceoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| global | boolean | 否 | 是否全局生效 |\n| family | string | 是 | 定义的字体名称 |\n| source | string | 是 | 字体资源的地址。建议格式为 TTF 和 WOFF，WOFF2 在低版本的iOS上会不兼容。 |\n| desc | [LoadFontFaceOptionDesc](#loadfontfaceoptiondesc) | 否 | - |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### LoadFontFaceOptionDesc @loadfontfaceoptiondesc \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| style | string | 是 | - |\n| weight | string | 是 | - |\n| variant | string | 是 | - |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[loadFontFace](http://uniapp.dcloud.io/api/ui/font?id=loadfontface)\n"},"pageScrollTo":{"name":"## uni.pageScrollTo(options) @pagescrollto","description":"\r\n将页面滚动到目标位置\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [PageScrollToOptions](#pagescrolltooptions) | 是 | - |\n#### PageScrollToOptions @pagescrolltooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| scrollTop | number | 是 | 滚动到页面的目标位置 |\n| selector | string | 是 | 选择器 |\n| offsetTop | number | 是 | 偏移距离，可以滚动到 selector 加偏移距离的位置 |\n| duration | number | 是 | 滚动动画的时长 |\n| success | (AsyncApiSuccessResult) => void | 是 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 是 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 是 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[pageScrollTo](http://uniapp.dcloud.io/api/ui/scroll?id=pagescrollto)\n"},"stopPullDownRefresh":{"name":"## uni.stopPullDownRefresh() @stoppulldownrefresh","description":"\r\n停止当前页面下拉刷新\r\n","param":"","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[stopPullDownRefresh](http://uniapp.dcloud.io/api/ui/pulldown?id=stoppulldownrefresh)\n"},"setNavigationBarColor":{"name":"## uni.setNavigationBarColor(options) @setnavigationbarcolor","description":"\r\n设置导航条颜色\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SetNavigationBarColorOptions](#setnavigationbarcoloroptions) | 是 | - |\n#### SetNavigationBarColorOptions @setnavigationbarcoloroptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| frontColor | string | 是 | 前景颜色值，包括按钮、标题、状态栏的颜色 |\n| backgroundColor | string | 是 | 背景颜色值，有效值为十六进制颜色 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[setNavigationBarColor](http://uniapp.dcloud.io/api/ui/navigationbar?id=setnavigationbarcolor)\n"},"setTabBarBadge":{"name":"## uni.setTabBarBadge(options) @settabbarbadge","description":"\r\n为 tabBar 某一项的右上角添加文本\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SetTabBarBadgeOptions](#settabbarbadgeoptions) | 是 | - |\n#### SetTabBarBadgeOptions @settabbarbadgeoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar的哪一项，从左边算起，索引从0开始 |\n| text | string | 是 | 显示的文本，不超过 3 个半角字符 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[setTabBarBadge](http://uniapp.dcloud.io/api/ui/tabbar?id=settabbarbadge)\n"},"removeTabBarBadge":{"name":"## uni.removeTabBarBadge(options) @removetabbarbadge","description":"\r\n移除 tabBar 某一项右上角的文本\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [RemoveTabBarBadgeOptions](#removetabbarbadgeoptions) | 是 | - |\n#### RemoveTabBarBadgeOptions @removetabbarbadgeoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar的哪一项，从左边算起，索引从0开始 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[removeTabBarBadge](http://uniapp.dcloud.io/api/ui/tabbar?id=removetabbarbadge)\n"},"setTabBarItem":{"name":"## uni.setTabBarItem(options) @settabbaritem","description":"\r\n动态设置 tabBar 某一项的内容\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SetTabBarItemOptions](#settabbaritemoptions) | 是 | - |\n#### SetTabBarItemOptions @settabbaritemoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar 的哪一项，从左边算起，索引从0开始 |\n| text | string | 否 | tab 上按钮文字 |\n| iconPath | string | 否 | 图片路径 |\n| selectedIconPath | string | 否 | 选中时的图片路径 |\n| pagePath | string | 否 | 页面绝对路径 |\n| iconfont | [SetTabBarItemIconFontOptions](#settabbaritemiconfontoptions) | 否 | 字体图标，优先级高于 iconPath |\n| visible | boolean | 否 | tab 是否显示 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### SetTabBarItemIconFontOptions @settabbaritemiconfontoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 是 | 字库 Unicode 码 |\n| selectedText | string | 是 | 选中后字库 Unicode 码 |\n| fontSize | string | 否 | 字体图标字号(px) |\n| color | string | 否 | 字体图标颜色 |\n| selectedColor | string | 否 | 字体图标选中颜色 |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[setTabBarItem](http://uniapp.dcloud.io/api/ui/tabbar?id=settabbaritem)\n"},"setTabBarStyle":{"name":"## uni.setTabBarStyle(options) @settabbarstyle","description":"\r\n动态设置 tabBar 的整体样式\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SetTabBarStyleOptions](#settabbarstyleoptions) | 是 | - |\n#### SetTabBarStyleOptions @settabbarstyleoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| color | string | 否 | tab 上的文字默认颜色 |\n| selectedColor | string | 否 | tab 上的文字选中时的颜色 {HBuilderX.ColorString} |\n| backgroundColor | string | 否 | tab 的背景色 |\n| backgroundImage | string | 否 | 图片背景 |\n| backgroundRepeat | string | 否 | 背景图平铺方式 |\n| borderStyle | string | 否 | tabbar上边框的颜色 |\n| midButton | [MidButtonOptions](#midbuttonoptions) | 否 | tabbar 中间按钮 仅在 list 项为偶数时有效 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### MidButtonOptions @midbuttonoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| width | string | 否 | 中间按钮的宽度，tabBar 其它项为减去此宽度后平分，默认值为与其它项平分宽度。默认 80px |\n| height | string | 否 | 中间按钮的高度，可以大于 tabBar 高度，达到中间凸起的效果。默认 50px |\n| text | string | 否 | 中间按钮的文字 |\n| iconPath | string | 否 | 中间按钮的图片路径 |\n| iconWidth | string | 否 | 图片宽度（高度等比例缩放）。默认 24px |\n| backgroundImage | string | 否 | 中间按钮的背景图片路径 |\n| iconfont | [MidButtonIconFont](#midbuttoniconfont) | 否 | 字体图标，优先级高于 iconPath |\n\n###### MidButtonIconFont @midbuttoniconfont \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 否 | 字库 Unicode 码 |\n| selectedText | string | 否 | 选中后字库 Unicode 码 |\n| fontSize | string | 否 | 字体图标字号(px) |\n| color | string | 否 | 字体图标颜色 |\n| selectedColor | string | 否 | 字体图标选中颜色 |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[setTabBarStyle](http://uniapp.dcloud.io/api/ui/tabbar?id=settabbarstyle)\n"},"hideTabBar":{"name":"## uni.hideTabBar(options?) @hidetabbar","description":"\r\n隐藏 tabBar\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [HideTabBarOptions](#hidetabbaroptions) | 否 | - |\n#### HideTabBarOptions @hidetabbaroptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| animation | boolean | 否 | 是否需要动画效果 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[hideTabBar](http://uniapp.dcloud.io/api/ui/tabbar?id=hidetabbar)\n"},"showTabBar":{"name":"## uni.showTabBar(options?) @showtabbar","description":"\r\n显示 tabBar\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowTabBarOptions](#showtabbaroptions) | 否 | - |\n#### ShowTabBarOptions @showtabbaroptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| animation | boolean | 否 | 是否需要动画效果 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[showTabBar](http://uniapp.dcloud.io/api/ui/tabbar?id=showtabbar)\n"},"showTabBarRedDot":{"name":"## uni.showTabBarRedDot(options) @showtabbarreddot","description":"\r\n显示 tabBar 某一项的右上角的红点\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowTabBarRedDotOptions](#showtabbarreddotoptions) | 是 | - |\n#### ShowTabBarRedDotOptions @showtabbarreddotoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar的哪一项，从左边算起，索引从0开始 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[showTabBarRedDot](http://uniapp.dcloud.io/api/ui/tabbar?id=showtabbarreddot)\n"},"hideTabBarRedDot":{"name":"## uni.hideTabBarRedDot(options) @hidetabbarreddot","description":"\r\n隐藏 tabBar 某一项的右上角的红点\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [HideTabBarRedDotOptions](#hidetabbarreddotoptions) | 是 | - |\n#### HideTabBarRedDotOptions @hidetabbarreddotoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar的哪一项，从左边算起，索引从0开始 |\n| success | (AsyncApiSuccessResult) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (AsyncApiResult) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"","tutorial":"\n### 参见\n[hideTabBarRedDot](http://uniapp.dcloud.io/api/ui/tabbar?id=hidetabbarreddot)\n"},"exit":{"name":"## uni.exit(options?) @exit","description":"\r\n退出当前应用","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ExitOptions](#exitoptions) | 否 | - |\n#### ExitOptions @exitoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | ([ExitSuccess](#exitsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ExitSuccess @exitsuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 3.8.15 | 3.9.0 | x | x | x |\n","tutorial":""},"getAppAuthorizeSetting":{"name":"## uni.getAppAuthorizeSetting() @getappauthorizesetting","description":"获取 APP 授权设置。","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetAppAuthorizeSettingResult](#getappauthorizesettingresult) | \n\n#### GetAppAuthorizeSettingResult @getappauthorizesettingresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| albumAuthorized | string | 是 | 允许 App 使用相册的开关（仅 iOS 支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） |\n| bluetoothAuthorized | string | 是 | 允许 App 使用蓝牙的开关（仅 iOS 支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: Android平台没有该值；iOS平台：表示没有在 `manifest.json -\\> App模块配置` 中配置 `BlueTooth(低功耗蓝牙)` 模块 |\n| cameraAuthorized | string | 是 | 允许 App 使用摄像头的开关 - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: Android平台：表示没有授予 `android.permission.CAMERA` 权限；iOS平台没有该值 |\n| locationAuthorized | string | 是 | 允许 App 使用定位的开关 - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: Android平台：表示没有授予 `android.permission.ACCESS_COARSE_LOCATION` 权限；iOS平台：表示没有在 `manifest.json -\\> App模块配置` 中配置 `Geolocation(定位)` 模块 |\n| locationAccuracy | string | 是 | 定位准确度。true 表示模糊定位，false 表示精确定位（仅 iOS 支持） - reduced: 模糊定位 - full: 精准定位 - unsupported: 不支持（包括用户拒绝定位权限和没有在 `manifest.json -\\> App模块配置` 中配置 `Geolocation(定位)` 模块） |\n| locationReducedAccuracy | boolean | 是 | 定位准确度（推荐使用 locationAccuracy 属性）。true 表示模糊定位，false 表示精确定位（仅 iOS 支持） |\n| microphoneAuthorized | string | 是 | 允许 App 使用麦克风的开关 - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: Android平台：表示没有授予 `android.permission.RECORD_AUDIO` 权限；iOS平台没有该值 |\n| notificationAuthorized | string | 是 | 允许 App 通知的开关 - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: Android平台没有该值；iOS平台：表示没有在 `manifest.json -\\> App模块配置` 中配置 `Push(推送)` 模块 |\n| notificationAlertAuthorized | string | 是 | 允许 App 通知带有提醒的开关（仅 iOS 10.0+ 支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: 没有在 `manifest.json -\\> App模块配置` 中配置 `Push(推送)` 模块 |\n| notificationBadgeAuthorized | string | 是 | 允许 App 通知带有标记的开关（仅 iOS 10.0+ 支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: 没有在 `manifest.json -\\> App模块配置` 中配置 `Push(推送)` 模块 |\n| notificationSoundAuthorized | string | 是 | 允许 App 通知带有声音的开关（仅 iOS 10.0+ 支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） - config error: 没有在 `manifest.json -\\> App模块配置` 中配置 `Push(推送)` 模块 |\n| phoneCalendarAuthorized | string | 是 | 允许读写日历的开关（仅微信小程序支持） - authorized: 已经获得授权，无需再次请求授权 - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限） - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关） |\n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getAppAuthorizeSetting](http://uniapp.dcloud.io/api/system/getappauthorizesetting)\n"},"getAppBaseInfo":{"name":"## uni.getAppBaseInfo(config?) @getappbaseinfo","description":"获取app基本信息","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| config | [GetAppBaseInfoOptions](#getappbaseinfooptions) | 否 | - |\n#### GetAppBaseInfoOptions @getappbaseinfooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| filter | Array\\ | 是 | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetAppBaseInfoResult](#getappbaseinforesult) | \n\n#### GetAppBaseInfoResult @getappbaseinforesult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| appId | string | 否 | manifest.json 中应用appid，即DCloud appid。\t |\n| appName | string | 否 | manifest.json 中应用名称\t |\n| appVersion | string | 否 | manifest.json 中应用版本名称。\t |\n| appVersionCode | string | 否 | manifest.json 中应用版本名号。\t |\n| appLanguage | string | 否 | 应用设置的语言en、zh-Hans、zh-Hant、fr、es\t |\n| language | string | 否 | 应用设置的语言\t |\n| version | string | 否 | 引擎版本号 |\n| appWgtVersion | string | 否 | 应用资源（wgt）的版本名称。\t |\n| hostLanguage | string | 否 | 小程序宿主语言\t |\n| hostVersion | string | 否 | App、小程序宿主版本。 |\n| hostName | string | 否 | 小程序宿主名称\t |\n| hostPackageName | string | 否 | 小程序宿主包名\t |\n| hostSDKVersion | string | 否 | uni小程序SDK版本、小程序客户端基础库版本\t |\n| hostTheme | string | 否 | 系统当前主题，取值为light或dark。微信小程序全局配置\"darkmode\":true时才能获取，否则为 null （不支持小游戏） |\n| isUniAppX | boolean | 是 | 是否uni-app x |\n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getAppBaseInfo](https://uniapp.dcloud.net.cn/api/system/getAppBaseInfo.html)\n"},"getDeviceInfo":{"name":"## uni.getDeviceInfo(config?) @getdeviceinfo","description":"获取设备信息","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| config | [GetDeviceInfoOptions](#getdeviceinfooptions) | 否 | - |\n#### GetDeviceInfoOptions @getdeviceinfooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| filter | Array\\ | 是 | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetDeviceInfoResult](#getdeviceinforesult) | \n\n#### GetDeviceInfoResult @getdeviceinforesult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| brand | string | 否 | 设备品牌 |\n| deviceBrand | string | 否 | 设备品牌 |\n| deviceId | string | 否 | 设备 id 。由 uni-app 框架生成并存储，清空 Storage 会导致改变 |\n| model | string | 否 | 设备型号\t |\n| deviceModel | string | 否 | 设备型号\t |\n| deviceType | string | 否 | 设备类型phone、pad、pc\t |\n| deviceOrientation | string | 否 | 设备方向 竖屏 portrait、横屏 landscape\t |\n| devicePixelRatio | string | 否 | 设备像素比\t |\n| system | string | 否 | 操作系统及版本\t |\n| platform | string | 否 | 客户端平台\t |\n| oaid | string | 否 | oaid标识 Android专有 |\n| isRoot | boolean | 否 | 是否root |\n| isSimulator | boolean | 否 | 是否是模拟器 |\n| isUSBDebugging | boolean | 否 | adb是否开启 |\n| idfa | string | 否 | idfa标识 iOS专有 |\n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getDeviceInfo](https://uniapp.dcloud.net.cn/api/system/getDeviceInfo.html)\n"},"getLocation":{"name":"## uni.getLocation(options) @getlocation","description":"获取当前的地理位置、速度","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetLocationOptions](#getlocationoptions) | 是 | - |\n#### GetLocationOptions @getlocationoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 否 | 默认为 wgs84 返回 gps 坐标，gcj02 返回可用于uni.openLocation的坐标 |\n| altitude | boolean | 否 | 传入 true 会返回高度信息，由于获取高度需要较高精确度，会减慢接口返回速度 |\n| geocode | boolean | 否 | 传入 true 会解析地址 |\n| highAccuracyExpireTime | number | 否 | 高精度定位超时时间(ms)，指定时间内返回最高精度，该值3000ms以上高精度定位才有效果 |\n| isHighAccuracy | boolean | 否 | 开启高精度定位 |\n| success | ([GetLocationSuccess](#getlocationsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetLocationSuccess @getlocationsuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| latitude | number | 是 | 纬度，浮点数，范围为-90~90，负数表示南纬 |\n| longitude | number | 是 | 经度，范围为-180~180，负数表示西经 |\n| speed | number | 是 | 速度，浮点数，单位m/s |\n| accuracy | number | 是 | 位置的精确度 |\n| altitude | number | 是 | 高度，单位 m |\n| verticalAccuracy | number | 是 | 垂直精度，单位 m（Android 无法获取，返回 0） |\n| horizontalAccuracy | number | 是 | 水平精度，单位 m |\n| address | any | 是 | 地址信息 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | √ | 3.9.0 | x | x | x |\n","tutorial":"\n### 参见\n[getLocation]([](http://uniapp.dcloud.io/api/location/location?id=getlocation))\n"},"getNetworkType":{"name":"## uni.getNetworkType(options) @getnetworktype","description":"获取网络类型","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetNetworkTypeOptions](#getnetworktypeoptions) | 是 | - |\n#### GetNetworkTypeOptions @getnetworktypeoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | ([GetNetworkTypeSuccess](#getnetworktypesuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetNetworkTypeSuccess @getnetworktypesuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| networkType | string | 是 | 网络类型 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getNetworkType](http://uniapp.dcloud.io/api/system/network?id=getnetworktype)\n"},"getSystemInfo":{"name":"## uni.getSystemInfo(options) @getsysteminfo","description":"异步获取系统信息","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetSystemInfoOptions](#getsysteminfooptions) | 是 | - |\n#### GetSystemInfoOptions @getsysteminfooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | ([GetSystemInfoResult](#getsysteminforesult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetSystemInfoResult @getsysteminforesult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| SDKVersion | string | 是 | 客户端基础库版本 |\n| appId | string | 是 | 当前运行的客户端 |\n| appLanguage | string | 是 | 应用设置的语言。仅 App、H5 支持 |\n| appName | string | 是 | `manifest.json` 中应用名称。和`字节跳动小程序、飞书小程序`字段冲突，原字端与`hostName`一致 |\n| appVersion | string | 是 | `manifest.json` 中应用版本名称。 |\n| appVersionCode | number | 是 | `manifest.json` 中应用版本名号 |\n| appWgtVersion | string | 是 | 应用资源（wgt）的版本名称。（仅 App 支持） |\n| brand | string | 是 | 手机品牌。H5 不支持 |\n| browserName | string | 是 | 浏览器名称。`App` 端是系统 webview 的名字，比如 wkwebview、chrome。小程序端为空 |\n| browserVersion | string | 是 | 浏览器版本、webview 版本。小程序端为空 |\n| deviceId | string | 是 | 设备 ID |\n| deviceBrand | string | 是 | 设备品牌。如：`apple`、`huawei`。H5 不支持 |\n| deviceModel | string | 是 | 设备型号 |\n| deviceType | string | 是 | 设备类型。`phone`、`pad`、`pc` |\n| devicePixelRatio | number | 是 | 设备像素比 |\n| deviceOrientation | string | 是 | 设备方向。如：`竖屏 portrait`、`横屏 landscape` - portrait: 竖屏 - landscape: 横屏 |\n| language | string | 是 | 用户字体大小设置 |\n| model | string | 是 | 手机型号 |\n| osName | string | 是 | ios、android、windows、mac、linux |\n| osVersion | string | 是 | 操作系统版本。如 ios 版本，andriod 版本 |\n| osLanguage | string | 是 | 操作系统语言，小程序端与 `version` 相同，H5 与浏览器语言一致 |\n| osTheme | string | 是 | \\|操作系统主题 light、dark。小程序端为小程序主题，H5 端为空 |\n| pixelRatio | number | 是 | 设备像素比 |\n| platform | string | 是 | 客户端平台 |\n| screenWidth | number | 是 | 屏幕宽度 |\n| screenHeight | number | 是 | 屏幕高度 |\n| statusBarHeight | number | 是 | 状态栏的高度 |\n| system | string | 是 | 设备磁盘容量 |\n| safeArea | [SafeArea](#safearea) | 是 | 在竖屏正方向下的安全区域 |\n| safeAreaInsets | [SafeAreaInsets](#safeareainsets) | 是 | 在竖屏正方向下的安全区域插入位置 |\n| ua | string | 是 | 用户标识。小程序端为空 |\n| uniCompileVersion | string | 是 | uni 编译器版本号 |\n| uniPlatform | string | 是 | uni-app 运行平台。如：`app`、`mp-weixin`、`web` |\n| uniRuntimeVersion | string | 是 | uni 运行时版本 |\n| version | string | 是 | 引擎版本号 |\n| romName | string | 是 | rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios` |\n| romVersion | string | 是 | rom 版本号。Android 部分机型获取不到值。iOS 恒为 `ios 版本号` |\n| windowWidth | number | 是 | 可使用窗口宽度 |\n| windowHeight | number | 是 | 可使用窗口高度 |\n| windowTop | number | 是 | 导航栏的高度 |\n| windowBottom | number | 是 | 可使用窗口的底部位置 |\n| oaid | string | 是 | 允许微信使用相册的开关（仅 iOS 有效） |\n| osAndroidAPILevel | number | 是 | Android 系统API库的版本。 |\n\n###### SafeArea @safearea \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| left | number | 是 | 安全区域左上角横坐标 |\n| right | number | 是 | 安全区域右下角横坐标 |\n| top | number | 是 | 安全区域左上角纵坐标 |\n| bottom | number | 是 | 安全区域右下角纵坐标 |\n| width | number | 是 | 安全区域的宽度，单位逻辑像素 |\n| height | number | 是 | 安全区域的高度，单位逻辑像素 |\n\n###### SafeAreaInsets @safeareainsets \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| left | number | 是 | 安全区域左侧插入位置 |\n| right | number | 是 | 安全区域右侧插入位置 |\n| top | number | 是 | 安全区顶部插入位置 |\n| bottom | number | 是 | 安全区域底部插入位置 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getSystemInfo](http://uniapp.dcloud.io/api/system/info?id=getsysteminfo)\n"},"getWindowInfo":{"name":"## uni.getWindowInfo() @getwindowinfo","description":"同步获取窗口信息","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetWindowInfoResult](#getwindowinforesult) | \n\n#### GetWindowInfoResult @getwindowinforesult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| pixelRatio | number | 是 | 设备像素比 |\n| screenWidth | number | 是 | 屏幕宽度 |\n| screenHeight | number | 是 | 屏幕高度 |\n| windowWidth | number | 是 | 可使用窗口宽度 |\n| windowHeight | number | 是 | 可使用窗口高度 |\n| statusBarHeight | number | 是 | 状态栏的高度 |\n| windowTop | number | 是 | 可使用窗口的顶部位置 |\n| windowBottom | number | 是 | 可使用窗口的底部位置 |\n| safeArea | [SafeArea](#safearea) | 是 | 在竖屏正方向下的安全区域 |\n| safeAreaInsets | [SafeAreaInsets](#safeareainsets) | 是 | 在竖屏正方向下的安全区域插入位置 |\n| screenTop | number | 是 | 窗口上边缘的 y 值 |\n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getWindowInfo](http://uniapp.dcloud.io/api/system/getWindowInfo.html)\n"},"getSystemSetting":{"name":"## uni.getSystemSetting() @getsystemsetting","description":"获取系统设置","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetSystemSettingResult](#getsystemsettingresult) | \n\n#### GetSystemSettingResult @getsystemsettingresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| bluetoothEnabled | boolean | 否 | 蓝牙是否开启 |\n| bluetoothError | string | 否 | 蓝牙的报错信息 |\n| locationEnabled | boolean | 否 | 位置是否开启 |\n| wifiEnabled | boolean | 否 | wifi是否开启 |\n| wifiError | string | 否 | wifi的报错信息 |\n| deviceOrientation | string | 否 | 设备方向 |\n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[getSystemSetting](https://uniapp.dcloud.net.cn/api/system/getsystemsetting.html)\n"},"chooseImage":{"name":"## uni.chooseImage(options) @chooseimage","description":"从本地相册选择图片或使用相机拍照","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ChooseImageOptions](#chooseimageoptions) | 是 | - |\n#### ChooseImageOptions @chooseimageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| count | number | 否 | 最多可以选择的图片张数，默认9 |\n| sizeType | Array\\ | 否 | original 原图，compressed 压缩图，默认二者都有 |\n| sourceType | Array\\ | 否 | album 从相册选图，camera 使用相机，默认二者都有 |\n| extension | Array\\ | 否 | 根据文件拓展名过滤，每一项都不能是空字符串。默认不过滤。 |\n| crop | [ChooseImageCropOptions](#chooseimagecropoptions) | 否 | 图像裁剪参数，设置后 sizeType 失效。 |\n| success | ([ChooseImageSuccessCallback](#chooseimagesuccesscallback)) => void | 否 | 成功则返回图片的本地文件路径列表 tempFilePaths |\n| fail | ([ChooseImageFailCallback](#chooseimagefailcallback)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ChooseImageCropOptions @chooseimagecropoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| width | number | 是 | 裁剪的宽度，单位为px，用于计算裁剪宽高比。 |\n| height | number | 是 | 裁剪的高度，单位为px，用于计算裁剪宽高比。 |\n| quality | number | 是 | 取值范围为1-100，数值越小，质量越低（仅对jpg格式有效）。默认值为80。 |\n| resize | boolean | 是 | 是否将width和height作为裁剪保存图片真实的像素值。默认值为true。注：设置为false时在裁剪编辑界面显示图片的像素值，设置为true时不显示。 |\n| saveToAlbum | boolean | 是 | 是否将裁剪的图片保存到手机相册里，默认值为false。 |\n\n##### ChooseImageSuccessCallback @chooseimagesuccesscallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errSubject | string | 是 | 调用API的名称 |\n| errMsg | string | 是 | - |\n| tempFilePaths | Array\\ | 是 | - |\n| tempFiles | any | 是 | - |\n\n##### ChooseImageFailCallback @chooseimagefailcallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errCode | number | 是 | 错误码 |\n| errSubject | string | 是 | 调用API的名称 |\n| errMsg | string | 是 | 错误的详细信息 |\n| cause | any | 是 | 错误来源 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | - | - | - |\n","tutorial":"\n### 参见\n[chooseImage](http://uniapp.dcloud.io/api/media/image?id=chooseimage)\n"},"previewImage":{"name":"## uni.previewImage(options) @previewimage","description":"预览图片","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [PreviewImageOptions](#previewimageoptions) | 是 | - |\n#### PreviewImageOptions @previewimageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| count | string | 否 | 当前显示图片的链接，不填则默认为 urls 的第一张 |\n| current | any | 否 | current 为当前显示图片的链接/索引值，不填或填写的值无效则为 urls 的第一张。App平台在 1.9.5至1.9.8之间，current为必填。不填会报错 |\n| urls | Array\\ | 是 | 需要预览的图片链接列表 |\n| indicator | string | 否 | 图片指示器样式 - default: 底部圆点指示器 - number: 顶部数字指示器 - none: 不显示指示器 |\n| loop | boolean | 否 | 是否可循环预览 |\n| longPressActions | [LongPressActionsOptions](#longpressactionsoptions) | 否 | 长按图片显示操作菜单，如不填默认为保存相册，1.9.5 起支持。 |\n| success | ([PreviewImageSuccessCallback](#previewimagesuccesscallback)) => void | 否 | 接口调用成功的回调函数 |\n| fail | ([PreviewImageFailCallback](#previewimagefailcallback)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### LongPressActionsOptions @longpressactionsoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| itemList | Array\\ | 是 | 按钮的文字数组 |\n| itemColor | string | 是 | 按钮的文字颜色，字符串格式，默认为\"#000000\" |\n| success | ([LongPressActionsSuccessData](#longpressactionssuccessdata)) => void | 是 | 接口调用成功的回调函数 |\n| fail | (any) => void | 是 | 接口调用失败的回调函数 |\n| complete | (any) => void | 是 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n###### LongPressActionsSuccessData @longpressactionssuccessdata \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| tapIndex | number | 是 | 接口调用失败的回调函数 |\n| index | number | 是 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### PreviewImageSuccessCallback @previewimagesuccesscallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errSubject | string | 是 | - |\n| errMsg | string | 是 | - |\n\n##### PreviewImageFailCallback @previewimagefailcallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errCode | number | 是 | 错误码 |\n| errSubject | string | 是 | 调用API的名称 |\n| errMsg | string | 是 | 错误的详细信息 |\n| cause | any | 是 | 错误来源 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | - | - | - |\n","tutorial":"\n### 参见\n[previewImage](http://uniapp.dcloud.io/api/media/image?id=previewimage)\n"},"closePreviewImage":{"name":"## uni.closePreviewImage(options) @closepreviewimage","description":"关闭图片预览","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ClosePreviewImageOptions](#closepreviewimageoptions) | 是 | - |\n#### ClosePreviewImageOptions @closepreviewimageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | ([ClosePreviewImageSuccessCallback](#closepreviewimagesuccesscallback)) => void | 否 | 接口调用成功的回调函数 |\n| fail | ([ClosePreviewImageFailCallback](#closepreviewimagefailcallback)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ClosePreviewImageSuccessCallback @closepreviewimagesuccesscallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | 错误信息 |\n\n##### ClosePreviewImageFailCallback @closepreviewimagefailcallback \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errCode | number | 是 | 错误码 |\n| errSubject | string | 是 | 调用API的名称 |\n| errMsg | string | 是 | 错误的详细信息 |\n| cause | any | 是 | 错误来源 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | - | - | - |\n","tutorial":"\n### 参见\n[closePreviewImage](http://uniapp.dcloud.io/api/media/image?id=closepreviewimage)\n"},"request":{"name":"## uni.request(param) @request","description":"发起网络请求。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| param | [RequestOptions](#requestoptions) | 是 | 网络请求参数 |\n#### RequestOptions\\ @requestoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 开发者服务器接口地址 |\n| data | any | 否 | 请求的参数 Object\\|String类型 |\n| header | UTSJSONObject | 否 | - |\n| method | string | 否 | 请求类型 默认值GET\t GET\\|POST\\|PUT\\|DELETE\\|HEAD\\|OPTIONS |\n| timeout | number | 否 | 超时时间，单位 ms |\n| dataType | string | 否 | 如果设为 json，会对返回的数据进行一次 JSON.parse，非 json 不会进行 JSON.parse |\n| responseType | string | 否 | 设置响应的数据类型。 |\n| sslVerify | boolean | 否 | 验证 ssl 证书 |\n| withCredentials | boolean | 否 | 跨域请求时是否携带凭证（cookies） |\n| firstIpv4 | boolean | 否 | DNS解析时优先使用ipv4 |\n| success | ([RequestSuccess](#requestsuccess)) => void | 否 | 网络请求成功回调。 |\n| fail | (UniError) => void | 否 | 网络请求失败回调。 |\n| complete | (any) => void | 否 | 网络请求完成回调，成功或者失败都会调用。 |\n\n##### RequestSuccess\\ @requestsuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | any | 是 | 开发者服务器返回的数据 |\n| statusCode | number | 是 | 开发者服务器返回的 HTTP 状态码 |\n| header | any | 是 | 开发者服务器返回的 HTTP Response Header |\n| cookies | Array\\ | 是 | 开发者服务器返回的 cookies，格式为字符串数组 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| RequestTask | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[request](https://uniapp.dcloud.net.cn/api/request/request.html)\n"},"uploadFile":{"name":"## uni.uploadFile(options) @uploadfile","description":"将本地资源上传到开发者服务器。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [UploadFileOptions](#uploadfileoptions) | 是 | - |\n#### UploadFileOptions @uploadfileoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 开发者服务器 url |\n| filePath | string | 否 | 要上传文件资源的路径 |\n| name | string | 否 | 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容 |\n| files | Array\\<[UploadFileOptionFiles](#uploadfileoptionfiles)\\> | 否 | 需要上传的文件列表。 |\n| header | UTSJSONObject | 否 | HTTP 请求 Header, header 中不能设置 Referer |\n| formData | UTSJSONObject | 否 | HTTP 请求中其他额外的 form data |\n| timeout | number | 否 | 超时时间，单位 ms |\n| success | ([UploadFileSuccess](#uploadfilesuccess)) => void | 否 | 成功返回的回调函数 |\n| fail | (UniError) => void | 否 | 失败的回调函数 |\n| complete | (any) => void | 否 | 结束的回调函数（调用成功、失败都会执行） |\n\n##### UploadFileOptionFiles @uploadfileoptionfiles \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| name | string | 是 | multipart 提交时，表单的项目名，默认为 file，如果 name 不填或填的值相同，可能导致服务端读取文件时只能读取到一个文件。 |\n| uri | string | 是 | 要上传文件资源的路径 |\n| file | any | 是 | 要上传的文件对象，仅H5（2.6.15+）支持 |\n\n##### UploadFileSuccess @uploadfilesuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | string | 是 | 开发者服务器返回的数据 |\n| statusCode | number | 是 | 开发者服务器返回的 HTTP 状态码 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| UploadTask | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[uploadFile](https://uniapp.dcloud.net.cn/api/request/network-file.html#uploadfile)\n"},"downloadFile":{"name":"## uni.downloadFile(options) @downloadfile","description":"下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [DownloadFileOptions](#downloadfileoptions) | 是 | - |\n#### DownloadFileOptions @downloadfileoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 下载资源的 url |\n| header | UTSJSONObject | 否 | HTTP 请求 Header，header 中不能设置 Referer |\n| timeout | number | 否 | 超时时间，单位 ms |\n| success | ([DownloadFileSuccess](#downloadfilesuccess)) => void | 否 | 下载成功后以 tempFilePath 的形式传给页面，res = {tempFilePath: '文件的临时路径'} |\n| fail | (UniError) => void | 否 | 失败的回调函数 |\n| complete | (any) => void | 否 | 结束的回调函数（调用成功、失败都会执行） |\n\n##### DownloadFileSuccess @downloadfilesuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| tempFilePath | string | 是 | 临时文件路径，下载后的文件会存储到一个临时文件 |\n| statusCode | number | 是 | 开发者服务器返回的 HTTP 状态码 |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| DownloadTask | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[downloadFile](https://uniapp.dcloud.net.cn/api/request/network-file.html#downloadfile)\n"},"showToast":{"name":"## uni.showToast(options) @showtoast","description":"\r\nuni.showToast函数定义\r\n弹出toast \r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowToastOptions](#showtoastoptions) | 是 | uni.showToast参数定义 |\n#### ShowToastOptions @showtoastoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| title | string | 是 | 提示的内容，长度与 icon 取值有关。 |\n| icon | string | 否 | icon值说明 success: 显示成功图标，error: 显示错误图标； fail: 显示错误图标，此时title文本无长度显示； exception: 显示异常图标，此时title文本无长度显示； loading: 显示加载图标；none: 不显示图标。 |\n| image | string | 否 | 自定义图标的本地路径（app端暂不支持gif） |\n| mask | boolean | 否 | 是否显示透明蒙层，防止触摸穿透，默认：false |\n| duration | number | 否 | 提示的延迟时间，单位毫秒，默认：1500 |\n| position | string | 否 | position值说明（仅App生效） top: 居上显示； center: 居中显示；bottom： 居底显示 |\n| success | ([ShowToastSuccess](#showtoastsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[showToast](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showtoast)\n"},"showLoading":{"name":"## uni.showLoading(options) @showloading","description":"\r\nuni.showLoading函数定义\r\n弹出loading\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowLoadingOptions](#showloadingoptions) | 是 | uni.showLoading参数定义 |\n#### ShowLoadingOptions @showloadingoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| title | string | 是 | 提示的内容，长度与 icon 取值有关。 |\n| mask | boolean | 否 | 是否显示透明蒙层，防止触摸穿透，默认：false |\n| success | ([ShowLoadingSuccess](#showloadingsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[showLoading](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showloading)\n"},"showModal":{"name":"## uni.showModal(options) @showmodal","description":"\r\nuni.showModal 函数定义\r\n\r\n弹出modal\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowModalOptions](#showmodaloptions) | 是 | uni.showModal 参数定义 |\n#### ShowModalOptions @showmodaloptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| title | string | 否 | 提示的标题 |\n| content | string | 否 | 提示的内容 |\n| showCancel | boolean | 否 | |\n| cancelText | string | 否 | 取消按钮的文字，默认为\"取消\" |\n| cancelColor | string | 否 | 取消按钮的文字颜色，默认为\"#000000\" |\n| confirmText | string | 否 | 确定按钮的文字，默认为\"确定\" |\n| confirmColor | string | 否 | 确定按钮的文字颜色 |\n| editable | boolean | 否 | |\n| placeholderText | string | 否 | 显示输入框时的提示文本 |\n| success | ([ShowModalSuccess](#showmodalsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ShowModalSuccess @showmodalsuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| confirm | boolean | 是 | 为 true 时，表示用户点击了确定按钮 |\n| cancel | boolean | 是 | 为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭） |\n| content | string | 是 | editable 为 true 时，用户输入的文本 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[showModal](https://uniapp.dcloud.net.cn/api/ui/prompt.html#showmodal)\n"},"setStorage":{"name":"## uni.setStorage(options) @setstorage","description":"\r\nuni.setStorage函数定义\r\n将数据存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个异步接口。 \r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SetStorageOptions](#setstorageoptions) | 是 | uni.setStorage参数定义 |\n#### SetStorageOptions @setstorageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |\n| data | any | 是 | 需要存储的内容，只支持原生类型、及能够通过 JSON.stringify 序列化的对象 |\n| success | ([SetStorageSuccess](#setstoragesuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[setStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstorage)\n"},"setStorageSync":{"name":"## uni.setStorageSync(key, data) @setstoragesync","description":"\r\nuni.setStorageSync函数定义\r\n将 data 存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个同步接口。\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |\n| data | any | 是 | 需要存储的内容，只支持原生类型、及能够通过 JSON.stringify 序列化的对象 |","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[setStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#setstoragesync)\n"},"getStorage":{"name":"## uni.getStorage(options) @getstorage","description":"\r\nuni.getStorage函数定义\r\n从本地缓存中异步获取指定 key 对应的内容。\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetStorageOptions](#getstorageoptions) | 是 | uni.getStorage参数定义 |\n#### GetStorageOptions @getstorageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |\n| success | ([GetStorageSuccess](#getstoragesuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetStorageSuccess @getstoragesuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | any | 是 | key 对应的内容 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[getStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorage)\n"},"getStorageSync":{"name":"## uni.getStorageSync(key) @getstoragesync","description":"\r\nuni.getStorageSync函数定义\r\n从本地缓存中同步获取指定 key 对应的内容。\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[getStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstoragesync)\n"},"getStorageInfo":{"name":"## uni.getStorageInfo(options) @getstorageinfo","description":"\r\nuni.getStorageInfo函数定义\r\n异步获取当前 storage 的相关信息。\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetStorageInfoOptions](#getstorageinfooptions) | 是 | uni.getStorageInfo参数定义 |\n#### GetStorageInfoOptions @getstorageinfooptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | ([GetStorageInfoSuccess](#getstorageinfosuccess)) => void | 是 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 是 | 接口调用失败的回调函数 |\n| complete | (any) => void | 是 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetStorageInfoSuccess @getstorageinfosuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| keys | Array\\ | 是 | 当前 storage 中所有的 key |\n| currentSize | number | 是 | 当前占用的空间大小, 单位：kb |\n| limitSize | number | 是 | 限制的空间大小, 单位：kb |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[getStorageInfo](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfo)\n"},"getStorageInfoSync":{"name":"## uni.getStorageInfoSync() @getstorageinfosync","description":"\r\nuni.getStorageInfoSync函数定义\r\n同步获取当前 storage 的相关信息。\r\n\r\n","param":"","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| [GetStorageInfoSuccess](#getstorageinfosuccess) | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[getStorageInfoSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#getstorageinfosync)\n"},"removeStorage":{"name":"## uni.removeStorage(options) @removestorage","description":"\r\nuni.removeStorage函数定义\r\n从本地缓存中异步移除指定 key。\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [RemoveStorageOptions](#removestorageoptions) | 是 | uni.removeStorage参数定义 |\n#### RemoveStorageOptions @removestorageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |\n| success | ([RemoveStorageSuccess](#removestoragesuccess)) => void | 否 | 接口调用的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[removeStorage](hhttps://uniapp.dcloud.net.cn/api/storage/storage.html#removestorage)\n"},"removeStorageSync":{"name":"## uni.removeStorageSync(key) @removestoragesync","description":"\r\nuni.removeStorageSync函数定义\r\n从本地缓存中同步移除指定 key。\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[removeStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#removestoragesync)\n"},"clearStorage":{"name":"## uni.clearStorage(option?) @clearstorage","description":"\r\nuni.clearStorage函数定义\r\n清理本地数据缓存。\r\n","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| option | [ClearStorageOptions](#clearstorageoptions) | 否 | - |\n#### ClearStorageOptions @clearstorageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | ([ClearStorageSuccess](#clearstoragesuccess)) => void | 否 | 接口调用的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[clearStorage](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstorage)\n"},"clearStorageSync":{"name":"## uni.clearStorageSync() @clearstoragesync","description":"\r\nuni.clearStorageSync函数定义\r\n清理本地数据缓存。\r\n","param":"","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4.4 | 2.0.3 | 3.9.0 | 9.0 | 2.0.3 | 3.9.0 |\n","tutorial":"\n### 参见\n[clearStorageSync](https://uniapp.dcloud.net.cn/api/storage/storage.html#clearstoragesync)\n"},"connectSocket":{"name":"## uni.connectSocket(options) @connectsocket","description":"创建一个 WebSocket 连接。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ConnectSocketOptions](#connectsocketoptions) | 是 | - |\n#### ConnectSocketOptions @connectsocketoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 开发者服务器接口地址，必须是 wss 协议，且域名必须是后台配置的合法域名 |\n| header | UTSJSONObject | 是 | HTTP 请求 Header，header 中不能设置 Referer |\n| protocols | Array\\ | 是 | 子协议数组 |\n| success | ([ConnectSocketSuccess](#connectsocketsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (UniError) => void | 否 | 接口调用失败的回调函数 |\n| complete | (any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ConnectSocketSuccess @connectsocketsuccess \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n","returnValue":"### 返回值 \n\n| 类型 |\n| :- |\n| SocketTask | \n","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[connectSocket](https://uniapp.dcloud.net.cn/api/request/websocket.html#connectsocket)\n"},"onSocketOpen":{"name":"## uni.onSocketOpen(options) @onsocketopen","description":"监听WebSocket连接打开事件。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | ([OnSocketOpenCallbackResult](#onsocketopencallbackresult)) => void | 是 | - |\n#### OnSocketOpenCallbackResult @onsocketopencallbackresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| header | any | 是 | 连接成功的 HTTP 响应 Header |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[onSocketOpen](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketopen)\n"},"onSocketError":{"name":"## uni.onSocketError(callback) @onsocketerror","description":"下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | ([OnSocketErrorCallbackResult](#onsocketerrorcallbackresult)) => void | 是 | - |\n#### OnSocketErrorCallbackResult @onsocketerrorcallbackresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | 错误信息 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[onSocketError](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketerror)\n"},"sendSocketMessage":{"name":"## uni.sendSocketMessage(options) @sendsocketmessage","description":"通过 WebSocket 连接发送数据，需要先 uni.connectSocket，并在 uni.onSocketOpen 回调之后才能发送。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SendSocketMessageOptions](#sendsocketmessageoptions) | 是 | - |\n#### SendSocketMessageOptions @sendsocketmessageoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | any | 是 | 需要发送的内容 |\n| success | ([GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | ([GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用失败的回调函数 |\n| complete | ([GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[sendSocketMessage](https://uniapp.dcloud.net.cn/api/request/websocket.html#sendsocketmessage)\n"},"onSocketMessage":{"name":"## uni.onSocketMessage(callback) @onsocketmessage","description":"监听WebSocket接受到服务器的消息事件。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | ([OnSocketMessageCallbackResult](#onsocketmessagecallbackresult)) => void | 是 | - |\n#### OnSocketMessageCallbackResult @onsocketmessagecallbackresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | any | 是 | 服务器返回的消息 |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[onSocketMessage](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketmessage)\n"},"closeSocket":{"name":"## uni.closeSocket(options) @closesocket","description":"关闭 WebSocket 连接。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [CloseSocketOptions](#closesocketoptions) | 是 | - |\n#### CloseSocketOptions @closesocketoptions \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| code | number | 否 | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭） |\n| reason | string | 否 | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符） |\n| success | ([GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | ([GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用失败的回调函数 |\n| complete | ([GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[closeSocket](https://uniapp.dcloud.net.cn/api/request/websocket.html#closesocket)\n"},"onSocketClose":{"name":"## uni.onSocketClose(callback) @onsocketclose","description":"监听WebSocket关闭。","param":"### 参数 \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| callback | ([OnSocketCloseCallbackResult](#onsocketclosecallbackresult)) => void | 是 | - |\n#### OnSocketCloseCallbackResult @onsocketclosecallbackresult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| code | number | 是 | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。\t |\n| reason | string | 是 | 一个可读的字符串，表示连接被关闭的原因。\t |\n","returnValue":"","compatibility":"### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 4.4 | √ | 3.9.0 | 9.0 | √ | 3.9.0 |\n","tutorial":"\n### 参见\n[onSocketClose](https://uniapp.dcloud.net.cn/api/request/websocket.html#onsocketclose)\n"},"general_type":{"name":"## 通用类型\n","param":"### GeneralCallbackResult \n\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | 错误信息 |\n"}} \ No newline at end of file diff --git a/docs/.vuepress/utils/utsComJson.json b/docs/.vuepress/utils/utsComJson.json index 3c398b92c..b3f0948c6 100644 --- a/docs/.vuepress/utils/utsComJson.json +++ b/docs/.vuepress/utils/utsComJson.json @@ -1 +1 @@ -{"animation-view":{"name":"## animation-view","description":"Lottie 动画","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| path | String | - | 动画资源地址，目前只支持绝对路径 |\n| loop | Boolean | - | 动画是否循环播放 |\n| autoplay | Boolean | - | 动画是否自动播放 |\n| action | String | - | 动画操作，可取值 play、pause、stop [action](#action-values) |\n| hidden | Boolean | - | 是否隐藏动画 |\n| @ended | Any | - | - |\n\n#### action @action-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| play | 播放 |\n| pause | 暂停 |\n| stop | 停止 |\n","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/animation-view)\n- [插件市场](https://ext.dcloud.net.cn/plugin?id=10674)\n"},"button":{"name":"## button","description":"按钮","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| disabled | Boolean | false | 是否禁用 |\n| hover-class | ClassString | button-hover | 指定按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果 |\n| hover-start-time | Number | 20 | 按住后多久出现点击态，单位毫秒 |\n| hover-stay-time | Number | 70 | 手指松开后点击态保留时间，单位毫秒 |\n| size | String | default | 按钮的大小 [size](#size-values) |\n| type | String | default | 按钮的样式类型 [type](#type-values) |\n| plain | Boolean | false | 按钮是否镂空，背景色透明 |\n\n#### size @size-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| default | 默认大小 |\n| mini | 小尺寸 |\n\n\n#### type @type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| default | 白色 |\n| primary | 蓝色 |\n| warn | 红色 |\n","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/button)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/button/button.uvue)\n"},"checkbox":{"name":"## checkbox","description":"多选项目","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| disabled | Boolean | false | 是否禁用 |\n| value | String | - | checkbox 标识，选中时触发 checkbox-group 的 change 事件，并携带 checkbox 的 value |\n| checked | Boolean | false | 当前是否选中，可用来设置默认选中 |\n| color | ColorString | #007aff | checkbox的颜色 |\n| backgroundColor | ColorString | #ffffff | checkbox默认的背景颜色 |\n| borderColor | ColorString | #d1d1d1 | checkbox默认的边框颜色 |\n| activeBackgroundColor | ColorString | #ffffff | checkbox选中时的背景颜色 |\n| activeBorderColor | ColorString | #d1d1d1 | checkbox选中时的边框颜色 |\n| iconColor | ColorString | #007aff | checkbox的图标颜色，优先级大于color属性 |","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/checkbox)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/checkbox/checkbox.uvue)\n"},"checkbox-group":{"name":"## checkbox-group","description":"多项选择器，内部由多个checkbox组成","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| @change | (event: [CheckboxGroupChangeEvent](#CheckboxGroupChangeEvent)) => void | - | checkbox-group中选中项发生改变是触发 change 事件，detail = {value:\\[选中的checkbox的value的数组\\]} |","event":"\n### 事件\n#### CheckboxGroupChangeEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- CheckboxGroupChangeEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CheckboxGroupChangeEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/checkbox)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/checkbox-group/checkbox-group.uvue)\n"},"image":{"name":"## image","description":"图片","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| src | ImageURIString | - | 图片资源地址 |\n| mode | String | - | 图片裁剪、缩放的模式 [mode](#mode-values) |\n| fade-show | Boolean | - | 图片显示动画效果 |\n| @error | (event: [ImageErrorEvent](#ImageErrorEvent)) => void | - | 图片加载错误时触发，event.detail = { errMsg } |\n| @load | (event: [ImageLoadEvent](#ImageLoadEvent)) => void | - | 图片加载完成时触发，event.detail = { width: '图片宽度px', height: '图片高度px' } |\n\n#### mode @mode-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| scaleToFill | 不保持纵横比缩放图片，使图片的宽高完全拉伸至填满 image 元素 |\n| aspectFit | 保持纵横比缩放图片，使图片的长边能完全显示出来。也就是说，可以完整地将图片显示出来。 |\n| aspectFill | 保持纵横比缩放图片，只保证图片的短边能完全显示出来。也就是说，图片通常只在水平或垂直方向是完整的，另一个方向将会发生截取 |\n| widthFix | 宽度不变，高度自动变化，保持原图宽高比不变 |\n| heightFix | 高度不变，宽度自动变化，保持原图宽高比不变 |\n| top | 不缩放图片，只显示图片的顶部区域 |\n| bottom | 不缩放图片，只显示图片的底部区域 |\n| center | 不缩放图片，只显示图片的中间区域 |\n| left | 不缩放图片，只显示图片的左边区域 |\n| right | 不缩放图片，只显示图片的右边区域 |\n| top left | 不缩放图片，只显示图片的左上边区域 |\n| top rigth | 不缩放图片，只显示图片的右上边区域 |\n| bottom left | 不缩放图片，只显示图片的左下边区域 |\n| bottom right | 不缩放图片，只显示图片的右下边区域 |\n","event":"\n### 事件\n#### ImageErrorEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ImageErrorEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { errMsg: string; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ImageLoadEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ImageLoadEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { width: number; height: number; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| image | 5.0 | √ | 3.9.0 | 9.0 | √ | - |\n| src | 5.0 | √ | 3.9+ | 9.0 | x | x |\n| fade-show | 5.0 | √ | 3.9+ | 9.0 | x | x |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/image)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/image/image.uvue)\n"},"input":{"name":"## input","description":"输入框","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| disabled | Boolean | - | 是否禁用 |\n| value | String | - | 输入框的初始内容 |\n| type | String | - | input的类型 [type](#type-values) |\n| password | Boolean | - | 是否是密码类型 |\n| placeholder | String | - | 输入框为空时占位符 |\n| placeholder-style | String | - | 指定 placeholder 的样式 |\n| placeholder-class | String | - | 指定 placeholder 的样式类 |\n| maxlength | Number | - | 最大输入长度，设置为 -1 的时候不限制最大长度 |\n| cursor-spacing | Number | - | 指定光标与键盘的距离，单位 px 。取 input 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离 |\n| auto-focus | Boolean | - | 自动获取焦点 |\n| focus | Boolean | - | 获取焦点 |\n| confirm-type | String | - | 设置键盘右下角按钮的文字 [confirm-type](#confirm-type-values) |\n| always-embed | Boolean | - | 强制 input 处于同层状态，默认 focus 时 input 会切到非同层状态 (仅在 iOS 下生效) |\n| confirm-hold | Boolean | - | 点击键盘右下角按钮时是否保持键盘不收起 |\n| cursor | Number | - | 指定focus时的光标位置 |\n| selection-start | Number | - | 光标起始位置，自动聚集时有效，需与selection-end搭配使用 |\n| selection-end | Number | - | 光标结束位置，自动聚集时有效，需与selection-satrt搭配使用 |\n| adjust-position | Boolean | - | 键盘弹起时，是否自动上推页面 |\n| text-content-type | String | - | 文本区域的语义，根据类型自动填充 [text-content-type](#text-content-type-values) |\n| hold-keyboard | Boolean | - | focus时，点击页面的时候不收起键盘 |\n| safe-password-cert-path | String | - | 安全键盘加密公钥的路径，只支持包内路径 |\n| safe-password-length | Number | - | 安全键盘输入密码长度 |\n| safe-password-time-stamp | Number | - | 安全键盘加密时间戳 |\n| safe-password-nonce | String | - | 安全键盘加密盐值 |\n| safe-password-salt | String | - | 安全键盘计算 hash 盐值，若指定custom-hash 则无效 |\n| safe-password-custom-hash | String | - | 安全键盘计算 hash 的算法表达式 |\n| random-number | Boolean | - | 当 type 为 number, digit, idcard 数字键盘是否随机排列 |\n| controlled | Boolean | - | 是否为受控组件。为 true 时，value 内容会完全受 setData 控制 |\n| always-system | Boolean | - | 是否强制使用系统键盘和 Web-view 创建的 input 元素。为 true 时，confirm-type、confirm-hold 可能失效 |\n| inputmode | String | - | 是一个枚举属性，它提供了用户在编辑元素或其内容时可能输入的数据类型的提示。在符合条件的高版本webview里，uni-app的 web 和 app-vue 平台中可使用本属性。 [inputmode](#inputmode-values) |\n| @input | (event: [Event](#Event)) => void | - | 当键盘输入时，触发input事件，event.detail = {value, cursor}，处理函数可以直接 return 一个字符串，将替换输入框的内容。 |\n| @focus | (event: [Event](#Event)) => void | - | 输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度，在基础库 1.9.90 起支持 |\n| @blur | (event: [Event](#Event)) => void | - | 输入框失去焦点时触发，event.detail = {value: value} |\n| @keyboardheightchange | (event: [Event](#Event)) => void | - | 键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration} |\n| @confirm | (event: [Event](#Event)) => void | - | 点击完成按钮时触发，event.detail = {value: value} |\n\n#### type @type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| text | 文本输入键盘 |\n| number | 数字输入键盘 |\n| idcard | 身份证输入键盘 |\n| digit | 带小数点数字输入键盘 |\n| safe-password | 密码安全输入键盘 |\n| nickname | 昵称输入键盘 |\n\n\n#### confirm-type @confirm-type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| send | 发送 |\n| search | 搜索 |\n| next | 下一个 |\n| go | 前往 |\n| done | 完成 |\n\n\n#### text-content-type @text-content-type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| oneTimeCode | 一次性验证码 |\n\n\n#### inputmode @inputmode-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| none | 无虚拟键盘。在应用程序或者站点需要实现自己的键盘输入控件时很有用。 |\n| text | 使用用户本地区域设置的标准文本输入键盘。 |\n| decimal | 小数输入键盘，包含数字和分隔符（通常是“ . ”或者“ , ”），设备可能也可能不显示减号键。 |\n| numeric | 数字输入键盘，所需要的就是 0 到 9 的数字，设备可能也可能不显示减号键。 |\n| tel | 电话输入键盘，包含 0 到 9 的数字、星号（*）和井号（#）键。表单输入里面的电话输入通常应该使用 \\\\ 。 |\n| search | 为搜索输入优化的虚拟键盘，比如，返回键可能被重新标记为“搜索”，也可能还有其他的优化。 |\n| email | 为邮件地址输入优化的虚拟键盘，通常包含\"@\"符号和其他优化。表单里面的邮件地址输入应该使用 \\\\ 。 |\n| url | 为网址输入优化的虚拟键盘，比如，“/”键会更加明显、历史记录访问等。表单里面的网址输入通常应该使用 \\\\ 。 |\n","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/input)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/input/input.uvue)\n"},"list-item":{"name":"## list-item","description":"列表组件","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| type | Number | - | 对应list-item的类型 List 将对同类型条目进行复用，所以合理的类型拆分，可以很好地提升 List 性能 |","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/list-view#list-item)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/list-item/list-item.uvue)\n"},"list-view":{"name":"## list-view","description":"列表组件","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| scroll-x | Boolean | false | 允许横向滚动，不支持同时设置scroll-y属性 |\n| scroll-y | Boolean | true | 允许纵向滚动，不支持同时设置scroll-x属性 |\n| rebound | Boolean | true | 控制是否回弹效果 |\n| upper-threshold | Number | 50 | 距顶部/左边多远时（单位px），触发 scrolltoupper 事件 |\n| lower-threshold | Number | 50 | 距底部/右边多远时（单位px），触发 scrolltolower 事件 |\n| scroll-top | Number | - | 设置竖向滚动条位置 |\n| scroll-left | Number | - | 设置横向滚动条位置 |\n| show-scrollbar | Boolean | true | 控制是否出现滚动条 |\n| scroll-into-view | String | - | 值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素 |\n| scroll-with-animation | Boolean | false | 是否在设置滚动条位置时使用滚动动画，设置false没有滚动动画 |\n| refresher-enabled | Boolean | false | 开启自定义下拉刷新，暂时不支持scroll-x = true横向刷新 |\n| refresher-threshold | Number | false | 设置自定义下拉刷新阈值 |\n| refresher-default-style | String | black | 设置自定义下拉刷新默认样式，支持设置 black，white，none，none 表示不使用默认样式 |\n| refresher-background | String | #FFF | 设置自定义下拉刷新区域背景颜色 |\n| refresher-triggered | Boolean | false | 设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发 |\n| @refresherpulling | (event: [RefresherEvent](#RefresherEvent)) => void | - | 自定义下拉刷新控件被下拉 |\n| @refresherrefresh | (event: [RefresherEvent](#RefresherEvent)) => void | - | 自定义下拉刷新被触发 |\n| @refresherrestore | (event: [RefresherEvent](#RefresherEvent)) => void | - | 自定义下拉刷新被复位 |\n| @refresherabort | (event: [RefresherEvent](#RefresherEvent)) => void | - | 自定义下拉刷新被中止 |\n| @scrolltoupper | (event: [ScrollToUpperEvent](#ScrollToUpperEvent)) => void | - | 滚动到顶部/左边，会触发 scrolltoupper 事件 |\n| @scrolltolower | (event: [ScrollToLowerEvent](#ScrollToLowerEvent)) => void | - | 滚动到底部/右边，会触发 scrolltolower 事件 |\n| @scroll | (event: [ScrollEvent](#ScrollEvent)) => void | - | 滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY} |","event":"\n### 事件\n#### RefresherEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- RefresherEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { dy: number; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollToUpperEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToUpperEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { direction: string; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollToLowerEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToLowerEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { direction: string; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { scrollTop: number; scrollLeft: number; scrollHeight: number; scrollWidth: number; deltaY: number; deltaX: number; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| @refresherpulling | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherrefresh | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherrestore | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherabort | 5.0 | √ | 3.9+ | - | - | - |\n| @scrolltoupper | 5.0 | √ | 3.9+ | - | - | - |\n| @scrolltolower | 5.0 | √ | 3.9+ | - | - | - |\n| @scroll | 5.0 | √ | 3.9+ | - | - | - |\n","reference":"\n### 参见\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/list-view/list-view.uvue)\n"},"navigator":{"name":"## navigator","description":"页面链接","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| target | String | - | 在哪个目标上发生跳转，默认当前应用 |\n| url | String\\|PageURIString | - | 当前应用内的跳转链接 |\n| open-type | String | - | 跳转方式 [open-type](#open-type-values) |\n| delta | Number | - | 当 open-type 为 navigateBack 时有效，表示回退的层数 |\n| app-id | String | - | 当target=\"miniProgram\"时有效，要打开的小程序 appId |\n| path | String | - | 当target=\"miniProgram\"时有效，打开的页面路径，如果为空则打开首页 |\n| extra-data | Object | - | 当target=\"miniProgram\"时有效，需要传递给目标应用的数据，目标应用可在 App.onLaunch()，App.onShow() 中获取到这份数据 |\n| version | String | - | 当target=\"miniProgram\"时有效，要打开的小程序版本，有效值 develop（开发版），trial（体验版），release（正式版），仅在当前小程序为开发版或体验版时此参数有效；如果当前小程序是体验版或正式版，则打开的小程序必定是正式版 |\n| animation-type | String | - | 当 open-type=\"navigateTo\" 或 open-type=\"navigateBack\" 时有效，窗口的显示/关闭的动画类型。 [animation-type](#animation-type-values) |\n| animation-duration | Number | - | 当 open-type=\"navigateTo\" 或 open-type=\"navigateBack\" 时有效，窗口的显示/关闭动画的持续时间。 |\n| hover-class | String | - | 指定按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果 |\n| hover-stop-propagation | Boolean | - | 指定是否阻止本节点的祖先节点出现点击态 |\n| hover-start-time | Number | - | 按住后多久出现点击态，单位毫秒 |\n| hover-stay-time | Number | - | 手指松开后点击态保留时间，单位毫秒 |\n\n#### open-type @open-type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| navigate | 对应 wx.navigateTo 或 wx.navigateToMiniProgram 的功能 |\n| redirect | 对应 wx.redirectTo 的功能 |\n| switchTab | 对应 wx.switchTab 的功能 |\n| reLaunch | 对应 wx.reLaunch 的功能 |\n| navigateBack | 对应 wx.navigateBack 的功能 |\n\n\n#### animation-type @animation-type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| auto | 自动选择动画效果 |\n| none | 无动画效果 |\n| slide-in-right | 从右侧横向滑动效果 |\n| slide-in-left | 左侧横向滑动效果 |\n| slide-in-top | 从上侧竖向滑动效果 |\n| slide-in-bottom | 从下侧竖向滑动效果 |\n| fade-in | 从透明到不透明逐渐显示效果 |\n| zoom-out | 从小到大逐渐放大显示效果 |\n| zoom-fade-out | 从小到大逐渐放大并且从透明到不透明逐渐显示效果 |\n| pop-in | 从右侧平移入栈动画效果 |\n| slide-out-right | 横向向右侧滑出屏幕动画 |\n| slide-out-left | 横向向左侧滑出屏幕动画 |\n| slide-out-top | 竖向向上侧滑出屏幕动画 |\n| slide-out-bottom | 竖向向下侧滑出屏幕动画 |\n| fade-out | 从不透明到透明逐渐隐藏动画 |\n| zoom-in | 从大逐渐缩小关闭动画 |\n| zoom-fade-in | 从大逐渐缩小并且从不透明到透明逐渐隐藏关闭动画 |\n| pop-out | 从右侧平移出栈动画效果 |\n","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/navigator)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/navigator/navigator.uvue)\n"},"picker-view-column":{"name":"## picker-view-column","description":"仅可放置于 picker-view 中，其子节点未继承 picker-view 的选中框的高度，需要自己设置高度并居中","attrubute":"","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.net.cn/component/picker-view.html#picker-view-column)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/picker-view-column/picker-view-column.uvue)\n"},"picker-view":{"name":"## picker-view","description":"嵌入页面的滚动选择器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | - | picker-view-column 选择的第几项 |\n| indicator-style | CSSString | - | 设置选择器中间选中框的样式 |\n| mask-top-style | CSSString | - | 设置蒙层上半部分的样式 |\n| mask-bottom-style | CSSString | - | 设置蒙层下半部分的样式 |\n| @change | (event: [PickerViewChangeEvent](#PickerViewChangeEvent)) => void | - | 当滚动选择，value 改变时触发 change 事件，event.detail = {value: value}；value为数组，表示 picker-view 内的 picker-view-column 当前选择的是第几项（下标从 0 \t\t开始） |","event":"\n### 事件\n#### PickerViewChangeEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- PickerViewChangeEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### PickerViewChangeEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/picker-view)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/picker-view/picker-view.uvue)\n"},"progress":{"name":"## progress","description":"进度条","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| duration | Number | 30 | 进度增加1%所需毫秒数 |\n| percent | Number | 0 | 百分比0~100 |\n| show-info | Boolean | false | 在进度条右侧显示百分比 |\n| border-radius | Number | 0 | 圆角大小 |\n| font-size | Number | 16 | 右侧百分比字体大小 |\n| stroke-width | Number | 6 | 进度条线的宽度，单位px |\n| color | ColorString | - | 进度条颜色 （请使用 activeColor） |\n| activeColor | ColorString | #09BB07 | 已选择的进度条的颜色 |\n| backgroundColor | ColorString | #EBEBEB | 未选择的进度条的颜色 |\n| active | Boolean | false | 进度条从左往右的动画 |\n| active-mode | String | backwards | backwards: 动画从头播；forwards：动画从上次结束点接着播 [active-mode](#active-mode-values) |\n| @activeend | (event: [ProgressActiveendEvent](#ProgressActiveendEvent)) => void | - | 动画完成事件 |\n\n#### active-mode @active-mode-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| backwards | 动画从头播 |\n| forwards | 动画从上次结束点接着播 |\n","event":"\n### 事件\n#### ProgressActiveendEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- ProgressActiveendEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | number | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ProgressActiveendEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | number | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| curPercent | number | 是 | - |\n","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/progress)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/progress/progress.uvue)\n"},"radio":{"name":"## radio","description":"单选项目","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| disabled | Boolean | false | 是否禁用 |\n| value | String | - | \\ 标识。当该radio 选中时，radio-group的 change 事件会携带radio的value |\n| checked | Boolean | false | \\ 当前是否选中 |\n| color | ColorString | #007AFF | radio的颜色 |\n| backgroundColor | ColorString | #ffffff | radio默认的背景颜色 |\n| borderColor | ColorString | #d1d1d1 | radio默认的边框颜色 |\n| activeBackgroundColor | ColorString | #007AFF | radio选中时的背景颜色，优先级大于color属性 |\n| activeBorderColor | ColorString | | radio选中时的边框颜色 |\n| iconColor | ColorString | #ffffff | radio的图标颜色 |\n| @click | (event: [MouseEvent](#MouseEvent)) => void | - | 组件被点击时触发 |","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/radio)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/radio/radio.uvue)\n"},"radio-group":{"name":"## radio-group","description":"单项选择器，内部由多个 radio 组成","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| @change | (event: [RadioGroupChangeEvent](#RadioGroupChangeEvent)) => void | - | radio-group 中的选中项发生变化时触发 change 事件，event.detail = {value: 选中项radio的value} |","event":"\n### 事件\n#### RadioGroupChangeEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- RadioGroupChangeEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | string | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### RadioGroupChangeEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | string | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | string | 是 | - |\n","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/radio)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/radio-group/radio-group.uvue)\n"},"rich-text":{"name":"## rich-text","description":"富文本","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| nodes | Array | - | 节点列表 |\n| @itemclick | (event: [RichTextItemClickEvent](#RichTextItemClickEvent)) => void | - | 拦截点击事件（只支持 a、img标签），返回用户自定义数据或img标签的src属性或a标签的href属性。event.detail={ ref \\| src \\| href } |","event":"\n### 事件\n#### RichTextItemClickEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- RichTextItemClickEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { ref: string; src: string; href: string; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| rich-text | 5.0 | √ | 3.9.0 | 9.0 | √ | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/rich-text)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/rich-text/rich-text.uvue)\n"},"scroll-view":{"name":"## scroll-view","description":"可滚动视图区域","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| scroll-x | Boolean | false | 允许横向滚动，不支持同时设置scroll-y属性 |\n| scroll-y | Boolean | true | 允许纵向滚动，不支持同时设置scroll-x属性 |\n| rebound | Boolean | true | 控制是否回弹效果 |\n| upper-threshold | Number | 50 | 距顶部/左边多远时（单位px），触发 scrolltoupper 事件 |\n| lower-threshold | Number | 50 | 距底部/右边多远时（单位px），触发 scrolltolower 事件 |\n| scroll-top | Number | - | 设置竖向滚动条位置 |\n| scroll-left | Number | - | 设置横向滚动条位置 |\n| scroll-into-view | String | - | 值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素 |\n| scroll-with-animation | Boolean | false | 是否在设置滚动条位置时使用滚动动画，设置false没有滚动动画 |\n| refresher-enabled | Boolean | false | 开启自定义下拉刷新，暂时不支持scroll-x = true横向刷新 |\n| refresher-threshold | Number | 45 | 设置自定义下拉刷新阈值 |\n| refresher-default-style | String | black | 设置自定义下拉刷新默认样式，支持设置 black \\| white \\| none， none 表示不使用默认样式 |\n| refresher-background | String | #FFF | 设置自定义下拉刷新区域背景颜色 |\n| refresher-triggered | Boolean | false | 设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发 |\n| show-scrollbar | Boolean | true | 控制是否出现滚动条 |\n| @refresherpulling | (event: [RefresherEvent](#RefresherEvent)) => void | - | 自定义下拉刷新控件被下拉 |\n| @refresherrefresh | (event: [RefresherEvent](#RefresherEvent)) => void | - | 自定义下拉刷新被触发 |\n| @refresherrestore | (event: [RefresherEvent](#RefresherEvent)) => void | - | 自定义下拉刷新被复位 |\n| @refresherabort | (event: [RefresherEvent](#RefresherEvent)) => void | - | 自定义下拉刷新被中止 |\n| @scrolltoupper | (event: [ScrollToUpperEvent](#ScrollToUpperEvent)) => void | - | 滚动到顶部/左边，会触发 scrolltoupper 事件 |\n| @scrolltolower | (event: [ScrollToLowerEvent](#ScrollToLowerEvent)) => void | - | 滚动到底部/右边，会触发 scrolltolower 事件 |\n| @scroll | (event: [ScrollEvent](#ScrollEvent)) => void | - | 滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY} |","event":"\n### 事件\n#### RefresherEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- RefresherEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { dy: number; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollToUpperEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToUpperEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { direction: string; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollToLowerEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToLowerEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { direction: string; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { scrollTop: number; scrollLeft: number; scrollHeight: number; scrollWidth: number; deltaY: number; deltaX: number; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| @refresherpulling | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherrefresh | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherrestore | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherabort | 5.0 | √ | 3.9+ | - | - | - |\n| @scrolltoupper | 5.0 | √ | 3.9+ | - | - | - |\n| @scrolltolower | 5.0 | √ | 3.9+ | - | - | - |\n| @scroll | 5.0 | √ | 3.9+ | - | - | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/scroll-view)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/scroll-view/scroll-view.uvue)\n"},"slider":{"name":"## slider","description":"滑动选择器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| disabled | Boolean | - | 是否禁用 |\n| min | Number | 0 | slider 最小值 |\n| max | Number | 100 | slider 最大值 |\n| step | Number | 1 | slider 步长，取值必须大于 0，并且可被(max - min)整除 |\n| value | Number | 0 | radio当前取值 |\n| color | ColorString | - | slider 背景条的颜色（请使用 backgroundColor） |\n| activeColor | ColorString | #007aff | slider 滑块左侧已选择部分的线条颜色 |\n| backgroundColor | ColorString | #e9e9e9 | radio背景条的颜色 |\n| block-size | Number | 28 | radio滑块的大小，取值范围为 12 - 28 |\n| block-color | ColorString | #ffffff | 滑块颜色 |\n| show-value | Boolean | false | 是否显示当前 value |\n| @change | (event: [SliderChangeEvent](#SliderChangeEvent)) => void | - | 完成一次拖动后触发的事件，event.detail = {value: value} |\n| @changing | (event: [SliderChangeEvent](#SliderChangeEvent)) => void | - | 拖动过程中触发的事件，event.detail = {value: value} |","event":"\n### 事件\n#### SliderChangeEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- SliderChangeEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | number | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### SliderChangeEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | number | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | number | 是 | - |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| @change | 5.0 | √ | 3.9+ | - | - | - |\n| @changing | 5.0 | √ | 3.9+ | - | - | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/slider)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/slider/slider.uvue)\n"},"swiper-item":{"name":"## swiper-item","description":"仅可放置在 swiper 组件中，宽高自动设置为100%","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| item-id | String | - | 该 swiper-item 的标识符 |","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.net.cn/component/swiper.html#swiper-item)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/swiper-item/swiper-item.uvue)\n"},"swiper":{"name":"## swiper","description":"滑块视图容器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| indicator-dots | Boolean | - | 是否显示面板指示点 |\n| indicator-color | HexColor | - | 指示点颜色 |\n| indicator-active-color | HexColor | - | 当前选中的指示点颜色 |\n| active-class | String | - | swiper-item 可见时的 class |\n| changing-class | Boolean | - | acceleration 设置为 {{true}} 时且处于滑动过程中，中间若干屏处于可见时的class |\n| acceleration | Boolean | - | 当开启时，会根据滑动速度，连续滑动多屏 |\n| disable-programmatic-animation | Boolean | - | 是否禁用代码变动触发 swiper 切换时使用动画。 |\n| disable-touch | Boolean | - | 是否禁止用户 touch 操作 |\n| touchable | Boolean | - | 是否监听用户的触摸事件 |\n| easing-function | String | - | 指定 swiper 切换缓动动画类型，有效值：default、linear、easeInCubic、easeOutCubic、easeInOutCubic [easing-function](#easing-function-values) |\n| autoplay | Boolean | - | 是否自动切换 |\n| current | Number | - | 当前所在滑块的 index |\n| current-item-id | String | - | 当前所在滑块的 item-id ，不能与 current 被同时指定 |\n| interval | Number | - | 自动切换时间间隔 |\n| duration | Number | - | 滑动动画时长 |\n| circular | Boolean | - | 是否采用衔接滑动 |\n| vertical | Boolean | - | 滑动方向是否为纵向 |\n| previous-margin | String | - | 前边距，可用于露出前一项的一小部分，接受 px 和 rpx 值 |\n| next-margin | String | - | 后边距，可用于露出后一项的一小部分，接受 px 和 rpx 值 |\n| display-multiple-items | Number | - | 同时显示的滑块数量 |\n| skip-hidden-item-layout | Boolean | - | 是否跳过未显示的滑块布局，设为 true 可优化复杂情况下的滑动性能，但会丢失隐藏状态滑块的布局信息 |\n| @change | (event: [Event](#Event)) => void | - | current 改变时会触发 change 事件，event.detail = {current: current, source: source} |\n| @transition | (event: [Event](#Event)) => void | - | swiper-item 的位置发生改变时会触发 transition 事件，event.detail = {dx: dx, dy: dy} |\n| @animationfinish | (event: [Event](#Event)) => void | - | 动画结束时会触发 animationfinish 事件，event.detail = {current: current, source: source} |\n\n#### easing-function @easing-function-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| default | - |\n| linear | - |\n| easeInCubic | - |\n| easeOutCubic | - |\n| easeInOutCubic | - |\n","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/swiper)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/swiper/swiper.uvue)\n"},"switch":{"name":"## switch","description":"开关选择器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| checked | Boolean | - | 是否选中 |\n| type | String | - | 样式，有效值：switch, checkbox [type](#type-values) |\n| color | ColorString | - | switch 的颜色，同 css 的 color |\n| disabled | Boolean | - | 是否禁用 |\n| @change | (event: [SwitchChangeEvent](#SwitchChangeEvent)) => void | - | checked 改变时触发 change 事件，event.detail={ value:checked} |\n\n#### type @type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| switch | - |\n| checkbox | - |\n","event":"\n### 事件\n#### SwitchChangeEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- SwitchChangeEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | boolean | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### SwitchChangeEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | boolean | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | boolean | 是 | - |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| @change | 5.0 | √ | 3.9+ | - | - | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/switch)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/switch/switch.uvue)\n"},"text":{"name":"## text","description":"文本","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| selectable | Boolean | - | 文本是否可选 |\n| space | String | - | 显示连续空格 [space](#space-values) |\n| decode | Boolean | - | 是否解码 |\n\n#### space @space-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| ensp | 中文字符空格一半大小 |\n| emsp | 中文字符空格大小 |\n| nbsp | 根据字体设置的空格大小 |\n","event":"","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| text | 5.0 | √ | 3.9.0 | 9.0 | √ | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/text)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/text/text.uvue)\n"},"textarea":{"name":"## textarea","description":"多行输入框","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| display | Any | - | - |\n| value | String | - | 输入框的初始内容 |\n| placeholder | String | - | 输入框为空时占位符 |\n| placeholder-style | String | - | 指定 placeholder 的样式 |\n| placeholder-class | String | - | 指定 placeholder 的样式类 |\n| maxlength | Number | - | 最大输入长度，设置为 -1 的时候不限制最大长度 |\n| auto-focus | Boolean | - | 自动获取焦点 |\n| focus | Boolean | - | 获取焦点 |\n| cursor | Number | - | 指定focus时的光标位置 |\n| confirm-type | String | - | 设置键盘右下角按钮的文字 [confirm-type](#confirm-type-values) |\n| confirm-hold | Boolean | - | 点击键盘右下角按钮时是否保持键盘不收起 |\n| auto-height | Boolean | - | 是否自动增高，设置auto-height时，style.height不生效 |\n| fixed | Boolean | - | 如果 textarea 是在一个 position:fixed 的区域，需要显示指定属性 fixed 为 true |\n| cursor-spacing | Number | - | 指定光标与键盘的距离，单位 px 。取 textarea 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离 |\n| show-confirm-bar | Boolean | - | 是否显示键盘上方带有”完成“按钮那一栏 |\n| selection-start | Number | - | 光标起始位置，自动聚集时有效，需与selection-end搭配使用 |\n| selection-end | Number | - | 光标结束位置，自动聚集时有效，需与selection-satrt搭配使用 |\n| adjust-position | Boolean | - | 键盘弹起时，是否自动上推页面 |\n| inputmode | String | - | 是一个枚举属性，它提供了用户在编辑元素或其内容时可能输入的数据类型的提示。在符合条件的高版本webview里，uni-app的 web 和 app-vue 平台中可使用本属性。 [inputmode](#inputmode-values) |\n| @confirm | (event: [Event](#Event)) => void | - | 点击完成时， 触发 confirm 事件，event.detail = {value: value} |\n| @input | (event: [Event](#Event)) => void | - | 当键盘输入时，触发 input 事件，event.detail = {value, cursor}， @input 处理函数的返回值并不会反映到 textarea 上 |\n| @linechange | (event: [Event](#Event)) => void | - | 输入框行数变化时调用，event.detail = {height: 0, heightRpx: 0, lineCount: 0} |\n| @blur | (event: [Event](#Event)) => void | - | 输入框失去焦点时触发，event.detail = {value, cursor} |\n| @keyboardheightchange | (event: [Event](#Event)) => void | - | 键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration} |\n| @focus | (event: [Event](#Event)) => void | - | 输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度，在基础库 1.9.90 起支持 |\n\n#### confirm-type @confirm-type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| send | 发送 |\n| search | 搜索 |\n| next | 下一个 |\n| go | 前往 |\n| done | 完成 |\n\n\n#### inputmode @inputmode-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| none | 无虚拟键盘。在应用程序或者站点需要实现自己的键盘输入控件时很有用。 |\n| text | 使用用户本地区域设置的标准文本输入键盘。 |\n| decimal | 小数输入键盘，包含数字和分隔符（通常是“ . ”或者“ , ”），设备可能也可能不显示减号键。 |\n| numeric | 数字输入键盘，所需要的就是 0 到 9 的数字，设备可能也可能不显示减号键。 |\n| tel | 电话输入键盘，包含 0 到 9 的数字、星号（*）和井号（#）键。表单输入里面的电话输入通常应该使用 \\\\ 。 |\n| search | 为搜索输入优化的虚拟键盘，比如，返回键可能被重新标记为“搜索”，也可能还有其他的优化。 |\n| email | 为邮件地址输入优化的虚拟键盘，通常包含\"@\"符号和其他优化。表单里面的邮件地址输入应该使用 \\\\ 。 |\n| url | 为网址输入优化的虚拟键盘，比如，“/”键会更加明显、历史记录访问等。表单里面的网址输入通常应该使用 \\\\ 。 |\n","event":"","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| @confirm | 5.0 | √ | 3.9+ | - | - | - |\n| @input | 5.0 | √ | 3.9+ | - | - | - |\n| @linechange | 5.0 | √ | 3.9+ | - | - | - |\n| @blur | 5.0 | √ | 3.9+ | - | - | - |\n| @keyboardheightchange | 5.0 | √ | 3.9+ | - | - | - |\n| @focus | 5.0 | √ | 3.9+ | - | - | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/textarea)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/textarea/textarea.uvue)\n"},"video":{"name":"## video","description":"视频","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| loop | Boolean | - | 是否循环播放 |\n| src | String\\|TagVideoURIString | - | 视频资源地址 |\n| initial-time | Number | - | 指定视频初始播放位置 |\n| duration | Number | - | 指定视频长度 |\n| controls | Boolean | - | 是否显示默认播放控件（播放/暂停按钮、播放进度、时间） |\n| danmu-list | Array | - | 弹幕列表 |\n| danmu-btn | Boolean | - | 是否显示弹幕按钮，只在初始化时有效，不能动态变更 |\n| enable-danmu | Boolean | - | 是否展示弹幕，只在初始化时有效，不能动态变更 |\n| autoplay | Boolean | - | 是否自动播放 |\n| muted | Boolean | - | 是否静音播放 |\n| page-gesture | Boolean | - | 在非全屏模式下，是否开启亮度与音量调节手势 |\n| direction | Number | - | 设置全屏时视频的方向，不指定则根据宽高比自动判断。有效值为 0（正常竖向）, 90（屏幕逆时针90度）, -90（屏幕顺时针90度） |\n| show-progress | Boolean | - | 若不设置，宽度大于240时才会显示 |\n| show-fullscreen-btn | Boolean | - | 是否显示全屏按钮 |\n| show-play-btn | Boolean | - | 是否显示视频底部控制栏的播放按钮 |\n| show-center-play-btn | Boolean | - | 是否显示视频中间的播放按钮 |\n| enable-progress-gesture | Boolean | - | 是否开启控制进度的手势 |\n| objectFit | String | - | 当视频大小与 video 容器大小不一致时，视频的表现形式。 [objectFit](#objectFit-values) |\n| poster | String | - | 视频封面的图片网络资源地址，如果 controls 属性值为 false 则设置 poster 无效 |\n| show-mute-btn | Boolean | - | 是否显示静音按钮 |\n| title | String | - | 视频的标题，全屏时在顶部展示 |\n| play-btn-position | String | - | 播放按钮的位置 |\n| enable-play-gesture | Boolean | - | 是否开启播放手势，即双击切换播放、暂停 |\n| auto-pause-if-navigate | Boolean | - | 当跳转到其它小程序页面时，是否自动暂停本页面的视频 |\n| auto-pause-if-open-native | Boolean | - | 当跳转到其它微信原生页面时，是否自动暂停本页面的视频 |\n| vslide-gesture | Boolean | - | 在非全屏模式下，是否开启亮度与音量调节手势（同 page-gesture） |\n| vslide-gesture-in-fullscreen | Boolean | - | 在全屏模式下，是否开启亮度与音量调节手势 |\n| ad-unit-id | String | - | 视频前贴广告单元ID |\n| poster-for-crawler | String | - | 用于给搜索等场景作为视频封面展示，建议使用无播放 icon 的视频封面图，只支持网络地址 |\n| codec | String | - | 解码器选择 |\n| http-cache | Boolean | - | 是否对 http、https 视频源开启本地缓存 |\n| play-strategy | Number | - | 播放策略 |\n| is-live | Boolean | - | 是否为直播源 |\n| @play | (event: [Event](#Event)) => void | - | 当开始/继续播放时触发play事件 |\n| @pause | (event: [Event](#Event)) => void | - | 当暂停播放时，触发pause事件 |\n| @ended | (event: [Event](#Event)) => void | - | 当播放到视频末尾时触发ended事件 |\n| @timeupdate | (event: [Event](#Event)) => void | - | 播放进度变化时触发，event.detail = {currentTime, duration} 。触发频率 250ms 一次 |\n| @fullscreenchange | (event: [Event](#Event)) => void | - | 当视频进入和退出全屏是触发，event.detail = {fullScreen, direction}，direction取为 vertical 或 horizontal |\n| @waiting | (event: [Event](#Event)) => void | - | 视频出现缓冲时触发 |\n| @error | (event: [Event](#Event)) => void | - | 播放出错试触发事件 |\n| @progress | (event: [Event](#Event)) => void | - | 加载进度变化时触发，只支持一段加载。event.detail = {buffered}，百分比 |\n| @loadedmetadata | (event: [Event](#Event)) => void | - | 视频元数据加载完成时触发。event.detail = {width, height, duration} |\n\n#### objectFit @objectFit-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| contain | 包含 |\n| fill | 填充 |\n| cover | 覆盖 |\n","event":"","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| video | 5.0 | √ | 3.9.0 | 9.0 | √ | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/video)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/video/video.uvue)\n"},"view":{"name":"## view","description":"基本视图容器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| hover-class | String | - | 指定按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果 |\n| hover-stop-propagation | Boolean | - | 指定是否阻止本节点的祖先节点出现点击态 |\n| hover-start-time | Number | - | 按住后多久出现点击态，单位毫秒 |\n| hover-stay-time | Number | - | 手指松开后点击态保留时间，单位毫秒 |","event":"","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| view | 5.0 | √ | √ | - | - | - |\n| hover-class | 4.4 | √ | √ | - | - | - |\n| hover-stop-propagation | 4.4 | √ | √ | - | - | - |\n| hover-start-time | 4.4 | √ | √ | - | - | - |\n| hover-stay-time | 4.4 | √ | √ | - | - | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/view)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/view/view.uvue)\n"},"web-view":{"name":"## web-view","description":"承载网页的容器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| src | String\\|URIString | - | webview 指向网页的链接 |\n| webview-styles | Object\\|Boolean | - | webview 的样式 |\n| @message | (event: [WebViewMessageEvent](#WebViewMessageEvent)) => void | - | 网页向应用 postMessage 时触发。e.detail = { data } |\n| @error | (event: [WebViewErrorEvent](#WebViewErrorEvent)) => void | - | 网页加载错误时触发。e.detail = { errMsg } |\n| @loaded | (event: [WebViewLoadedEvent](#WebViewLoadedEvent)) => void | - | 网页加载完成后触发。 |\n| @loading | (event: [WebViewLoadingEvent](#WebViewLoadingEvent)) => void | - | 网页加载中触发。 |","event":"\n### 事件\n#### WebViewMessageEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- WebViewMessageEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { data: any; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### WebViewErrorEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- WebViewErrorEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | { errMsg: string; } | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### WebViewLoadedEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- WebViewLoadedEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### WebViewLoadingEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- WebViewLoadingEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | 事件类型 |\n| target | INode | 是 | |\n| currentTarget | INode | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| web-view | 5.0 | √ | 3.9.0 | 9.0 | √ | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/web-view)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/web-view/web-view.uvue)\n"}} \ No newline at end of file +{"animation-view":{"name":"## animation-view","description":"Lottie 动画","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| path | String | - | 动画资源地址，目前只支持绝对路径 |\n| loop | Boolean | - | 动画是否循环播放 |\n| autoplay | Boolean | - | 动画是否自动播放 |\n| action | String | - | 动画操作，可取值 play、pause、stop [action](#action-values) |\n| hidden | Boolean | - | 是否隐藏动画 |\n| @ended | Any | - | - |\n\n#### action @action-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| play | 播放 |\n| pause | 暂停 |\n| stop | 停止 |\n","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/animation-view)\n- [插件市场](https://ext.dcloud.net.cn/plugin?id=10674)\n"},"button":{"name":"## button","description":"按钮","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| disabled | Boolean | false | 是否禁用 |\n| hover-class | ClassString | button-hover | 指定按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果 |\n| hover-start-time | Number | 20 | 按住后多久出现点击态，单位毫秒 |\n| hover-stay-time | Number | 70 | 手指松开后点击态保留时间，单位毫秒 |\n| size | String | default | 按钮的大小 [size](#size-values) |\n| type | String | default | 按钮的样式类型 [type](#type-values) |\n| plain | Boolean | false | 按钮是否镂空，背景色透明 |\n\n#### size @size-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| default | 默认大小 |\n| mini | 小尺寸 |\n\n\n#### type @type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| default | 白色 |\n| primary | 蓝色 |\n| warn | 红色 |\n","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/button)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/button/button.uvue)\n"},"checkbox":{"name":"## checkbox","description":"多选项目","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| disabled | Boolean | false | 是否禁用 |\n| value | String | - | checkbox 标识，选中时触发 checkbox-group 的 change 事件，并携带 checkbox 的 value |\n| checked | Boolean | false | 当前是否选中，可用来设置默认选中 |\n| color | ColorString | #007aff | checkbox的颜色 |\n| backgroundColor | ColorString | #ffffff | checkbox默认的背景颜色 |\n| borderColor | ColorString | #d1d1d1 | checkbox默认的边框颜色 |\n| activeBackgroundColor | ColorString | #ffffff | checkbox选中时的背景颜色 |\n| activeBorderColor | ColorString | #d1d1d1 | checkbox选中时的边框颜色 |\n| iconColor | ColorString | #007aff | checkbox的图标颜色，优先级大于color属性 |","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/checkbox)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/checkbox/checkbox.uvue)\n"},"checkbox-group":{"name":"## checkbox-group","description":"多项选择器，内部由多个checkbox组成","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| @change | (event: [CheckboxGroupChangeEvent](#checkboxgroupchangeevent)) => void | - | checkbox-group中选中项发生改变是触发 change 事件，detail = {value:\\[选中的checkbox的value的数组\\]} |","event":"\n### 事件\n#### CheckboxGroupChangeEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- CheckboxGroupChangeEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n> Package name: io.dcloud.uniapp.runtime\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### CheckboxGroupChangeEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/checkbox)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/checkbox-group/checkbox-group.uvue)\n"},"image":{"name":"## image","description":"图片","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| src | ImageURIString | - | 图片资源地址 |\n| mode | String | - | 图片裁剪、缩放的模式 [mode](#mode-values) |\n| fade-show | Boolean | - | 图片显示动画效果 |\n| @error | (event: [ImageErrorEvent](#imageerrorevent)) => void | - | 图片加载错误时触发，event.detail = { errMsg } |\n| @load | (event: [ImageLoadEvent](#imageloadevent)) => void | - | 图片加载完成时触发，event.detail = { width: '图片宽度px', height: '图片高度px' } |\n\n#### mode @mode-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| scaleToFill | 不保持纵横比缩放图片，使图片的宽高完全拉伸至填满 image 元素 |\n| aspectFit | 保持纵横比缩放图片，使图片的长边能完全显示出来。也就是说，可以完整地将图片显示出来。 |\n| aspectFill | 保持纵横比缩放图片，只保证图片的短边能完全显示出来。也就是说，图片通常只在水平或垂直方向是完整的，另一个方向将会发生截取 |\n| widthFix | 宽度不变，高度自动变化，保持原图宽高比不变 |\n| heightFix | 高度不变，宽度自动变化，保持原图宽高比不变 |\n| top | 不缩放图片，只显示图片的顶部区域 |\n| bottom | 不缩放图片，只显示图片的底部区域 |\n| center | 不缩放图片，只显示图片的中间区域 |\n| left | 不缩放图片，只显示图片的左边区域 |\n| right | 不缩放图片，只显示图片的右边区域 |\n| top left | 不缩放图片，只显示图片的左上边区域 |\n| top rigth | 不缩放图片，只显示图片的右上边区域 |\n| bottom left | 不缩放图片，只显示图片的左下边区域 |\n| bottom right | 不缩放图片，只显示图片的右下边区域 |\n","event":"\n### 事件\n#### ImageErrorEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ImageErrorEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [errMsg](#errmsg) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ImageLoadEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ImageLoadEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [width](#width) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| image | 5.0 | √ | 3.9.0 | 9.0 | √ | - |\n| src | 5.0 | √ | 3.9+ | 9.0 | x | x |\n| fade-show | 5.0 | √ | 3.9+ | 9.0 | x | x |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/image)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/image/image.uvue)\n"},"input":{"name":"## input","description":"输入框","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| disabled | Boolean | - | 是否禁用 |\n| value | String | - | 输入框的初始内容 |\n| type | String | - | input的类型 [type](#type-values) |\n| password | Boolean | - | 是否是密码类型 |\n| placeholder | String | - | 输入框为空时占位符 |\n| placeholder-style | String | - | 指定 placeholder 的样式 |\n| placeholder-class | String | - | 指定 placeholder 的样式类 |\n| maxlength | Number | - | 最大输入长度，设置为 -1 的时候不限制最大长度 |\n| cursor-spacing | Number | - | 指定光标与键盘的距离，单位 px 。取 input 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离 |\n| auto-focus | Boolean | - | 自动获取焦点 |\n| focus | Boolean | - | 获取焦点 |\n| confirm-type | String | - | 设置键盘右下角按钮的文字 [confirm-type](#confirm-type-values) |\n| always-embed | Boolean | - | 强制 input 处于同层状态，默认 focus 时 input 会切到非同层状态 (仅在 iOS 下生效) |\n| confirm-hold | Boolean | - | 点击键盘右下角按钮时是否保持键盘不收起 |\n| cursor | Number | - | 指定focus时的光标位置 |\n| selection-start | Number | - | 光标起始位置，自动聚集时有效，需与selection-end搭配使用 |\n| selection-end | Number | - | 光标结束位置，自动聚集时有效，需与selection-satrt搭配使用 |\n| adjust-position | Boolean | - | 键盘弹起时，是否自动上推页面 |\n| text-content-type | String | - | 文本区域的语义，根据类型自动填充 [text-content-type](#text-content-type-values) |\n| hold-keyboard | Boolean | - | focus时，点击页面的时候不收起键盘 |\n| safe-password-cert-path | String | - | 安全键盘加密公钥的路径，只支持包内路径 |\n| safe-password-length | Number | - | 安全键盘输入密码长度 |\n| safe-password-time-stamp | Number | - | 安全键盘加密时间戳 |\n| safe-password-nonce | String | - | 安全键盘加密盐值 |\n| safe-password-salt | String | - | 安全键盘计算 hash 盐值，若指定custom-hash 则无效 |\n| safe-password-custom-hash | String | - | 安全键盘计算 hash 的算法表达式 |\n| random-number | Boolean | - | 当 type 为 number, digit, idcard 数字键盘是否随机排列 |\n| controlled | Boolean | - | 是否为受控组件。为 true 时，value 内容会完全受 setData 控制 |\n| always-system | Boolean | - | 是否强制使用系统键盘和 Web-view 创建的 input 元素。为 true 时，confirm-type、confirm-hold 可能失效 |\n| inputmode | String | - | 是一个枚举属性，它提供了用户在编辑元素或其内容时可能输入的数据类型的提示。在符合条件的高版本webview里，uni-app的 web 和 app-vue 平台中可使用本属性。 [inputmode](#inputmode-values) |\n| @input | (event: [Event](/uni-app-x/common/event.md)) => void | - | 当键盘输入时，触发input事件，event.detail = {value, cursor}，处理函数可以直接 return 一个字符串，将替换输入框的内容。 |\n| @focus | (event: [Event](/uni-app-x/common/event.md)) => void | - | 输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度，在基础库 1.9.90 起支持 |\n| @blur | (event: [Event](/uni-app-x/common/event.md)) => void | - | 输入框失去焦点时触发，event.detail = {value: value} |\n| @keyboardheightchange | (event: [Event](/uni-app-x/common/event.md)) => void | - | 键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration} |\n| @confirm | (event: [Event](/uni-app-x/common/event.md)) => void | - | 点击完成按钮时触发，event.detail = {value: value} |\n\n#### type @type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| text | 文本输入键盘 |\n| number | 数字输入键盘 |\n| idcard | 身份证输入键盘 |\n| digit | 带小数点数字输入键盘 |\n| safe-password | 密码安全输入键盘 |\n| nickname | 昵称输入键盘 |\n\n\n#### confirm-type @confirm-type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| send | 发送 |\n| search | 搜索 |\n| next | 下一个 |\n| go | 前往 |\n| done | 完成 |\n\n\n#### text-content-type @text-content-type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| oneTimeCode | 一次性验证码 |\n\n\n#### inputmode @inputmode-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| none | 无虚拟键盘。在应用程序或者站点需要实现自己的键盘输入控件时很有用。 |\n| text | 使用用户本地区域设置的标准文本输入键盘。 |\n| decimal | 小数输入键盘，包含数字和分隔符（通常是“ . ”或者“ , ”），设备可能也可能不显示减号键。 |\n| numeric | 数字输入键盘，所需要的就是 0 到 9 的数字，设备可能也可能不显示减号键。 |\n| tel | 电话输入键盘，包含 0 到 9 的数字、星号（*）和井号（#）键。表单输入里面的电话输入通常应该使用 \\\\ 。 |\n| search | 为搜索输入优化的虚拟键盘，比如，返回键可能被重新标记为“搜索”，也可能还有其他的优化。 |\n| email | 为邮件地址输入优化的虚拟键盘，通常包含\"@\"符号和其他优化。表单里面的邮件地址输入应该使用 \\\\ 。 |\n| url | 为网址输入优化的虚拟键盘，比如，“/”键会更加明显、历史记录访问等。表单里面的网址输入通常应该使用 \\\\ 。 |\n","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/input)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/input/input.uvue)\n"},"list-item":{"name":"## list-item","description":"列表组件","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| type | Number | - | 对应list-item的类型 List 将对同类型条目进行复用，所以合理的类型拆分，可以很好地提升 List 性能 |","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/list-view#list-item)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/list-item/list-item.uvue)\n"},"list-view":{"name":"## list-view","description":"列表组件","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| scroll-x | Boolean | false | 允许横向滚动，不支持同时设置scroll-y属性 |\n| scroll-y | Boolean | true | 允许纵向滚动，不支持同时设置scroll-x属性 |\n| rebound | Boolean | true | 控制是否回弹效果 |\n| upper-threshold | Number | 50 | 距顶部/左边多远时（单位px），触发 scrolltoupper 事件 |\n| lower-threshold | Number | 50 | 距底部/右边多远时（单位px），触发 scrolltolower 事件 |\n| scroll-top | Number | - | 设置竖向滚动条位置 |\n| scroll-left | Number | - | 设置横向滚动条位置 |\n| show-scrollbar | Boolean | true | 控制是否出现滚动条 |\n| scroll-into-view | String | - | 值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素 |\n| scroll-with-animation | Boolean | false | 是否在设置滚动条位置时使用滚动动画，设置false没有滚动动画 |\n| refresher-enabled | Boolean | false | 开启自定义下拉刷新，暂时不支持scroll-x = true横向刷新 |\n| refresher-threshold | Number | false | 设置自定义下拉刷新阈值 |\n| refresher-default-style | String | black | 设置自定义下拉刷新默认样式，支持设置 black，white，none，none 表示不使用默认样式 |\n| refresher-background | String | #FFF | 设置自定义下拉刷新区域背景颜色 |\n| refresher-triggered | Boolean | false | 设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发 |\n| @refresherpulling | (event: [RefresherEvent](#refresherevent)) => void | - | 自定义下拉刷新控件被下拉 |\n| @refresherrefresh | (event: [RefresherEvent](#refresherevent)) => void | - | 自定义下拉刷新被触发 |\n| @refresherrestore | (event: [RefresherEvent](#refresherevent)) => void | - | 自定义下拉刷新被复位 |\n| @refresherabort | (event: [RefresherEvent](#refresherevent)) => void | - | 自定义下拉刷新被中止 |\n| @scrolltoupper | (event: [ScrollToUpperEvent](#scrolltoupperevent)) => void | - | 滚动到顶部/左边，会触发 scrolltoupper 事件 |\n| @scrolltolower | (event: [ScrollToLowerEvent](#scrolltolowerevent)) => void | - | 滚动到底部/右边，会触发 scrolltolower 事件 |\n| @scroll | (event: [ScrollEvent](#scrollevent)) => void | - | 滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY} |","event":"\n### 事件\n#### RefresherEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- RefresherEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [dy](#dy) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollToUpperEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToUpperEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [direction](#direction) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollToLowerEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToLowerEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [direction](#direction) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [scrollTop](#scrolltop) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| @refresherpulling | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherrefresh | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherrestore | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherabort | 5.0 | √ | 3.9+ | - | - | - |\n| @scrolltoupper | 5.0 | √ | 3.9+ | - | - | - |\n| @scrolltolower | 5.0 | √ | 3.9+ | - | - | - |\n| @scroll | 5.0 | √ | 3.9+ | - | - | - |\n","reference":"\n### 参见\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/list-view/list-view.uvue)\n"},"navigator":{"name":"## navigator","description":"页面链接","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| target | String | - | 在哪个目标上发生跳转，默认当前应用 |\n| url | String\\|PageURIString | - | 当前应用内的跳转链接 |\n| open-type | String | - | 跳转方式 [open-type](#open-type-values) |\n| delta | Number | - | 当 open-type 为 navigateBack 时有效，表示回退的层数 |\n| app-id | String | - | 当target=\"miniProgram\"时有效，要打开的小程序 appId |\n| path | String | - | 当target=\"miniProgram\"时有效，打开的页面路径，如果为空则打开首页 |\n| extra-data | Object | - | 当target=\"miniProgram\"时有效，需要传递给目标应用的数据，目标应用可在 App.onLaunch()，App.onShow() 中获取到这份数据 |\n| version | String | - | 当target=\"miniProgram\"时有效，要打开的小程序版本，有效值 develop（开发版），trial（体验版），release（正式版），仅在当前小程序为开发版或体验版时此参数有效；如果当前小程序是体验版或正式版，则打开的小程序必定是正式版 |\n| animation-type | String | - | 当 open-type=\"navigateTo\" 或 open-type=\"navigateBack\" 时有效，窗口的显示/关闭的动画类型。 [animation-type](#animation-type-values) |\n| animation-duration | Number | - | 当 open-type=\"navigateTo\" 或 open-type=\"navigateBack\" 时有效，窗口的显示/关闭动画的持续时间。 |\n| hover-class | String | - | 指定按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果 |\n| hover-stop-propagation | Boolean | - | 指定是否阻止本节点的祖先节点出现点击态 |\n| hover-start-time | Number | - | 按住后多久出现点击态，单位毫秒 |\n| hover-stay-time | Number | - | 手指松开后点击态保留时间，单位毫秒 |\n\n#### open-type @open-type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| navigate | 对应 wx.navigateTo 或 wx.navigateToMiniProgram 的功能 |\n| redirect | 对应 wx.redirectTo 的功能 |\n| switchTab | 对应 wx.switchTab 的功能 |\n| reLaunch | 对应 wx.reLaunch 的功能 |\n| navigateBack | 对应 wx.navigateBack 的功能 |\n\n\n#### animation-type @animation-type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| auto | 自动选择动画效果 |\n| none | 无动画效果 |\n| slide-in-right | 从右侧横向滑动效果 |\n| slide-in-left | 左侧横向滑动效果 |\n| slide-in-top | 从上侧竖向滑动效果 |\n| slide-in-bottom | 从下侧竖向滑动效果 |\n| fade-in | 从透明到不透明逐渐显示效果 |\n| zoom-out | 从小到大逐渐放大显示效果 |\n| zoom-fade-out | 从小到大逐渐放大并且从透明到不透明逐渐显示效果 |\n| pop-in | 从右侧平移入栈动画效果 |\n| slide-out-right | 横向向右侧滑出屏幕动画 |\n| slide-out-left | 横向向左侧滑出屏幕动画 |\n| slide-out-top | 竖向向上侧滑出屏幕动画 |\n| slide-out-bottom | 竖向向下侧滑出屏幕动画 |\n| fade-out | 从不透明到透明逐渐隐藏动画 |\n| zoom-in | 从大逐渐缩小关闭动画 |\n| zoom-fade-in | 从大逐渐缩小并且从不透明到透明逐渐隐藏关闭动画 |\n| pop-out | 从右侧平移出栈动画效果 |\n","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/navigator)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/navigator/navigator.uvue)\n"},"picker-view-column":{"name":"## picker-view-column","description":"仅可放置于 picker-view 中，其子节点未继承 picker-view 的选中框的高度，需要自己设置高度并居中","attrubute":"","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.net.cn/component/picker-view.html#picker-view-column)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/picker-view-column/picker-view-column.uvue)\n"},"picker-view":{"name":"## picker-view","description":"嵌入页面的滚动选择器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | - | picker-view-column 选择的第几项 |\n| indicator-style | CSSString | - | 设置选择器中间选中框的样式 |\n| mask-top-style | CSSString | - | 设置蒙层上半部分的样式 |\n| mask-bottom-style | CSSString | - | 设置蒙层下半部分的样式 |\n| @change | (event: [PickerViewChangeEvent](#pickerviewchangeevent)) => void | - | 当滚动选择，value 改变时触发 change 事件，event.detail = {value: value}；value为数组，表示 picker-view 内的 picker-view-column 当前选择的是第几项（下标从 0 \t\t开始） |","event":"\n### 事件\n#### PickerViewChangeEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- PickerViewChangeEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n> Package name: io.dcloud.uniapp.runtime\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### PickerViewChangeEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | Array\\ | 是 | - |\n","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/picker-view)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/picker-view/picker-view.uvue)\n"},"progress":{"name":"## progress","description":"进度条","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| duration | Number | 30 | 进度增加1%所需毫秒数 |\n| percent | Number | 0 | 百分比0~100 |\n| show-info | Boolean | false | 在进度条右侧显示百分比 |\n| border-radius | Number | 0 | 圆角大小 |\n| font-size | Number | 16 | 右侧百分比字体大小 |\n| stroke-width | Number | 6 | 进度条线的宽度，单位px |\n| color | ColorString | - | 进度条颜色 （请使用 activeColor） |\n| activeColor | ColorString | #09BB07 | 已选择的进度条的颜色 |\n| backgroundColor | ColorString | #EBEBEB | 未选择的进度条的颜色 |\n| active | Boolean | false | 进度条从左往右的动画 |\n| active-mode | String | backwards | backwards: 动画从头播；forwards：动画从上次结束点接着播 [active-mode](#active-mode-values) |\n| @activeend | (event: [ProgressActiveendEvent](#progressactiveendevent)) => void | - | 动画完成事件 |\n\n#### active-mode @active-mode-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| backwards | 动画从头播 |\n| forwards | 动画从上次结束点接着播 |\n","event":"\n### 事件\n#### ProgressActiveendEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- ProgressActiveendEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | number | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n> Package name: io.dcloud.uniapp.runtime\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### ProgressActiveendEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | number | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| curPercent | number | 是 | - |\n","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/progress)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/progress/progress.uvue)\n"},"radio":{"name":"## radio","description":"单选项目","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| disabled | Boolean | false | 是否禁用 |\n| value | String | - | \\ 标识。当该radio 选中时，radio-group的 change 事件会携带radio的value |\n| checked | Boolean | false | \\ 当前是否选中 |\n| color | ColorString | #007AFF | radio的颜色 |\n| backgroundColor | ColorString | #ffffff | radio默认的背景颜色 |\n| borderColor | ColorString | #d1d1d1 | radio默认的边框颜色 |\n| activeBackgroundColor | ColorString | #007AFF | radio选中时的背景颜色，优先级大于color属性 |\n| activeBorderColor | ColorString | | radio选中时的边框颜色 |\n| iconColor | ColorString | #ffffff | radio的图标颜色 |\n| @click | (event: [MouseEvent](/uni-app-x/common/mouseevent.md)) => void | - | 组件被点击时触发 |","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/radio)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/radio/radio.uvue)\n"},"radio-group":{"name":"## radio-group","description":"单项选择器，内部由多个 radio 组成","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| @change | (event: [RadioGroupChangeEvent](#radiogroupchangeevent)) => void | - | radio-group 中的选中项发生变化时触发 change 事件，event.detail = {value: 选中项radio的value} |","event":"\n### 事件\n#### RadioGroupChangeEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- RadioGroupChangeEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | string | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n> Package name: io.dcloud.uniapp.runtime\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### RadioGroupChangeEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | string | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | string | 是 | - |\n","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/radio)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/radio-group/radio-group.uvue)\n"},"rich-text":{"name":"## rich-text","description":"富文本","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| nodes | Array | - | 节点列表 |\n| @itemclick | (event: [RichTextItemClickEvent](#richtextitemclickevent)) => void | - | 拦截点击事件（只支持 a、img标签），返回用户自定义数据或img标签的src属性或a标签的href属性。event.detail={ ref \\| src \\| href } |","event":"\n### 事件\n#### RichTextItemClickEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- RichTextItemClickEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [ref](#ref) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| rich-text | 5.0 | √ | 3.9.0 | 9.0 | √ | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/rich-text)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/rich-text/rich-text.uvue)\n"},"scroll-view":{"name":"## scroll-view","description":"可滚动视图区域","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| scroll-x | Boolean | false | 允许横向滚动，不支持同时设置scroll-y属性 |\n| scroll-y | Boolean | true | 允许纵向滚动，不支持同时设置scroll-x属性 |\n| rebound | Boolean | true | 控制是否回弹效果 |\n| upper-threshold | Number | 50 | 距顶部/左边多远时（单位px），触发 scrolltoupper 事件 |\n| lower-threshold | Number | 50 | 距底部/右边多远时（单位px），触发 scrolltolower 事件 |\n| scroll-top | Number | - | 设置竖向滚动条位置 |\n| scroll-left | Number | - | 设置横向滚动条位置 |\n| scroll-into-view | String | - | 值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素 |\n| scroll-with-animation | Boolean | false | 是否在设置滚动条位置时使用滚动动画，设置false没有滚动动画 |\n| refresher-enabled | Boolean | false | 开启自定义下拉刷新，暂时不支持scroll-x = true横向刷新 |\n| refresher-threshold | Number | 45 | 设置自定义下拉刷新阈值 |\n| refresher-default-style | String | black | 设置自定义下拉刷新默认样式，支持设置 black \\| white \\| none， none 表示不使用默认样式 |\n| refresher-background | String | #FFF | 设置自定义下拉刷新区域背景颜色 |\n| refresher-triggered | Boolean | false | 设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发 |\n| show-scrollbar | Boolean | true | 控制是否出现滚动条 |\n| @refresherpulling | (event: [RefresherEvent](#refresherevent)) => void | - | 自定义下拉刷新控件被下拉 |\n| @refresherrefresh | (event: [RefresherEvent](#refresherevent)) => void | - | 自定义下拉刷新被触发 |\n| @refresherrestore | (event: [RefresherEvent](#refresherevent)) => void | - | 自定义下拉刷新被复位 |\n| @refresherabort | (event: [RefresherEvent](#refresherevent)) => void | - | 自定义下拉刷新被中止 |\n| @scrolltoupper | (event: [ScrollToUpperEvent](#scrolltoupperevent)) => void | - | 滚动到顶部/左边，会触发 scrolltoupper 事件 |\n| @scrolltolower | (event: [ScrollToLowerEvent](#scrolltolowerevent)) => void | - | 滚动到底部/右边，会触发 scrolltolower 事件 |\n| @scroll | (event: [ScrollEvent](#scrollevent)) => void | - | 滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY} |","event":"\n### 事件\n#### RefresherEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- RefresherEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [dy](#dy) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollToUpperEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToUpperEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [direction](#direction) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollToLowerEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToLowerEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [direction](#direction) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [scrollTop](#scrolltop) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| @refresherpulling | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherrefresh | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherrestore | 5.0 | √ | 3.9+ | - | - | - |\n| @refresherabort | 5.0 | √ | 3.9+ | - | - | - |\n| @scrolltoupper | 5.0 | √ | 3.9+ | - | - | - |\n| @scrolltolower | 5.0 | √ | 3.9+ | - | - | - |\n| @scroll | 5.0 | √ | 3.9+ | - | - | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/scroll-view)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/scroll-view/scroll-view.uvue)\n"},"slider":{"name":"## slider","description":"滑动选择器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| disabled | Boolean | - | 是否禁用 |\n| min | Number | 0 | slider 最小值 |\n| max | Number | 100 | slider 最大值 |\n| step | Number | 1 | slider 步长，取值必须大于 0，并且可被(max - min)整除 |\n| value | Number | 0 | radio当前取值 |\n| color | ColorString | - | slider 背景条的颜色（请使用 backgroundColor） |\n| activeColor | ColorString | #007aff | slider 滑块左侧已选择部分的线条颜色 |\n| backgroundColor | ColorString | #e9e9e9 | radio背景条的颜色 |\n| block-size | Number | 28 | radio滑块的大小，取值范围为 12 - 28 |\n| block-color | ColorString | #ffffff | 滑块颜色 |\n| show-value | Boolean | false | 是否显示当前 value |\n| @change | (event: [SliderChangeEvent](#sliderchangeevent)) => void | - | 完成一次拖动后触发的事件，event.detail = {value: value} |\n| @changing | (event: [SliderChangeEvent](#sliderchangeevent)) => void | - | 拖动过程中触发的事件，event.detail = {value: value} |","event":"\n### 事件\n#### SliderChangeEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- SliderChangeEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | number | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n> Package name: io.dcloud.uniapp.runtime\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### SliderChangeEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | number | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | number | 是 | - |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| @change | 5.0 | √ | 3.9+ | - | - | - |\n| @changing | 5.0 | √ | 3.9+ | - | - | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/slider)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/slider/slider.uvue)\n"},"swiper-item":{"name":"## swiper-item","description":"仅可放置在 swiper 组件中，宽高自动设置为100%","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| item-id | String | - | 该 swiper-item 的标识符 |","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.net.cn/component/swiper.html#swiper-item)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/swiper-item/swiper-item.uvue)\n"},"swiper":{"name":"## swiper","description":"滑块视图容器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| indicator-dots | Boolean | - | 是否显示面板指示点 |\n| indicator-color | HexColor | - | 指示点颜色 |\n| indicator-active-color | HexColor | - | 当前选中的指示点颜色 |\n| active-class | String | - | swiper-item 可见时的 class |\n| changing-class | Boolean | - | acceleration 设置为 {{true}} 时且处于滑动过程中，中间若干屏处于可见时的class |\n| acceleration | Boolean | - | 当开启时，会根据滑动速度，连续滑动多屏 |\n| disable-programmatic-animation | Boolean | - | 是否禁用代码变动触发 swiper 切换时使用动画。 |\n| disable-touch | Boolean | - | 是否禁止用户 touch 操作 |\n| touchable | Boolean | - | 是否监听用户的触摸事件 |\n| easing-function | String | - | 指定 swiper 切换缓动动画类型，有效值：default、linear、easeInCubic、easeOutCubic、easeInOutCubic [easing-function](#easing-function-values) |\n| autoplay | Boolean | - | 是否自动切换 |\n| current | Number | - | 当前所在滑块的 index |\n| current-item-id | String | - | 当前所在滑块的 item-id ，不能与 current 被同时指定 |\n| interval | Number | - | 自动切换时间间隔 |\n| duration | Number | - | 滑动动画时长 |\n| circular | Boolean | - | 是否采用衔接滑动 |\n| vertical | Boolean | - | 滑动方向是否为纵向 |\n| previous-margin | String | - | 前边距，可用于露出前一项的一小部分，接受 px 和 rpx 值 |\n| next-margin | String | - | 后边距，可用于露出后一项的一小部分，接受 px 和 rpx 值 |\n| display-multiple-items | Number | - | 同时显示的滑块数量 |\n| skip-hidden-item-layout | Boolean | - | 是否跳过未显示的滑块布局，设为 true 可优化复杂情况下的滑动性能，但会丢失隐藏状态滑块的布局信息 |\n| @change | (event: [Event](/uni-app-x/common/event.md)) => void | - | current 改变时会触发 change 事件，event.detail = {current: current, source: source} |\n| @transition | (event: [Event](/uni-app-x/common/event.md)) => void | - | swiper-item 的位置发生改变时会触发 transition 事件，event.detail = {dx: dx, dy: dy} |\n| @animationfinish | (event: [Event](/uni-app-x/common/event.md)) => void | - | 动画结束时会触发 animationfinish 事件，event.detail = {current: current, source: source} |\n\n#### easing-function @easing-function-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| default | - |\n| linear | - |\n| easeInCubic | - |\n| easeOutCubic | - |\n| easeInOutCubic | - |\n","event":"","compatibility":"","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/swiper)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/swiper/swiper.uvue)\n"},"switch":{"name":"## switch","description":"开关选择器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| checked | Boolean | - | 是否选中 |\n| type | String | - | 样式，有效值：switch, checkbox [type](#type-values) |\n| color | ColorString | - | switch 的颜色，同 css 的 color |\n| disabled | Boolean | - | 是否禁用 |\n| @change | (event: [SwitchChangeEvent](#switchchangeevent)) => void | - | checked 改变时触发 change 事件，event.detail={ value:checked} |\n\n#### type @type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| switch | - |\n| checkbox | - |\n","event":"\n### 事件\n#### SwitchChangeEvent\n\n> Package name: io.dcloud.uniapp.framework\n```mermaid\nclassDiagram\n\nCustomEvent <|-- SwitchChangeEvent : Extend\n```\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | boolean | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n> Package name: io.dcloud.uniapp.runtime\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### SwitchChangeEventDetail\n\n> Package name: io.dcloud.uniapp.framework\n\n##### 构造函数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | boolean | 是 | - |\n\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| value | boolean | 是 | - |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| @change | 5.0 | √ | 3.9+ | - | - | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/switch)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/switch/switch.uvue)\n"},"text":{"name":"## text","description":"文本","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| selectable | Boolean | - | 文本是否可选 |\n| space | String | - | 显示连续空格 [space](#space-values) |\n| decode | Boolean | - | 是否解码 |\n\n#### space @space-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| ensp | 中文字符空格一半大小 |\n| emsp | 中文字符空格大小 |\n| nbsp | 根据字体设置的空格大小 |\n","event":"","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| text | 5.0 | √ | 3.9.0 | 9.0 | √ | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/text)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/text/text.uvue)\n"},"textarea":{"name":"## textarea","description":"多行输入框","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| display | Any | - | - |\n| value | String | - | 输入框的初始内容 |\n| placeholder | String | - | 输入框为空时占位符 |\n| placeholder-style | String | - | 指定 placeholder 的样式 |\n| placeholder-class | String | - | 指定 placeholder 的样式类 |\n| maxlength | Number | - | 最大输入长度，设置为 -1 的时候不限制最大长度 |\n| auto-focus | Boolean | - | 自动获取焦点 |\n| focus | Boolean | - | 获取焦点 |\n| cursor | Number | - | 指定focus时的光标位置 |\n| confirm-type | String | - | 设置键盘右下角按钮的文字 [confirm-type](#confirm-type-values) |\n| confirm-hold | Boolean | - | 点击键盘右下角按钮时是否保持键盘不收起 |\n| auto-height | Boolean | - | 是否自动增高，设置auto-height时，style.height不生效 |\n| fixed | Boolean | - | 如果 textarea 是在一个 position:fixed 的区域，需要显示指定属性 fixed 为 true |\n| cursor-spacing | Number | - | 指定光标与键盘的距离，单位 px 。取 textarea 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离 |\n| show-confirm-bar | Boolean | - | 是否显示键盘上方带有”完成“按钮那一栏 |\n| selection-start | Number | - | 光标起始位置，自动聚集时有效，需与selection-end搭配使用 |\n| selection-end | Number | - | 光标结束位置，自动聚集时有效，需与selection-satrt搭配使用 |\n| adjust-position | Boolean | - | 键盘弹起时，是否自动上推页面 |\n| inputmode | String | - | 是一个枚举属性，它提供了用户在编辑元素或其内容时可能输入的数据类型的提示。在符合条件的高版本webview里，uni-app的 web 和 app-vue 平台中可使用本属性。 [inputmode](#inputmode-values) |\n| @confirm | (event: [Event](/uni-app-x/common/event.md)) => void | - | 点击完成时， 触发 confirm 事件，event.detail = {value: value} |\n| @input | (event: [Event](/uni-app-x/common/event.md)) => void | - | 当键盘输入时，触发 input 事件，event.detail = {value, cursor}， @input 处理函数的返回值并不会反映到 textarea 上 |\n| @linechange | (event: [Event](/uni-app-x/common/event.md)) => void | - | 输入框行数变化时调用，event.detail = {height: 0, heightRpx: 0, lineCount: 0} |\n| @blur | (event: [Event](/uni-app-x/common/event.md)) => void | - | 输入框失去焦点时触发，event.detail = {value, cursor} |\n| @keyboardheightchange | (event: [Event](/uni-app-x/common/event.md)) => void | - | 键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration} |\n| @focus | (event: [Event](/uni-app-x/common/event.md)) => void | - | 输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度，在基础库 1.9.90 起支持 |\n\n#### confirm-type @confirm-type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| send | 发送 |\n| search | 搜索 |\n| next | 下一个 |\n| go | 前往 |\n| done | 完成 |\n\n\n#### inputmode @inputmode-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| none | 无虚拟键盘。在应用程序或者站点需要实现自己的键盘输入控件时很有用。 |\n| text | 使用用户本地区域设置的标准文本输入键盘。 |\n| decimal | 小数输入键盘，包含数字和分隔符（通常是“ . ”或者“ , ”），设备可能也可能不显示减号键。 |\n| numeric | 数字输入键盘，所需要的就是 0 到 9 的数字，设备可能也可能不显示减号键。 |\n| tel | 电话输入键盘，包含 0 到 9 的数字、星号（*）和井号（#）键。表单输入里面的电话输入通常应该使用 \\\\ 。 |\n| search | 为搜索输入优化的虚拟键盘，比如，返回键可能被重新标记为“搜索”，也可能还有其他的优化。 |\n| email | 为邮件地址输入优化的虚拟键盘，通常包含\"@\"符号和其他优化。表单里面的邮件地址输入应该使用 \\\\ 。 |\n| url | 为网址输入优化的虚拟键盘，比如，“/”键会更加明显、历史记录访问等。表单里面的网址输入通常应该使用 \\\\ 。 |\n","event":"","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| @confirm | 5.0 | √ | 3.9+ | - | - | - |\n| @input | 5.0 | √ | 3.9+ | - | - | - |\n| @linechange | 5.0 | √ | 3.9+ | - | - | - |\n| @blur | 5.0 | √ | 3.9+ | - | - | - |\n| @keyboardheightchange | 5.0 | √ | 3.9+ | - | - | - |\n| @focus | 5.0 | √ | 3.9+ | - | - | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/textarea)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/textarea/textarea.uvue)\n"},"video":{"name":"## video","description":"视频","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| loop | Boolean | - | 是否循环播放 |\n| src | String\\|TagVideoURIString | - | 视频资源地址 |\n| initial-time | Number | - | 指定视频初始播放位置 |\n| duration | Number | - | 指定视频长度 |\n| controls | Boolean | - | 是否显示默认播放控件（播放/暂停按钮、播放进度、时间） |\n| danmu-list | Array | - | 弹幕列表 |\n| danmu-btn | Boolean | - | 是否显示弹幕按钮，只在初始化时有效，不能动态变更 |\n| enable-danmu | Boolean | - | 是否展示弹幕，只在初始化时有效，不能动态变更 |\n| autoplay | Boolean | - | 是否自动播放 |\n| muted | Boolean | - | 是否静音播放 |\n| page-gesture | Boolean | - | 在非全屏模式下，是否开启亮度与音量调节手势 |\n| direction | Number | - | 设置全屏时视频的方向，不指定则根据宽高比自动判断。有效值为 0（正常竖向）, 90（屏幕逆时针90度）, -90（屏幕顺时针90度） |\n| show-progress | Boolean | - | 若不设置，宽度大于240时才会显示 |\n| show-fullscreen-btn | Boolean | - | 是否显示全屏按钮 |\n| show-play-btn | Boolean | - | 是否显示视频底部控制栏的播放按钮 |\n| show-center-play-btn | Boolean | - | 是否显示视频中间的播放按钮 |\n| enable-progress-gesture | Boolean | - | 是否开启控制进度的手势 |\n| objectFit | String | - | 当视频大小与 video 容器大小不一致时，视频的表现形式。 [objectFit](#objectFit-values) |\n| poster | String | - | 视频封面的图片网络资源地址，如果 controls 属性值为 false 则设置 poster 无效 |\n| show-mute-btn | Boolean | - | 是否显示静音按钮 |\n| title | String | - | 视频的标题，全屏时在顶部展示 |\n| play-btn-position | String | - | 播放按钮的位置 |\n| enable-play-gesture | Boolean | - | 是否开启播放手势，即双击切换播放、暂停 |\n| auto-pause-if-navigate | Boolean | - | 当跳转到其它小程序页面时，是否自动暂停本页面的视频 |\n| auto-pause-if-open-native | Boolean | - | 当跳转到其它微信原生页面时，是否自动暂停本页面的视频 |\n| vslide-gesture | Boolean | - | 在非全屏模式下，是否开启亮度与音量调节手势（同 page-gesture） |\n| vslide-gesture-in-fullscreen | Boolean | - | 在全屏模式下，是否开启亮度与音量调节手势 |\n| ad-unit-id | String | - | 视频前贴广告单元ID |\n| poster-for-crawler | String | - | 用于给搜索等场景作为视频封面展示，建议使用无播放 icon 的视频封面图，只支持网络地址 |\n| codec | String | - | 解码器选择 |\n| http-cache | Boolean | - | 是否对 http、https 视频源开启本地缓存 |\n| play-strategy | Number | - | 播放策略 |\n| is-live | Boolean | - | 是否为直播源 |\n| @play | (event: [Event](/uni-app-x/common/event.md)) => void | - | 当开始/继续播放时触发play事件 |\n| @pause | (event: [Event](/uni-app-x/common/event.md)) => void | - | 当暂停播放时，触发pause事件 |\n| @ended | (event: [Event](/uni-app-x/common/event.md)) => void | - | 当播放到视频末尾时触发ended事件 |\n| @timeupdate | (event: [Event](/uni-app-x/common/event.md)) => void | - | 播放进度变化时触发，event.detail = {currentTime, duration} 。触发频率 250ms 一次 |\n| @fullscreenchange | (event: [Event](/uni-app-x/common/event.md)) => void | - | 当视频进入和退出全屏是触发，event.detail = {fullScreen, direction}，direction取为 vertical 或 horizontal |\n| @waiting | (event: [Event](/uni-app-x/common/event.md)) => void | - | 视频出现缓冲时触发 |\n| @error | (event: [Event](/uni-app-x/common/event.md)) => void | - | 播放出错试触发事件 |\n| @progress | (event: [Event](/uni-app-x/common/event.md)) => void | - | 加载进度变化时触发，只支持一段加载。event.detail = {buffered}，百分比 |\n| @loadedmetadata | (event: [Event](/uni-app-x/common/event.md)) => void | - | 视频元数据加载完成时触发。event.detail = {width, height, duration} |\n\n#### objectFit @objectFit-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| contain | 包含 |\n| fill | 填充 |\n| cover | 覆盖 |\n","event":"","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| video | 5.0 | √ | 3.9.0 | 9.0 | √ | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/video)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/video/video.uvue)\n"},"view":{"name":"## view","description":"基本视图容器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| hover-class | String | - | 指定按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果 |\n| hover-stop-propagation | Boolean | - | 指定是否阻止本节点的祖先节点出现点击态 |\n| hover-start-time | Number | - | 按住后多久出现点击态，单位毫秒 |\n| hover-stay-time | Number | - | 手指松开后点击态保留时间，单位毫秒 |","event":"","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| view | 5.0 | √ | √ | - | - | - |\n| hover-class | 4.4 | √ | √ | - | - | - |\n| hover-stop-propagation | 4.4 | √ | √ | - | - | - |\n| hover-start-time | 4.4 | √ | √ | - | - | - |\n| hover-stay-time | 4.4 | √ | √ | - | - | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/view)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/view/view.uvue)\n"},"web-view":{"name":"## web-view","description":"承载网页的容器","attrubute":"### 参数 \n| 属性名 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| src | String\\|URIString | - | webview 指向网页的链接 |\n| webview-styles | Object\\|Boolean | - | webview 的样式 |\n| @message | (event: [WebViewMessageEvent](#webviewmessageevent)) => void | - | 网页向应用 postMessage 时触发。e.detail = { data } |\n| @error | (event: [WebViewErrorEvent](#webviewerrorevent)) => void | - | 网页加载错误时触发。e.detail = { errMsg } |\n| @loaded | (event: [WebViewLoadedEvent](#webviewloadedevent)) => void | - | 网页加载完成后触发。 |\n| @loading | (event: [WebViewLoadingEvent](#webviewloadingevent)) => void | - | 网页加载中触发。 |","event":"\n### 事件\n#### WebViewMessageEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- WebViewMessageEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [data](#data) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### WebViewErrorEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- WebViewErrorEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [errMsg](#errmsg) | 是 | - |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### WebViewLoadedEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- WebViewLoadedEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### WebViewLoadingEvent\n\n> Package name: io.dcloud.uniapp.runtime\n```mermaid\nclassDiagram\n\nEvent <|-- WebViewLoadingEvent : Extend\n```\n##### 参数\n| 参数名 | 参数类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | 事件类型 |\n| target | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| currentTarget | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| timeStamp | number | 是 | 事件发生时的时间戳 |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| web-view | 5.0 | √ | 3.9.0 | 9.0 | √ | - |\n","reference":"\n### 参见\n- [Reference](https://uniapp.dcloud.io/component/web-view)\n- [示例](https://gitcode.net/dcloud/hello-uni-app-x/-/blob/master/pages/component/web-view/web-view.uvue)\n"}} \ No newline at end of file diff --git a/docs/uni-app-x/_sidebar.md b/docs/uni-app-x/_sidebar.md index 5be23851c..62ee8eec2 100644 --- a/docs/uni-app-x/_sidebar.md +++ b/docs/uni-app-x/_sidebar.md @@ -20,6 +20,13 @@ * [基础](/tutorial/vue3-basics.md) * [组件](/tutorial/vue3-components.md) * [API](/tutorial/vue3-api.md) +* 通用事件和类型 + * [Event](common/event.md) + * [CustomEvent](common/customevent.md) + * [MouseEvent](common/mouseevent.md) + * [TouchEvent](common/touchevent.md) + * [Touch](common/touch.md) + * [UniError](common/unierror.md) * 组件 * [概述](component/) * [公共属性和事件](component/common.md) @@ -212,9 +219,10 @@ * [lines](css/lines.md) * UVUE DOM * [DOM概述](dom/) - * [INode](dom/inode.md) - * [CSSStyleDeclaration](dom/cssstyledeclaration.md) - * [DrawableContext](dom/drawablecontext.md) + * [INode](dom/inode.md) + * [DOMRect](dom/domrect.md) + * [CSSStyleDeclaration](dom/cssstyledeclaration.md) + * [DrawableContext](dom/drawablecontext.md) * [性能](performance.md) + + + + + + + +## CustomEventOptions + + + + + + + + + diff --git a/docs/uni-app-x/common/error.md b/docs/uni-app-x/common/error.md new file mode 100644 index 000000000..236fcd665 --- /dev/null +++ b/docs/uni-app-x/common/error.md @@ -0,0 +1,10 @@ +## Error + + + + + + + + + diff --git a/docs/uni-app-x/common/event.md b/docs/uni-app-x/common/event.md new file mode 100644 index 000000000..805130b07 --- /dev/null +++ b/docs/uni-app-x/common/event.md @@ -0,0 +1,10 @@ +## Event + + + + + + + + + diff --git a/docs/uni-app-x/common/mouseevent.md b/docs/uni-app-x/common/mouseevent.md new file mode 100644 index 000000000..9504e89e7 --- /dev/null +++ b/docs/uni-app-x/common/mouseevent.md @@ -0,0 +1,10 @@ +## MouseEvent + + + + + + + + + diff --git a/docs/uni-app-x/common/touch.md b/docs/uni-app-x/common/touch.md new file mode 100644 index 000000000..334978544 --- /dev/null +++ b/docs/uni-app-x/common/touch.md @@ -0,0 +1,10 @@ +## Touch + + + + + + + + + diff --git a/docs/uni-app-x/common/touchevent.md b/docs/uni-app-x/common/touchevent.md new file mode 100644 index 000000000..77fe32480 --- /dev/null +++ b/docs/uni-app-x/common/touchevent.md @@ -0,0 +1,10 @@ +## TouchEvent + + + + + + + + + diff --git a/docs/uni-app-x/common/unierror.md b/docs/uni-app-x/common/unierror.md new file mode 100644 index 000000000..41a5a733e --- /dev/null +++ b/docs/uni-app-x/common/unierror.md @@ -0,0 +1,10 @@ +## UniError + + + + + + + + + diff --git a/docs/uni-app-x/dom/cssstyledeclaration.md b/docs/uni-app-x/dom/cssstyledeclaration.md index b9440935b..71bd98edf 100644 --- a/docs/uni-app-x/dom/cssstyledeclaration.md +++ b/docs/uni-app-x/dom/cssstyledeclaration.md @@ -1,53 +1,26 @@ -# CSSStyleDeclaration -CSSStyleDeclaration表示一个CSS 声明块对象，它是一个 CSS 属性键值对的集合。它暴露了样式信息和各种与样式相关的方法和属性。 - +# CSSStyleDeclaration -| 方法 | 说明 | -|-------------------------------------- |-------------------------- | -| [setProperty](#setProperty) | 设置CSS的某个样式值 | -| [getPropertyValue](#getPropertyValue) | 获取CSS的某个样式值 | - - -## setProperty(name, value)@setProperty + + + + + + + -对CSS指定样式设置一个新值。 + +## setProperty(name, value)@setProperty ```ts CSSStyleDeclaration.setProperty(name:string, value:any):void ``` -**参数说明** - -| 参数 | 类型 | 说明 | -|-------|-------- |------ | -| name | string | CSS样式名称| -| value | any | CSS样式值 | - -**返回值** - -无 - - ## getPropertyValue(property)@getPropertyValue -获取CSS指定的样式值，如果指定的样式不存在则返回null。 - -```ts +```ts CSSStyleDeclaration.getPropertyValue(property:string):any? ``` -**参数说明** - -| 参数 | 类型 | 说明 | -|---------------|-------- |------ | -| property | string | CSS样式名称| - -**返回值** - -| 类型 | 说明 | -|------ |---------- | -| any | CSS样式值，可能为null | - ## 示例 ```html