diff --git a/docs/.vuepress/utils/customTypeJson.json b/docs/.vuepress/utils/customTypeJson.json index 12a291771eb9743f82e89c9da3065b96729d0cfe..feeeee464a4e86456017035eeee1e84470e44478 100644 --- a/docs/.vuepress/utils/customTypeJson.json +++ b/docs/.vuepress/utils/customTypeJson.json @@ -1 +1 @@ -{"Event":{"name":"## Event","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | - |\n| UTSJSONObject | [UTSJSONObject](#utsjsonobject) | 是 | - |\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\n### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n"},"UTSJSONObject":{"name":"## UTSJSONObject","description":"","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| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n"},"INode":{"name":"## INode","description":"","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\n### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\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/component/common#event)) => void | 是 | 向一个指定的事件目标派发一个 Event，并以合适的顺序（同步地）调用此事件的监听器回调函数。 |\n| scrollTo | (number, number) => void | 是 | 使界面滚动到给定元素的指定坐标位置 |\n| scrollBy | (number, number) => void | 是 | 使得元素滚动一段特定距离 |\n"},"CSSStyleDeclaration":{"name":"## CSSStyleDeclaration","description":"\nCSSStyleDeclaration表示一个CSS 声明块对象，它是一个 CSS 属性键值对的集合，暴露样式信息和各种与样式相关的方法和属性。","extends":"","param":"\n### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| setProperty | (string, any?) => void | 是 | 对CSS指定样式设置一个新值，如有此样式已存在则更新。 |\n| getPropertyValue | (string) => any | 是 | 获取CSS指定的样式值，如果指定的样式不存在则返回null。 |\n"},"DOMRect":{"name":"## DOMRect","description":"\n一个 DOMRect 代表一个矩形。","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":"","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\n### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\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":"","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\n### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n"},"CustomEventOptions":{"name":"## CustomEventOptions","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n"},"MouseEvent":{"name":"## MouseEvent","description":"","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\n### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n"},"TouchEvent":{"name":"## TouchEvent","description":"","extends":"```mermaid\nclassDiagram\n\nEvent <|-- TouchEvent : Extend\n```","param":"\n### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| touches | Array\\<[Touch](/uni-app-x/component/common#touch)\\> | 是 | 当前停留在屏幕中的触摸点信息的数组 |\n| changedTouches | Array\\<[Touch](/uni-app-x/component/common#touch)\\> | 是 | 当前变化的触摸点信息的数组 |\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\n### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n"},"Touch":{"name":"## Touch","description":"","extends":"","param":"\n### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| clientX | number | 是 | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | 相对于页面可显示区域顶部的距离 |\n| identifier | number | 是 | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n| pageX | number | 是 | 相对于文档左边的距离 |\n| pageY | number | 是 | 相对于文档顶部的距离 |\n| screenX | number | 是 | 相对于屏幕左边距离 |\n| screenY | number | 是 | 相对于屏幕顶部的距离 |\n| force | number | 否 | 返回当前触摸点按下的压力大小 |\n"},"UniError":{"name":"## UniError","description":"\nuni api统一错误信息对象 ","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/component/common#error) | 否 | - |\n"},"Error":{"name":"## Error","description":"\nUTS错误信息对象","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| message | string | 是 | - |\n| UTSJSONObject | [UTSJSONObject](#utsjsonobject) | 是 | - |\n\n### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 否 | - |\n"}} \ No newline at end of file +{"Event":{"name":"## Event","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | - |\n| UTSJSONObject | [UTSJSONObject](#utsjsonobject) | 是 | - |\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","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\r\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\r\n阻止当前事件的默认行为","param":"","returnValue":"","compatibility":"","tutorial":""}}},"UTSJSONObject":{"name":"## UTSJSONObject","description":"","extends":"","param":"","methods":{"getAny":{"name":"#### getAny(key) @getany","description":"\r\n获取一个 属性，返回类型是any 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","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| 5.0 | 3.9.0 | 3.9.0 | 9.0 | √ | x |\n","tutorial":"\n##### 参见\n[getAny](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getAny)\n"},"getBoolean":{"name":"#### getBoolean(key) @getboolean","description":"\r\n获取一个Boolean属性，返回类型是Boolean 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| boolean | \n","compatibility":"##### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | 3.9.0 | 3.9.0 | 9.0 | √ | x |\n","tutorial":"\n##### 参见\n[getBoolean](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getBoolean)\n"},"getNumber":{"name":"#### getNumber(key) @getnumber","description":"\r\n获取一个number属性，返回类型是number 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| number | \n","compatibility":"##### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | 3.9.0 | 3.9.0 | 9.0 | √ | x |\n","tutorial":"\n##### 参见\n[getNumber](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getNumber)\n"},"getString":{"name":"#### getString(key) @getstring","description":"\r\n获取一个string属性，返回类型是string 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"##### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | 3.9.0 | 3.9.0 | 9.0 | √ | x |\n","tutorial":"\n##### 参见\n[getString](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getString)\n"},"getJSON":{"name":"#### getJSON(key) @getjson","description":"\r\n获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| UTSJSONObject | \n","compatibility":"##### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | 3.9.0 | 3.9.0 | 9.0 | √ | x |\n","tutorial":"\n##### 参见\n[getJSON](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getJSON)\n"},"getArray":{"name":"#### getArray(key) @getarray","description":"\r\n获取一个Array属性，返回类型是Array 或者 null","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","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| 5.0 | 3.9.0 | 3.9.0 | 9.0 | √ | x |\n","tutorial":"\n##### 参见\n[getArray](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#getArray)\n"},"toMap":{"name":"#### toMap() @tomap","description":"\r\n将当前 UTSJSONObject 实例转换为 Map 实例。","param":"","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| Map\\ | \n","compatibility":"##### 兼容性 \n\n| 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- |\n| 5.0 | 3.9.0 | 3.9.0 | 9.0 | √ | x |\n","tutorial":"\n##### 参见\n[toMap](https://uniapp.dcloud.net.cn/uts/buildin-object-api/UTSJSONObject.html#toMap)\n"}}},"INode":{"name":"## INode","description":"","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","methods":{"getNodeId":{"name":"#### getNodeId() @getnodeid","description":"\r\n获取节点标识。","param":"","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| string | \n","compatibility":"","tutorial":""},"appendChild":{"name":"#### appendChild(INode) @appendchild","description":"\r\n将一个节点添加到指定父节点的子节点列表的末尾处。如果将被插入的节点已经存在于当前文档的文档树中，那么将会它从原先的位置移动到新的位置。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| INode | [INode](/uni-app-x/dom/inode.md) | 是 | |","returnValue":"","compatibility":"","tutorial":""},"insertBefore":{"name":"#### insertBefore(INode, INode) @insertbefore","description":"\r\n在参考节点之前插入一个拥有指定父节点的子节点。如果给定的子节点是对文档中现有节点的引用，insertBefore() 会将其从当前位置移动到新位置。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| INode | [INode](/uni-app-x/dom/inode.md) | 是 | |\n| INode | [INode](/uni-app-x/dom/inode.md) | 是 | |","returnValue":"","compatibility":"","tutorial":""},"setAttribute":{"name":"#### setAttribute(key, value?) @setattribute","description":"\r\n设置指定节点上的某个属性值。如果设置的属性已经存在，则更新该属性值；否则使用指定的名称和值添加一个新的属性。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |\n| value | any | 否 | - |","returnValue":"","compatibility":"","tutorial":""},"getAttribute":{"name":"#### getAttribute(key) @getattribute","description":"\r\n获取节点指定的属性值，如果指定的属性不存在则返回null。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"","tutorial":""},"hasAttribute":{"name":"#### hasAttribute(key) @hasattribute","description":"\r\n返回改节点是否包含有指定的属性，属性存在则返回true，否则返回false。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| boolean | \n","compatibility":"","tutorial":""},"removeAttribute":{"name":"#### removeAttribute(key) @removeattribute","description":"\r\n从节点中删除一个属性，如果指定的属性不存在，则不做任何操作，也不会产生错误。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | - |","returnValue":"","compatibility":"","tutorial":""},"getBoundingClientRect":{"name":"#### getBoundingClientRect() @getboundingclientrect","description":"\r\n获取节点的大小及其相对于窗口的位置信息。","param":"","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| [DOMRect](/uni-app-x/dom/domrect.md) | \n","compatibility":"","tutorial":""},"getDrawableContext":{"name":"#### getDrawableContext() @getdrawablecontext","description":"\r\n获取组件的绘制对象，仅uvue页面中的 view 组件支持，其它组件不支持则返回null。","param":"","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| [DrawableContext](/uni-app-x/dom/drawablecontext.md) | \n","compatibility":"","tutorial":""},"addEventListener":{"name":"#### addEventListener(type, callback) @addeventlistener","description":"\r\n将指定的监听器注册到节点对象上，当该对象触发指定的事件时，指定的回调函数就会被执行。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | - |\n| callback | (event: T) => R | 是 | - |","returnValue":"","compatibility":"","tutorial":""},"removeEventListener":{"name":"#### removeEventListener(type) @removeeventlistener","description":"\r\n删除使用 addEventListener 方法添加的事件监听器。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | - |","returnValue":"","compatibility":"","tutorial":""},"removeChild":{"name":"#### removeChild(INode) @removechild","description":"\r\n从节点中删除一个子节点，返回删除的节点。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| INode | [INode](/uni-app-x/dom/inode.md) | 是 | |","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| [INode](/uni-app-x/dom/inode.md) | \n","compatibility":"","tutorial":""},"remove":{"name":"#### remove() @remove","description":"\r\n把节点对象从它所属的 DOM 树中删除。","param":"","returnValue":"","compatibility":"","tutorial":""},"dispatchEvent":{"name":"#### dispatchEvent(type, Event) @dispatchevent","description":"\r\n向一个指定的事件目标派发一个 Event，并以合适的顺序（同步地）调用此事件的监听器回调函数。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| type | string | 是 | - |\n| Event | [Event](/uni-app-x/component/common#event) | 是 | |","returnValue":"","compatibility":"","tutorial":""},"scrollTo":{"name":"#### scrollTo(x, y) @scrollto","description":"\r\n使界面滚动到给定元素的指定坐标位置","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | - |\n| y | number | 是 | - |","returnValue":"","compatibility":"","tutorial":""},"scrollBy":{"name":"#### scrollBy(x, y) @scrollby","description":"\r\n使得元素滚动一段特定距离","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | - |\n| y | number | 是 | - |","returnValue":"","compatibility":"","tutorial":""}}},"CSSStyleDeclaration":{"name":"## CSSStyleDeclaration","description":"\nCSSStyleDeclaration表示一个CSS 声明块对象，它是一个 CSS 属性键值对的集合，暴露样式信息和各种与样式相关的方法和属性。","extends":"","param":"","methods":{"setProperty":{"name":"#### setProperty(name, value?) @setproperty","description":"\n对CSS指定样式设置一个新值，如有此样式已存在则更新。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| name | string | 是 | CSS样式名称 |\n| value | any | 否 | 要设置的新CSS样式值 |","returnValue":"","compatibility":"","tutorial":""},"getPropertyValue":{"name":"#### getPropertyValue(property) @getpropertyvalue","description":"\n获取CSS指定的样式值，如果指定的样式不存在则返回null。","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| property | string | 是 | 要获取的CSS样式名称 |","returnValue":"##### 返回值 \n\n| 类型 |\n| :- |\n| any | \n","compatibility":"","tutorial":""}}},"DOMRect":{"name":"## DOMRect","description":"\r\n一个 DOMRect 代表一个矩形。","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","methods":{}},"DrawableContext":{"name":"## DrawableContext","description":"","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","methods":{"beginPath":{"name":"#### beginPath() @beginpath","description":"\r\n创建一个新的空路径","param":"","returnValue":"","compatibility":"","tutorial":""},"arc":{"name":"#### arc(x, y, radius, startAngle, endAngle, anticlockwise) @arc","description":"\r\n绘制一段弧线","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 圆心的X轴坐标 |\n| y | number | 是 | 圆心的Y轴坐标 |\n| radius | number | 是 | 圆弧的半径 |\n| startAngle | number | 是 | 圆弧的起始点，x 轴方向开始计算，单位为弧度 |\n| endAngle | number | 是 | 圆弧的终点，单位为弧度 |\n| anticlockwise | boolean | 是 | 圆弧绘制方向，true：逆时针绘制，false：顺时针绘制。默认为true。可选 |","returnValue":"","compatibility":"","tutorial":""},"moveTo":{"name":"#### moveTo(x, y) @moveto","description":"\r\n将一个新的路径的起始点移动到 (x，y) 坐标","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 点的X轴坐标 |\n| y | number | 是 | 点的Y轴坐标 |","returnValue":"","compatibility":"","tutorial":""},"rect":{"name":"#### rect(x, y, width, height) @rect","description":"\r\n创建一个矩形路径","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 矩形起点的X轴坐标 |\n| y | number | 是 | 矩形起点的Y轴坐标 |\n| width | number | 是 | 矩形宽度 |\n| height | number | 是 | 矩形高度 |","returnValue":"","compatibility":"","tutorial":""},"lineTo":{"name":"#### lineTo(x, y) @lineto","description":"\r\n将路径的最后一个点连接到 (x，y) 坐标","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 线终点的X轴坐标 |\n| y | number | 是 | 线终点的Y轴坐标 |","returnValue":"","compatibility":"","tutorial":""},"closePath":{"name":"#### closePath() @closepath","description":"\r\n闭合路径，将最后一个点与起点连接起来。如果图形已经封闭，或者只有一个点，那么此方法不会产生任何效果。","param":"","returnValue":"","compatibility":"","tutorial":""},"stroke":{"name":"#### stroke() @stroke","description":"\r\n绘制当前或已经存在的路径的边框。","param":"","returnValue":"","compatibility":"","tutorial":""},"strokeRect":{"name":"#### strokeRect(x, y, width, height) @strokerect","description":"\r\n绘制一个矩形框","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 矩形起点的X轴坐标 |\n| y | number | 是 | 矩形起点的Y轴坐标 |\n| width | number | 是 | 矩形宽度 |\n| height | number | 是 | 矩形高度 |","returnValue":"","compatibility":"","tutorial":""},"strokeText":{"name":"#### strokeText(text, x, y) @stroketext","description":"\r\n绘制空心字符","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 是 | 要绘制的字符 |\n| x | number | 是 | 字符开始绘制的X轴坐标 |\n| y | number | 是 | 字符开始绘制的Y轴坐标 |","returnValue":"","compatibility":"","tutorial":""},"fill":{"name":"#### fill(fillRule) @fill","description":"\r\n填充当前或已存在的路径","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| fillRule | string | 是 | 填充规则，默认为`nonzero`。可选 |","returnValue":"","compatibility":"","tutorial":""},"fillRect":{"name":"#### fillRect(x, y, width, height) @fillrect","description":"\r\n绘制一个实心矩形","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| x | number | 是 | 矩形起点的X轴坐标 |\n| y | number | 是 | 矩形起点的Y轴坐标 |\n| width | number | 是 | 矩形宽度 |\n| height | number | 是 | 矩形高度 |","returnValue":"","compatibility":"","tutorial":""},"fillText":{"name":"#### fillText(text, x, y) @filltext","description":"\r\n绘制实心字符","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| text | string | 是 | 要绘制的字符 |\n| x | number | 是 | 字符开始绘制的X轴坐标 |\n| y | number | 是 | 字符开始绘制的Y轴坐标 |","returnValue":"","compatibility":"","tutorial":""},"reset":{"name":"#### reset() @reset","description":"\r\n清空绘制数据","param":"","returnValue":"","compatibility":"","tutorial":""},"update":{"name":"#### update() @update","description":"\r\n将所有绘制内容更新到画布上","param":"","returnValue":"","compatibility":"","tutorial":""},"setLineDash":{"name":"#### setLineDash(segments) @setlinedash","description":"\r\n设置虚线样式","param":"##### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| segments | number\\[\\] | 是 | 一组描述交替绘制线段和间距长度的数字。 |","returnValue":"","compatibility":"","tutorial":""}}},"CustomEvent":{"name":"## CustomEvent","description":"","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","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\r\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\r\n阻止当前事件的默认行为","param":"","returnValue":"","compatibility":"","tutorial":""}}},"CustomEventOptions":{"name":"## CustomEventOptions","description":"","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n","methods":{}},"MouseEvent":{"name":"## MouseEvent","description":"","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","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\r\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\r\n阻止当前事件的默认行为","param":"","returnValue":"","compatibility":"","tutorial":""}}},"TouchEvent":{"name":"## TouchEvent","description":"","extends":"```mermaid\nclassDiagram\n\nEvent <|-- TouchEvent : Extend\n```","param":"\n### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| touches | Array\\<[Touch](/uni-app-x/component/common#touch)\\> | 是 | 当前停留在屏幕中的触摸点信息的数组 |\n| changedTouches | Array\\<[Touch](/uni-app-x/component/common#touch)\\> | 是 | 当前变化的触摸点信息的数组 |\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","methods":{"stopPropagation":{"name":"#### stopPropagation() @stoppropagation","description":"\r\n阻止当前事件的进一步传播","param":"","returnValue":"","compatibility":"","tutorial":""},"preventDefault":{"name":"#### preventDefault() @preventdefault","description":"\r\n阻止当前事件的默认行为","param":"","returnValue":"","compatibility":"","tutorial":""}}},"Touch":{"name":"## Touch","description":"","extends":"","param":"\n### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| clientX | number | 是 | 相对于页面可显示区域左边的距离 |\n| clientY | number | 是 | 相对于页面可显示区域顶部的距离 |\n| identifier | number | 是 | 触摸点的标识符。这个值在这根手指所引发的所有事件中保持一致，直到手指抬起。 |\n| pageX | number | 是 | 相对于文档左边的距离 |\n| pageY | number | 是 | 相对于文档顶部的距离 |\n| screenX | number | 是 | 相对于屏幕左边距离 |\n| screenY | number | 是 | 相对于屏幕顶部的距离 |\n| force | number | 否 | 返回当前触摸点按下的压力大小 |\n","methods":{}},"UniError":{"name":"## UniError","description":"\r\nuni api统一错误信息对象 ","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](Error) | 否 | - |\n","methods":{}},"Error":{"name":"## Error","description":"\r\nUTS错误信息对象","extends":"","param":"\n### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| message | string | 是 | - |\n| UTSJSONObject | [UTSJSONObject](#utsjsonobject) | 是 | - |\n\n### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](Error) | 否 | - |\n","methods":{}}} \ No newline at end of file diff --git a/docs/.vuepress/utils/utsApiJson.json b/docs/.vuepress/utils/utsApiJson.json index 2298fbc686f1f94df4cda5063c908f2c8e37aa34..1468214c3fccd328ea13c665eeda0ce76ba418df 100644 --- a/docs/.vuepress/utils/utsApiJson.json +++ b/docs/.vuepress/utils/utsApiJson.json @@ -58,7 +58,7 @@ "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 | (res: [ExitSuccess](#exitsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ExitSuccess @exitsuccess \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ExitOptions](#exitoptions) | 否 | - |\n#### ExitOptions @exitoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (res: [ExitSuccess](#exitsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: 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": "" @@ -66,7 +66,7 @@ "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: 从右侧平移入栈动画效果 - 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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[navigateTo](http://uniapp.dcloud.io/api/router?id=navigateto)\n" @@ -74,7 +74,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [RedirectToOptions](#redirecttooptions) | 是 | - |\n#### RedirectToOptions @redirecttooptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[redirectTo](http://uniapp.dcloud.io/api/router?id=redirectto)\n" @@ -82,7 +82,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ReLaunchOptions](#relaunchoptions) | 是 | - |\n#### ReLaunchOptions @relaunchoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[reLaunch](http://uniapp.dcloud.io/api/router?id=relaunch)\n" @@ -90,7 +90,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SwitchTabOptions](#switchtaboptions) | 是 | - |\n#### SwitchTabOptions @switchtaboptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 需要跳转的 tabBar 页面的路径，路径后不能带参数 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[switchTab](http://uniapp.dcloud.io/api/router?id=switchtab)\n" @@ -98,7 +98,7 @@ "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: 从右侧平移出栈动画效果 - 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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[navigateBack](http://uniapp.dcloud.io/api/router?id=navigateback)\n" @@ -106,7 +106,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (error: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SetNavigationBarColorOptions](#setnavigationbarcoloroptions) | 是 | - |\n#### SetNavigationBarColorOptions @setnavigationbarcoloroptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| frontColor | string | 是 | 前景颜色值，包括按钮、标题、状态栏的颜色 |\n| backgroundColor | string | 是 | 背景颜色值，有效值为十六进制颜色 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (error: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[setNavigationBarColor](http://uniapp.dcloud.io/api/ui/navigationbar?id=setnavigationbarcolor)\n" @@ -114,7 +114,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[setTabBarBadge](http://uniapp.dcloud.io/api/ui/tabbar?id=settabbarbadge)\n" @@ -122,7 +122,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [RemoveTabBarBadgeOptions](#removetabbarbadgeoptions) | 是 | - |\n#### RemoveTabBarBadgeOptions @removetabbarbadgeoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar的哪一项，从左边算起，索引从0开始 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[removeTabBarBadge](http://uniapp.dcloud.io/api/ui/tabbar?id=removetabbarbadge)\n" @@ -130,7 +130,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#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\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#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\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[setTabBarItem](http://uniapp.dcloud.io/api/ui/tabbar?id=settabbaritem)\n" @@ -138,7 +138,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#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\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#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\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[setTabBarStyle](http://uniapp.dcloud.io/api/ui/tabbar?id=settabbarstyle)\n" @@ -146,7 +146,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [HideTabBarOptions](#hidetabbaroptions) | 否 | - |\n#### HideTabBarOptions @hidetabbaroptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| animation | boolean | 否 | 是否需要动画效果 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[hideTabBar](http://uniapp.dcloud.io/api/ui/tabbar?id=hidetabbar)\n" @@ -154,7 +154,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowTabBarOptions](#showtabbaroptions) | 否 | - |\n#### ShowTabBarOptions @showtabbaroptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| animation | boolean | 否 | 是否需要动画效果 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[showTabBar](http://uniapp.dcloud.io/api/ui/tabbar?id=showtabbar)\n" @@ -162,7 +162,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ShowTabBarRedDotOptions](#showtabbarreddotoptions) | 是 | - |\n#### ShowTabBarRedDotOptions @showtabbarreddotoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar的哪一项，从左边算起，索引从0开始 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[showTabBarRedDot](http://uniapp.dcloud.io/api/ui/tabbar?id=showtabbarreddot)\n" @@ -170,7 +170,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [HideTabBarRedDotOptions](#hidetabbarreddotoptions) | 是 | - |\n#### HideTabBarRedDotOptions @hidetabbarreddotoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| index | number | 是 | tabBar的哪一项，从左边算起，索引从0开始 |\n| success | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[hideTabBarRedDot](http://uniapp.dcloud.io/api/ui/tabbar?id=hidetabbarreddot)\n" @@ -186,7 +186,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 是 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 是 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 是 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 是 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 是 | 接口调用失败的回调函数 |\n| complete | (result: [AsyncApiResult](#asyncapiresult)) => void | 是 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[pageScrollTo](http://uniapp.dcloud.io/api/ui/scroll?id=pagescrollto)\n" @@ -194,7 +194,7 @@ "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](#utsjsonobject) | 否 | 设置请求的 header，header 中不能设置 Referer |\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 | (option: [RequestSuccess\\](#requestsuccess)) => void | 否 | 网络请求成功回调。 |\n| fail | (option: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 网络请求失败回调。 |\n| complete | (option: any) => void | 否 | 网络请求完成回调，成功或者失败都会调用。 |\n\n##### UTSJSONObject @utsjsonobject \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => [UTSJSONObject](#utsjsonobject) | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => Array\\ | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\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\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "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](#utsjsonobject) | 否 | 设置请求的 header，header 中不能设置 Referer |\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 | (option: [RequestSuccess\\](#requestsuccess)) => void | 否 | 网络请求成功回调。 |\n| fail | (option: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 网络请求失败回调。 |\n| complete | (option: any) => void | 否 | 网络请求完成回调，成功或者失败都会调用。 |\n\n##### UTSJSONObject @utsjsonobject \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => [UTSJSONObject](#utsjsonobject) | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => Array\\ | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\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](#requesttask) | \n\n#### RequestTask @requesttask \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| abort | () => void | 是 | 中断网络请求。 |\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" @@ -202,7 +202,7 @@ "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](#utsjsonobject) | 否 | HTTP 请求 Header, header 中不能设置 Referer |\n| formData | [UTSJSONObject](#utsjsonobject) | 否 | HTTP 请求中其他额外的 form data |\n| timeout | number | 否 | 超时时间，单位 ms |\n| success | (result: [UploadFileSuccess](#uploadfilesuccess)) => void | 否 | 成功返回的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 失败的回调函数 |\n| complete | (result: 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##### UTSJSONObject @utsjsonobject \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => [UTSJSONObject](#utsjsonobject) | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => Array\\ | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n##### UploadFileSuccess @uploadfilesuccess \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | string | 是 | 开发者服务器返回的数据 |\n| statusCode | number | 是 | 开发者服务器返回的 HTTP 状态码 |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "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](#utsjsonobject) | 否 | HTTP 请求 Header, header 中不能设置 Referer |\n| formData | [UTSJSONObject](#utsjsonobject) | 否 | HTTP 请求中其他额外的 form data |\n| timeout | number | 否 | 超时时间，单位 ms |\n| success | (result: [UploadFileSuccess](#uploadfilesuccess)) => void | 否 | 成功返回的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 失败的回调函数 |\n| complete | (result: 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##### UTSJSONObject @utsjsonobject \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => [UTSJSONObject](#utsjsonobject) | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => Array\\ | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n##### UploadFileSuccess @uploadfilesuccess \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | string | 是 | 开发者服务器返回的数据 |\n| statusCode | number | 是 | 开发者服务器返回的 HTTP 状态码 |\n", "returnValue": "### 返回值 \n\n| 类型 |\n| :- |\n| [UploadTask](#uploadtask) | \n\n#### UploadTask @uploadtask \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| abort | () => void | 是 | 中断上传任务。 |\n| onProgressUpdate | (callback: (result: [OnProgressUpdateResult](#onprogressupdateresult)) => void) => void | 是 | 监听上传进度变化。 |\n\n##### OnProgressUpdateResult @onprogressupdateresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| progress | number | 是 | 上传进度百分比 |\n| totalBytesSent | number | 是 | 已经上传的数据长度，单位 Bytes |\n| totalBytesExpectedToSend | number | 是 | 预期需要上传的数据总长度，单位 Bytes |\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" @@ -210,7 +210,7 @@ "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](#utsjsonobject) | 否 | HTTP 请求 Header，header 中不能设置 Referer |\n| timeout | number | 否 | 超时时间，单位 ms |\n| success | (result: [DownloadFileSuccess](#downloadfilesuccess)) => void | 否 | 下载成功后以 tempFilePath 的形式传给页面，res = {tempFilePath: '文件的临时路径'} |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 失败的回调函数 |\n| complete | (result: any) => void | 否 | 结束的回调函数（调用成功、失败都会执行） |\n\n##### UTSJSONObject @utsjsonobject \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => [UTSJSONObject](#utsjsonobject) | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => Array\\ | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n##### DownloadFileSuccess @downloadfilesuccess \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| tempFilePath | string | 是 | 临时文件路径，下载后的文件会存储到一个临时文件 |\n| statusCode | number | 是 | 开发者服务器返回的 HTTP 状态码 |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [DownloadFileOptions](#downloadfileoptions) | 是 | - |\n#### DownloadFileOptions @downloadfileoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 下载资源的 url |\n| header | [UTSJSONObject](#utsjsonobject) | 否 | HTTP 请求 Header，header 中不能设置 Referer |\n| timeout | number | 否 | 超时时间，单位 ms |\n| success | (result: [DownloadFileSuccess](#downloadfilesuccess)) => void | 否 | 下载成功后以 tempFilePath 的形式传给页面，res = {tempFilePath: '文件的临时路径'} |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 失败的回调函数 |\n| complete | (result: any) => void | 否 | 结束的回调函数（调用成功、失败都会执行） |\n\n##### UTSJSONObject @utsjsonobject \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => [UTSJSONObject](#utsjsonobject) | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => Array\\ | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n##### DownloadFileSuccess @downloadfilesuccess \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| tempFilePath | string | 是 | 临时文件路径，下载后的文件会存储到一个临时文件 |\n| statusCode | number | 是 | 开发者服务器返回的 HTTP 状态码 |\n", "returnValue": "### 返回值 \n\n| 类型 |\n| :- |\n| [DownloadTask](#downloadtask) | \n\n#### DownloadTask @downloadtask \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| abort | () => void | 是 | 中断下载任务。 |\n| onProgressUpdate | (callback: (result: [OnProgressDownloadResult](#onprogressdownloadresult)) => void) => void | 是 | 监听下载进度变化。 |\n\n##### OnProgressDownloadResult @onprogressdownloadresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| progress | number | 是 | 下载进度百分比 |\n| totalBytesWritten | number | 是 | 已经下载的数据长度，单位 Bytes |\n| totalBytesExpectedToWrite | number | 是 | 预期需要下载的数据总长度，单位 Bytes |\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" @@ -218,7 +218,7 @@ "getNetworkType": { "name": "## uni.getNetworkType(options) @getnetworktype", "description": "获取网络类型", - "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetNetworkTypeOptions](#getnetworktypeoptions) | 是 | - |\n#### GetNetworkTypeOptions @getnetworktypeoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (result: [GetNetworkTypeSuccess](#getnetworktypesuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetNetworkTypeSuccess @getnetworktypesuccess \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| networkType | string | 是 | 网络类型 |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetNetworkTypeOptions](#getnetworktypeoptions) | 是 | - |\n#### GetNetworkTypeOptions @getnetworktypeoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (result: [GetNetworkTypeSuccess](#getnetworktypesuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: 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" @@ -226,7 +226,7 @@ "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](#utsjsonobject) | 是 | HTTP 请求 Header，header 中不能设置 Referer |\n| protocols | Array\\ | 是 | 子协议数组 |\n| success | (result: [ConnectSocketSuccess](#connectsocketsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### UTSJSONObject @utsjsonobject \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => [UTSJSONObject](#utsjsonobject) | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => Array\\ | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n##### ConnectSocketSuccess @connectsocketsuccess \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ConnectSocketOptions](#connectsocketoptions) | 是 | - |\n#### ConnectSocketOptions @connectsocketoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| url | string | 是 | 开发者服务器接口地址，必须是 wss 协议，且域名必须是后台配置的合法域名 |\n| header | [UTSJSONObject](#utsjsonobject) | 是 | HTTP 请求 Header，header 中不能设置 Referer |\n| protocols | Array\\ | 是 | 子协议数组 |\n| success | (result: [ConnectSocketSuccess](#connectsocketsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### UTSJSONObject @utsjsonobject \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => [UTSJSONObject](#utsjsonobject) | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => Array\\ | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n##### ConnectSocketSuccess @connectsocketsuccess \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "### 返回值 \n\n| 类型 |\n| :- |\n| [SocketTask](#sockettask) | \n\n#### SocketTask @sockettask \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| send | (options: [SendSocketMessageOptions](#sendsocketmessageoptions)) => void | 是 | 通过 WebSocket 连接发送数据 |\n| close | (options: [CloseSocketOptions](#closesocketoptions)) => void | 是 | 关闭 WebSocket 连接 |\n| onOpen | (callback: (result: [OnSocketOpenCallbackResult](#onsocketopencallbackresult)) => void) => void | 是 | 监听 WebSocket 连接打开事件 |\n| onClose | (callback: (result: any) => void) => void | 是 | 监听 WebSocket 连接关闭事件 |\n| onError | (callback: (result: [GeneralCallbackResult](#generalcallbackresult)) => void) => void | 是 | 监听 WebSocket 错误 |\n| onMessage | (callback: (result: [OnSocketMessageCallbackResult](#onsocketmessagecallbackresult)) => void) => void | 是 | 监听 WebSocket 接受到服务器的消息事件 |\n\n##### SendSocketMessageOptions @sendsocketmessageoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | any | 是 | 需要发送的内容 |\n| success | (result: [GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### CloseSocketOptions @closesocketoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| code | number | 否 | 一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被指定，默认的取值是1000 （表示正常连接关闭） |\n| reason | string | 否 | 一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符） |\n| success | (result: [GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: [GeneralCallbackResult](#generalcallbackresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### OnSocketOpenCallbackResult @onsocketopencallbackresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| header | any | 是 | 连接成功的 HTTP 响应 Header |\n\n##### OnSocketMessageCallbackResult @onsocketmessagecallbackresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | any | 是 | 服务器返回的消息 |\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" @@ -290,7 +290,7 @@ "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 | (res: [ShowModalSuccess](#showmodalsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ShowModalSuccess @showmodalsuccess \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| confirm | boolean | 是 | 为 true 时，表示用户点击了确定按钮 |\n| cancel | boolean | 是 | 为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭） |\n| content | string | 是 | editable 为 true 时，用户输入的文本 |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\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 | (res: [ShowModalSuccess](#showmodalsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: 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" @@ -298,7 +298,7 @@ "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 | (res: [ShowLoadingSuccess](#showloadingsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\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 | (res: [ShowLoadingSuccess](#showloadingsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: 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" @@ -306,7 +306,7 @@ "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 | (res: [ShowToastSuccess](#showtoastsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\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 | (res: [ShowToastSuccess](#showtoastsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: 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" @@ -314,7 +314,7 @@ "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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (error: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### LoadFontFaceOptionDesc @loadfontfaceoptiondesc \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| style | string | 是 | - |\n| weight | string | 是 | - |\n| variant | string | 是 | - |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\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 | (result: [AsyncApiSuccessResult](#asyncapisuccessresult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (error: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: [AsyncApiResult](#asyncapiresult)) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### LoadFontFaceOptionDesc @loadfontfaceoptiondesc \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| style | string | 是 | - |\n| weight | string | 是 | - |\n| variant | string | 是 | - |\n\n##### AsyncApiSuccessResult @asyncapisuccessresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n\n##### AsyncApiResult @asyncapiresult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | - |\n", "returnValue": "", "compatibility": "", "tutorial": "\n### 参见\n[loadFontFace](http://uniapp.dcloud.io/api/ui/font?id=loadfontface)\n" @@ -322,7 +322,7 @@ "getSystemInfo": { "name": "## uni.getSystemInfo(options) @getsysteminfo", "description": "异步获取系统信息", - "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetSystemInfoOptions](#getsysteminfooptions) | 是 | - |\n#### GetSystemInfoOptions @getsysteminfooptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (result: [GetSystemInfoResult](#getsysteminforesult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetSystemInfoResult @getsysteminforesult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| SDKVersion | string | 是 | 客户端基础库版本 |\n| appId | string | 是 | `manifest.json` 中应用appid。 |\n| appLanguage | string | 是 | 应用设置的语言。 |\n| appName | string | 是 | `manifest.json` 中应用名称。 |\n| appVersion | string | 是 | `manifest.json` 中应用版本名称（真机运行时，为基座的版本名称）。 |\n| appVersionCode | number | 是 | `manifest.json` 中应用版本名号（真机运行时，为基座的版本号）。 |\n| appWgtVersion | string | 是 | 应用资源（wgt）的版本名称。 |\n| brand | string | 是 | 手机品牌。 |\n| browserName | string | 是 | 浏览器名称。`App` 端是系统 webview 的名字，比如 wkwebview、chrome。小程序端为空 |\n| browserVersion | string | 是 | 浏览器版本、webview 版本。 |\n| deviceId | string | 是 | 设备 ID |\n| deviceBrand | string | 是 | 设备品牌。如：`apple`、`huawei`。 |\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 | 是 | 操作系统语言 |\n| osTheme | string | 是 | 操作系统主题 light、dark。 |\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 | 是 | oaid |\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\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetSystemInfoOptions](#getsysteminfooptions) | 是 | - |\n#### GetSystemInfoOptions @getsysteminfooptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (result: [GetSystemInfoResult](#getsysteminforesult)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetSystemInfoResult @getsysteminforesult \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| SDKVersion | string | 是 | 客户端基础库版本 |\n| appId | string | 是 | `manifest.json` 中应用appid。 |\n| appLanguage | string | 是 | 应用设置的语言。 |\n| appName | string | 是 | `manifest.json` 中应用名称。 |\n| appVersion | string | 是 | `manifest.json` 中应用版本名称（真机运行时，为基座的版本名称）。 |\n| appVersionCode | number | 是 | `manifest.json` 中应用版本名号（真机运行时，为基座的版本号）。 |\n| appWgtVersion | string | 是 | 应用资源（wgt）的版本名称。 |\n| brand | string | 是 | 手机品牌。 |\n| browserName | string | 是 | 浏览器名称。`App` 端是系统 webview 的名字，比如 wkwebview、chrome。小程序端为空 |\n| browserVersion | string | 是 | 浏览器版本、webview 版本。 |\n| deviceId | string | 是 | 设备 ID |\n| deviceBrand | string | 是 | 设备品牌。如：`apple`、`huawei`。 |\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 | 是 | 操作系统语言 |\n| osTheme | string | 是 | 操作系统主题 light、dark。 |\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 | 是 | oaid |\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" @@ -378,7 +378,7 @@ "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 | (callback: [ChooseImageSuccessCallback](#chooseimagesuccesscallback)) => void | 否 | 成功则返回图片的本地文件路径列表 tempFilePaths |\n| fail | (callback: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (callback: 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##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "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 | (callback: [ChooseImageSuccessCallback](#chooseimagesuccesscallback)) => void | 否 | 成功则返回图片的本地文件路径列表 tempFilePaths |\n| fail | (callback: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (callback: 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", "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" @@ -386,7 +386,7 @@ "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 | (result: [PreviewImageSuccessCallback](#previewimagesuccesscallback)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### LongPressActionsOptions @longpressactionsoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| itemList | Array\\ | 是 | 按钮的文字数组 |\n| itemColor | string | 是 | 按钮的文字颜色，字符串格式，默认为\"#000000\" |\n| success | (result: [LongPressActionsSuccessData](#longpressactionssuccessdata)) => void | 是 | 接口调用成功的回调函数 |\n| fail | (result: any) => void | 是 | 接口调用失败的回调函数 |\n| complete | (result: 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##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "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 | (result: [PreviewImageSuccessCallback](#previewimagesuccesscallback)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### LongPressActionsOptions @longpressactionsoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| itemList | Array\\ | 是 | 按钮的文字数组 |\n| itemColor | string | 是 | 按钮的文字颜色，字符串格式，默认为\"#000000\" |\n| success | (result: [LongPressActionsSuccessData](#longpressactionssuccessdata)) => void | 是 | 接口调用成功的回调函数 |\n| fail | (result: any) => void | 是 | 接口调用失败的回调函数 |\n| complete | (result: 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", "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" @@ -394,7 +394,7 @@ "closePreviewImage": { "name": "## uni.closePreviewImage(options) @closepreviewimage", "description": "关闭图片预览", - "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ClosePreviewImageOptions](#closepreviewimageoptions) | 是 | - |\n#### ClosePreviewImageOptions @closepreviewimageoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (result: [ClosePreviewImageSuccessCallback](#closepreviewimagesuccesscallback)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ClosePreviewImageSuccessCallback @closepreviewimagesuccesscallback \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| errMsg | string | 是 | 错误信息 |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [ClosePreviewImageOptions](#closepreviewimageoptions) | 是 | - |\n#### ClosePreviewImageOptions @closepreviewimageoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (result: [ClosePreviewImageSuccessCallback](#closepreviewimagesuccesscallback)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### ClosePreviewImageSuccessCallback @closepreviewimagesuccesscallback \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 | - | - | - |\n", "tutorial": "\n### 参见\n[closePreviewImage](http://uniapp.dcloud.io/api/media/image?id=closepreviewimage)\n" @@ -402,7 +402,7 @@ "saveImageToPhotosAlbum": { "name": "## uni.saveImageToPhotosAlbum(options) @saveimagetophotosalbum", "description": "保存图片到系统相册", - "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SaveImageToPhotosAlbumOptions](#saveimagetophotosalbumoptions) | 是 | - |\n#### SaveImageToPhotosAlbumOptions @saveimagetophotosalbumoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| filePath | string | 是 | 图片文件路径，可以是临时文件路径也可以是永久文件路径，不支持网络图片路径 |\n| success | (result: [SaveImageToPhotosAlbumSuccessCallback](#saveimagetophotosalbumsuccesscallback)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### SaveImageToPhotosAlbumSuccessCallback @saveimagetophotosalbumsuccesscallback \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| path | string | 是 | 保存到相册的图片路径 |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [SaveImageToPhotosAlbumOptions](#saveimagetophotosalbumoptions) | 是 | - |\n#### SaveImageToPhotosAlbumOptions @saveimagetophotosalbumoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| filePath | string | 是 | 图片文件路径，可以是临时文件路径也可以是永久文件路径，不支持网络图片路径 |\n| success | (result: [SaveImageToPhotosAlbumSuccessCallback](#saveimagetophotosalbumsuccesscallback)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### SaveImageToPhotosAlbumSuccessCallback @saveimagetophotosalbumsuccesscallback \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| path | 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 | - | - | - |\n", "tutorial": "\n### 参见\n[saveImageToPhotosAlbum](http://uniapp.dcloud.io/api/media/image?id=saveimagetophotosalbum)\n" @@ -410,7 +410,7 @@ "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 | (result: [GetLocationSuccess](#getlocationsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: 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\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "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 | (result: [GetLocationSuccess](#getlocationsuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (result: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (result: 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" @@ -418,7 +418,7 @@ "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 | (res: [SetStorageSuccess](#setstoragesuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\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 | (res: [SetStorageSuccess](#setstoragesuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: 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" @@ -434,7 +434,7 @@ "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 | (res: [GetStorageSuccess](#getstoragesuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetStorageSuccess @getstoragesuccess \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| data | any | 是 | key 对应的内容 |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetStorageOptions](#getstorageoptions) | 是 | uni.getStorage参数定义 |\n#### GetStorageOptions @getstorageoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |\n| success | (res: [GetStorageSuccess](#getstoragesuccess)) => void | 否 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: 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" @@ -450,7 +450,7 @@ "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 | (res: [GetStorageInfoSuccess](#getstorageinfosuccess)) => void | 是 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/uni-app-x/component/common#unierror)) => void | 是 | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 是 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### GetStorageInfoSuccess @getstorageinfosuccess \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| keys | Array\\ | 是 | 当前 storage 中所有的 key |\n| currentSize | number | 是 | 当前占用的空间大小, 单位：kb |\n| limitSize | number | 是 | 限制的空间大小, 单位：kb |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [GetStorageInfoOptions](#getstorageinfooptions) | 是 | uni.getStorageInfo参数定义 |\n#### GetStorageInfoOptions @getstorageinfooptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (res: [GetStorageInfoSuccess](#getstorageinfosuccess)) => void | 是 | 接口调用成功的回调函数 |\n| fail | (res: [UniError](/tutorial/err-spec.html#unierror)) => void | 是 | 接口调用失败的回调函数 |\n| complete | (res: 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" @@ -466,7 +466,7 @@ "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 | (res: [RemoveStorageSuccess](#removestoragesuccess)) => void | 否 | 接口调用的回调函数 |\n| fail | (res: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| options | [RemoveStorageOptions](#removestorageoptions) | 是 | uni.removeStorage参数定义 |\n#### RemoveStorageOptions @removestorageoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| key | string | 是 | 本地缓存中的指定的 key |\n| success | (res: [RemoveStorageSuccess](#removestoragesuccess)) => void | 否 | 接口调用的回调函数 |\n| fail | (res: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: 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" @@ -482,7 +482,7 @@ "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 | (res: [ClearStorageSuccess](#clearstoragesuccess)) => void | 否 | 接口调用的回调函数 |\n| fail | (res: [UniError](/uni-app-x/component/common#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: any) => void | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |\n\n##### UniError @unierror \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| errSubject | string | 是 | 统一错误主题（模块）名称 |\n| errCode | number | 是 | 统一错误码 |\n| errMsg | string | 是 | 统一错误描述信息 |\n| data | any | 是 | 错误信息中包含的数据 |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n\n###### Error @error \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| ctors | Constructor | 是 | - |\n| name | string | 是 | - |\n| message | string | 是 | - |\n| cause | [Error](/uni-app-x/component/common#error) | 是 | - |\n", + "param": "### 参数 \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| option | [ClearStorageOptions](#clearstorageoptions) | 否 | - |\n#### ClearStorageOptions @clearstorageoptions \n\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| success | (res: [ClearStorageSuccess](#clearstoragesuccess)) => void | 否 | 接口调用的回调函数 |\n| fail | (res: [UniError](/tutorial/err-spec.html#unierror)) => void | 否 | 接口调用失败的回调函数 |\n| complete | (res: 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" diff --git a/docs/.vuepress/utils/utsComJson.json b/docs/.vuepress/utils/utsComJson.json index a838cc04aba143a446c8db1942ae2736a4323015..c371bbf8ec8c43addaf59232134c0a0dfe3d7864 100644 --- a/docs/.vuepress/utils/utsComJson.json +++ b/docs/.vuepress/utils/utsComJson.json @@ -1 +1,202 @@ -{"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 | false | 图片显示动画效果 |\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; }](#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: number; height: number; }](#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.0 | 9.0 | √ | x |\n| mode | 5.0 | √ | 3.9.0 | 9.0 | √ | x |\n| fade-show | 5.0 | √ | 3.9.0 | 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| confirm-hold | Boolean | - | 点击键盘右下角按钮时是否保持键盘不收起 |\n| cursor | Number | - | 指定focus时的光标位置 |\n| selection-start | Number | - | 光标起始位置，自动聚集时有效，需与selection-end搭配使用 |\n| selection-end | Number | - | 光标结束位置，自动聚集时有效，需与selection-satrt搭配使用 |\n| adjust-position | Boolean | - | 键盘弹起时，是否自动上推页面 |\n| @input | (event: [InputEvent](#inputevent)) => void | - | 当键盘输入时，触发input事件，event.detail = {value, cursor}，处理函数可以直接 return 一个字符串，将替换输入框的内容。 |\n| @focus | (event: [InputFocusEvent](#inputfocusevent)) => void | - | 输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度，在基础库 1.9.90 起支持 |\n| @blur | (event: [InputBlurEvent](#inputblurevent)) => void | - | 输入框失去焦点时触发，event.detail = {value: value} |\n| @keyboardheightchange | (event: [InputKeyboardHeightChangeEvent](#inputkeyboardheightchangeevent)) => void | - | 键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration} |\n| @confirm | (event: [InputConfirmEvent](#inputconfirmevent)) => void | - | 点击完成按钮时触发，event.detail = {value: value} |\n\n#### type @type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| text | 文本输入键盘 |\n| number | 数字输入键盘 |\n| idcard | 身份证输入键盘 |\n| digit | 带小数点数字输入键盘 |\n| tel | 电话输入键盘 |\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","event":"","compatibility":"\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| type | x | x | x | x | x | x |\n| type | x | x | x | x | x | x |\n| type | x | x | x | x | x | x |\n","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 | 45 | 设置自定义下拉刷新阈值 |\n| refresher-max-drag-distance | Number | - | 设置下拉最大拖拽距离（单位px），默认是下拉刷新控件高度的2.5倍 |\n| refresher-default-style | String | black | 设置自定义下拉刷新默认样式，支持设置 black，white，none，none 表示不使用默认样式 |\n| refresher-background | String | #FFF | 设置自定义下拉刷新区域背景颜色 |\n| refresher-triggered | Boolean | false | 设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发 |\n| custom-nested-scroll | Boolean | 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; }](#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: string; }](#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: string; }](#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: number; scrollLeft: number; scrollHeight: number; scrollWidth: number; deltaY: number; deltaX: number; }](#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| custom-nested-scroll | 5.0 | x | 3.9+ | - | - | - |\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/component/common#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](/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 \\| String | - | 节点列表 \\| HTML String |\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; }](#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-max-drag-distance | Number | - | 设置下拉最大拖拽距离（单位px），默认是下拉刷新控件高度的2.5倍 |\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| custom-nested-scroll | Boolean | 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} |\n| @startnestedscroll | (event: [StartNestedScrollEvent](#startnestedscrollevent)) => Boolean | - | 子节点开始滚动时触发, return ture表示与子节点开启滚动协商 默认return false! event = {node} |\n| @nestedprescroll | (event: [NestedPreScrollEvent](#nestedprescrollevent)) => void | - | 子节点滚动时触发，可执行event.consumed(x,y)告知子节点deltaX、deltaY各消耗多少。子节点将执行差值后的deltaX、deltaY滚动距离。不执行consumed(x,y)则表示父节点不消耗deltaX、deltaY。event = {deltaX, deltaY} |\n| @stopnestedscroll | (event: [Event](/uni-app-x/component/common#event)) => void | - | 子节点滚动结束或意外终止时触发 |","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; }](#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: string; }](#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: string; }](#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: number; scrollLeft: number; scrollHeight: number; scrollWidth: number; deltaY: number; deltaX: number; }](#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| custom-nested-scroll | 5.0 | x | 3.9+ | - | - | - |\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| @startnestedscroll | 5.0 | x | 3.9+ | - | - | - |\n| @nestedprescroll | 5.0 | x | 3.9+ | - | - | - |\n| @stopnestedscroll | 5.0 | x | 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/component/common#event)) => void | - | current 改变时会触发 change 事件，event.detail = {current: current, source: source} |\n| @transition | (event: [Event](/uni-app-x/component/common#event)) => void | - | swiper-item 的位置发生改变时会触发 transition 事件，event.detail = {dx: dx, dy: dy} |\n| @animationfinish | (event: [Event](/uni-app-x/component/common#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](/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 | false | 文本是否可选 |\n| space | String | - | 显示连续空格 [space](#space-values) |\n| decode | Boolean | false | 是否解码 |\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| cursor-spacing | Number | - | 指定光标与键盘的距离，单位 px 。取 textarea 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离 |\n| selection-start | Number | - | 光标起始位置，自动聚集时有效，需与selection-end搭配使用 |\n| selection-end | Number | - | 光标结束位置，自动聚集时有效，需与selection-satrt搭配使用 |\n| adjust-position | Boolean | - | 键盘弹起时，是否自动上推页面 |\n| @confirm | (event: [InputConfirmEvent](#inputconfirmevent)) => void | - | 点击完成时， 触发 confirm 事件，event.detail = {value: value} |\n| @input | (event: [InputEvent](#inputevent)) => void | - | 当键盘输入时，触发 input 事件，event.detail = {value, cursor}， @input 处理函数的返回值并不会反映到 textarea 上 |\n| @linechange | (event: [TextareaLineChangeEvent](#textarealinechangeevent)) => void | - | 输入框行数变化时调用，event.detail = {height: 0, heightRpx: 0, lineCount: 0} |\n| @blur | (event: [TextareaBlurEvent](#textareablurevent)) => void | - | 输入框失去焦点时触发，event.detail = {value, cursor} |\n| @keyboardheightchange | (event: [InputKeyboardHeightChangeEvent](#inputkeyboardheightchangeevent)) => void | - | 键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration} |\n| @focus | (event: [TextareaFocusEvent](#textareafocusevent)) => 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","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 | false | 是否循环播放 |\n| src | String\\|TagVideoURIString | - | 视频资源地址 |\n| initial-time | Number | - | 指定视频初始播放位置 |\n| duration | Number | - | 指定视频长度 |\n| controls | Boolean | true | 是否显示默认播放控件（播放/暂停按钮、播放进度、时间） |\n| danmu-list | Array | - | 弹幕列表 |\n| danmu-btn | Boolean | false | 是否显示弹幕按钮，只在初始化时有效，不能动态变更 |\n| enable-danmu | Boolean | false | 是否展示弹幕，只在初始化时有效，不能动态变更 |\n| autoplay | Boolean | false | 是否自动播放 |\n| muted | Boolean | false | 是否静音播放 |\n| page-gesture | Boolean | false | 在非全屏模式下，是否开启亮度与音量调节手势 |\n| direction | Number | -90 | 设置全屏时视频的方向，不指定则根据宽高比自动判断。有效值为 0（正常竖向）, 90（屏幕逆时针90度）, -90（屏幕顺时针90度） |\n| show-progress | Boolean | true | 若不设置，宽度大于240时才会显示 |\n| show-fullscreen-btn | Boolean | true | 是否显示全屏按钮 |\n| show-play-btn | Boolean | true | 是否显示视频底部控制栏的播放按钮 |\n| show-center-play-btn | Boolean | true | 是否显示视频中间的播放按钮 |\n| show-loading | Boolean | true | 是否显示loading控件 |\n| enable-progress-gesture | Boolean | true | 是否开启控制进度的手势 |\n| objectFit | String | contain | 当视频大小与 video 容器大小不一致时，视频的表现形式。 [objectFit](#objectFit-values) |\n| poster | String | - | 视频封面的图片网络资源地址，如果 controls 属性值为 false 则设置 poster 无效 |\n| show-mute-btn | Boolean | false | 是否显示静音按钮 |\n| title | String | - | 视频的标题，全屏时在顶部展示 |\n| play-btn-position | String | - | 播放按钮的位置 |\n| enable-play-gesture | Boolean | false | 是否开启播放手势，即双击切换播放、暂停 |\n| auto-pause-if-navigate | Boolean | - | 当跳转到其它小程序页面时，是否自动暂停本页面的视频 |\n| auto-pause-if-open-native | Boolean | - | 当跳转到其它微信原生页面时，是否自动暂停本页面的视频 |\n| vslide-gesture | Boolean | false | 在非全屏模式下，是否开启亮度与音量调节手势（同 page-gesture） |\n| vslide-gesture-in-fullscreen | Boolean | true | 在全屏模式下，是否开启亮度与音量调节手势 |\n| ad-unit-id | String | - | 视频前贴广告单元ID |\n| poster-for-crawler | String | - | 用于给搜索等场景作为视频封面展示，建议使用无播放 icon 的视频封面图，只支持网络地址 |\n| codec | String | hardware | 解码器选择 |\n| http-cache | Boolean | false | 是否对 http、https 视频源开启本地缓存 |\n| play-strategy | Number | 0 | 播放策略 |\n| is-live | Boolean | - | 是否为直播源 |\n| @play | (event: [Event](/uni-app-x/component/common#event)) => void | - | 当开始/继续播放时触发play事件 |\n| @pause | (event: [Event](/uni-app-x/component/common#event)) => void | - | 当暂停播放时，触发pause事件 |\n| @ended | (event: [Event](/uni-app-x/component/common#event)) => void | - | 当播放到视频末尾时触发ended事件 |\n| @timeupdate | (event: [Event](/uni-app-x/component/common#event)) => void | - | 播放进度变化时触发，event.detail = {currentTime, duration} 。触发频率 250ms 一次 |\n| @fullscreenchange | (event: [Event](/uni-app-x/component/common#event)) => void | - | 当视频进入和退出全屏是触发，event.detail = {fullScreen, direction}，direction取为 vertical 或 horizontal |\n| @waiting | (event: [Event](/uni-app-x/component/common#event)) => void | - | 视频出现缓冲时触发 |\n| @error | (event: [Event](/uni-app-x/component/common#event)) => void | - | 播放出错试触发事件 |\n| @progress | (event: [Event](/uni-app-x/component/common#event)) => void | - | 加载进度变化时触发，只支持一段加载。event.detail = {buffered}，百分比 |\n| @loadedmetadata | (event: [Event](/uni-app-x/component/common#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| play-btn-position | 5.0 | x | x | 9.0 | x | - |\n| auto-pause-if-navigate | 5.0 | x | x | 9.0 | x | - |\n| auto-pause-if-open-native | 5.0 | x | x | 9.0 | x | - |\n| ad-unit-id | 5.0 | x | x | 9.0 | x | - |\n| poster-for-crawler | 5.0 | x | x | 9.0 | x | - |\n| is-live | 5.0 | x | x | 9.0 | x | - |\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 | {\"progress\":{\"color\":\"#00FF00\"}} | 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; }](#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: string; }](#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 +{ + "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": "多选项、在1组check-group中可选择多个", + "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```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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n\n##### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n#### CheckboxGroupChangeEventDetail\n\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 | false | 图片显示动画效果 |\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```mermaid\nclassDiagram\n\nEvent <|-- ImageErrorEvent : Extend\n```\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [{ errMsg: string; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n#### ImageLoadEvent\n\n```mermaid\nclassDiagram\n\nEvent <|-- ImageLoadEvent : Extend\n```\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [{ width: number; height: number; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\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.0 | 9.0 | √ | x |\n| mode | 5.0 | √ | 3.9.0 | 9.0 | √ | x |\n| fade-show | 5.0 | √ | 3.9.0 | 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| confirm-hold | Boolean | - | 点击键盘右下角按钮时是否保持键盘不收起 |\n| cursor | Number | - | 指定focus时的光标位置 |\n| selection-start | Number | - | 光标起始位置，自动聚集时有效，需与selection-end搭配使用 |\n| selection-end | Number | - | 光标结束位置，自动聚集时有效，需与selection-satrt搭配使用 |\n| adjust-position | Boolean | - | 键盘弹起时，是否自动上推页面 |\n| @input | (event: [InputEvent](#inputevent)) => void | - | 当键盘输入时，触发input事件，event.detail = {value, cursor}，处理函数可以直接 return 一个字符串，将替换输入框的内容。 |\n| @focus | (event: [InputFocusEvent](#inputfocusevent)) => void | - | 输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度，在基础库 1.9.90 起支持 |\n| @blur | (event: [InputBlurEvent](#inputblurevent)) => void | - | 输入框失去焦点时触发，event.detail = {value: value} |\n| @keyboardheightchange | (event: [InputKeyboardHeightChangeEvent](#inputkeyboardheightchangeevent)) => void | - | 键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration} |\n| @confirm | (event: [InputConfirmEvent](#inputconfirmevent)) => void | - | 点击完成按钮时触发，event.detail = {value: value} |\n\n#### type @type-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| text | 文本输入键盘 |\n| number | 数字输入键盘 |\n| idcard | 身份证输入键盘 |\n| digit | 带小数点数字输入键盘 |\n| tel | 电话输入键盘 |\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", + "event": "", + "compatibility": "\n### 兼容性\n| | 安卓系统版本 | 安卓 uni-app | 安卓 uni-app-x | iOS 系统版本 | iOS uni-app | iOS uni-app-x |\n| :- | :- | :- | :- | :- | :- | :- |\n| type | x | x | x | x | x | x |\n| type | x | x | x | x | x | x |\n| type | x | x | x | x | x | x |\n", + "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 | 45 | 设置自定义下拉刷新阈值 |\n| refresher-max-drag-distance | Number | - | 设置下拉最大拖拽距离（单位px），默认是下拉刷新控件高度的2.5倍 |\n| refresher-default-style | String | black | 设置自定义下拉刷新默认样式，支持设置 black，white，none，none 表示不使用默认样式 |\n| refresher-background | String | #FFF | 设置自定义下拉刷新区域背景颜色 |\n| refresher-triggered | Boolean | false | 设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发 |\n| custom-nested-scroll | Boolean | - | 子节点是否开启嵌套滚动 将滚动事件与父节点协商处理 |\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```mermaid\nclassDiagram\n\nEvent <|-- RefresherEvent : Extend\n```\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [{ dy: number; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n#### ScrollToUpperEvent\n\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToUpperEvent : Extend\n```\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [{ direction: string; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollToLowerEvent\n\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToLowerEvent : Extend\n```\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [{ direction: string; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollEvent\n\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; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\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| custom-nested-scroll | 5.0 | x | 3.9+ | - | - | - |\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```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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n\n##### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n#### PickerViewChangeEventDetail\n\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```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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n\n##### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n#### ProgressActiveendEventDetail\n\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": "单选项。在1组radio-group中只能选中1个", + "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/component/common#mouseevent)) => void | - | 组件被点击时触发 |", + "event": "\n### 事件\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\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/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```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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n\n##### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n#### RadioGroupChangeEventDetail\n\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": "富文本。可渲染文字样式、图片、超链接。支持部分HTML标签", + "attrubute": "### 参数 \n| 名称 | 类型 | 默认值 | 描述 |\n| :- | :- | :- | :- |\n| nodes | Array \\| String | - | 节点列表 \\| HTML String |\n| @itemclick | (event: [RichTextItemClickEvent](#richtextitemclickevent)) => void | - | 拦截点击事件（只支持 a、img标签），返回用户自定义数据或img标签的src属性或a标签的href属性。event.detail={ ref \\| src \\| href } |", + "event": "\n### 事件\n#### RichTextItemClickEvent\n\n```mermaid\nclassDiagram\n\nEvent <|-- RichTextItemClickEvent : Extend\n```\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [{ ref: string; src: string; href: string; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\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-max-drag-distance | Number | - | 设置下拉最大拖拽距离（单位px），默认是下拉刷新控件高度的2.5倍 |\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| custom-nested-scroll | Boolean | - | 子节点是否开启嵌套滚动 将滚动事件与父节点协商处理 |\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} |\n| @startnestedscroll | (event: [StartNestedScrollEvent](#startnestedscrollevent)) => Boolean | - | 子节点开始滚动时触发, return ture表示与子节点开启滚动协商 默认return false! event = {node} |\n| @nestedprescroll | (event: [NestedPreScrollEvent](#nestedprescrollevent)) => void | - | 子节点滚动时触发，可执行event.consumed(x,y)告知子节点deltaX、deltaY各消耗多少。子节点将执行差值后的deltaX、deltaY滚动距离。不执行consumed(x,y)则表示父节点不消耗deltaX、deltaY。event = {deltaX, deltaY} |\n| @stopnestedscroll | (event: [Event](/uni-app-x/component/common#event)) => void | - | 子节点滚动结束或意外终止时触发 |", + "event": "\n### 事件\n#### RefresherEvent\n\n```mermaid\nclassDiagram\n\nEvent <|-- RefresherEvent : Extend\n```\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [{ dy: number; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n#### ScrollToUpperEvent\n\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToUpperEvent : Extend\n```\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [{ direction: string; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollToLowerEvent\n\n```mermaid\nclassDiagram\n\nEvent <|-- ScrollToLowerEvent : Extend\n```\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [{ direction: string; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### ScrollEvent\n\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; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\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| custom-nested-scroll | 5.0 | x | 3.9+ | - | - | - |\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| @startnestedscroll | 5.0 | x | 3.9+ | - | - | - |\n| @nestedprescroll | 5.0 | x | 3.9+ | - | - | - |\n| @stopnestedscroll | 5.0 | x | 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```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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n\n##### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n#### SliderChangeEventDetail\n\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/component/common#event)) => void | - | current 改变时会触发 change 事件，event.detail = {current: current, source: source} |\n| @transition | (event: [Event](/uni-app-x/component/common#event)) => void | - | swiper-item 的位置发生改变时会触发 transition 事件，event.detail = {dx: dx, dy: dy} |\n| @animationfinish | (event: [Event](/uni-app-x/component/common#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": "\n### 事件\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n", + "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```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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### CustomEventOptions\n\n\n##### 构造函数\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | T | 是 | - |\n\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n#### SwitchChangeEventDetail\n\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 | false | 文本是否可选 |\n| space | String | - | 显示连续空格 [space](#space-values) |\n| decode | Boolean | false | 是否解码 |\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| cursor-spacing | Number | - | 指定光标与键盘的距离，单位 px 。取 textarea 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离 |\n| selection-start | Number | - | 光标起始位置，自动聚集时有效，需与selection-end搭配使用 |\n| selection-end | Number | - | 光标结束位置，自动聚集时有效，需与selection-satrt搭配使用 |\n| adjust-position | Boolean | - | 键盘弹起时，是否自动上推页面 |\n| @confirm | (event: [InputConfirmEvent](#inputconfirmevent)) => void | - | 点击完成时， 触发 confirm 事件，event.detail = {value: value} |\n| @input | (event: [InputEvent](#inputevent)) => void | - | 当键盘输入时，触发 input 事件，event.detail = {value, cursor}， @input 处理函数的返回值并不会反映到 textarea 上 |\n| @linechange | (event: [TextareaLineChangeEvent](#textarealinechangeevent)) => void | - | 输入框行数变化时调用，event.detail = {height: 0, heightRpx: 0, lineCount: 0} |\n| @blur | (event: [TextareaBlurEvent](#textareablurevent)) => void | - | 输入框失去焦点时触发，event.detail = {value, cursor} |\n| @keyboardheightchange | (event: [InputKeyboardHeightChangeEvent](#inputkeyboardheightchangeevent)) => void | - | 键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration} |\n| @focus | (event: [TextareaFocusEvent](#textareafocusevent)) => 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", + "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 | false | 是否循环播放 |\n| src | String\\|TagVideoURIString | - | 视频资源地址 |\n| initial-time | Number | - | 指定视频初始播放位置 |\n| duration | Number | - | 指定视频长度 |\n| controls | Boolean | true | 是否显示默认播放控件（播放/暂停按钮、播放进度、时间） |\n| danmu-list | Array | - | 弹幕列表 |\n| danmu-btn | Boolean | false | 是否显示弹幕按钮，只在初始化时有效，不能动态变更 |\n| enable-danmu | Boolean | false | 是否展示弹幕，只在初始化时有效，不能动态变更 |\n| autoplay | Boolean | false | 是否自动播放 |\n| muted | Boolean | false | 是否静音播放 |\n| page-gesture | Boolean | false | 在非全屏模式下，是否开启亮度与音量调节手势 |\n| direction | Number | -90 | 设置全屏时视频的方向，不指定则根据宽高比自动判断。有效值为 0（正常竖向）, 90（屏幕逆时针90度）, -90（屏幕顺时针90度） |\n| show-progress | Boolean | true | 若不设置，宽度大于240时才会显示 |\n| show-fullscreen-btn | Boolean | true | 是否显示全屏按钮 |\n| show-play-btn | Boolean | true | 是否显示视频底部控制栏的播放按钮 |\n| show-center-play-btn | Boolean | true | 是否显示视频中间的播放按钮 |\n| show-loading | Boolean | true | 是否显示loading控件 |\n| enable-progress-gesture | Boolean | true | 是否开启控制进度的手势 |\n| objectFit | String | contain | 当视频大小与 video 容器大小不一致时，视频的表现形式。 [objectFit](#objectFit-values) |\n| poster | String | - | 视频封面的图片网络资源地址，如果 controls 属性值为 false 则设置 poster 无效 |\n| show-mute-btn | Boolean | false | 是否显示静音按钮 |\n| title | String | - | 视频的标题，全屏时在顶部展示 |\n| play-btn-position | String | - | 播放按钮的位置 |\n| enable-play-gesture | Boolean | false | 是否开启播放手势，即双击切换播放、暂停 |\n| auto-pause-if-navigate | Boolean | - | 当跳转到其它小程序页面时，是否自动暂停本页面的视频 |\n| auto-pause-if-open-native | Boolean | - | 当跳转到其它微信原生页面时，是否自动暂停本页面的视频 |\n| vslide-gesture | Boolean | false | 在非全屏模式下，是否开启亮度与音量调节手势（同 page-gesture） |\n| vslide-gesture-in-fullscreen | Boolean | true | 在全屏模式下，是否开启亮度与音量调节手势 |\n| ad-unit-id | String | - | 视频前贴广告单元ID |\n| poster-for-crawler | String | - | 用于给搜索等场景作为视频封面展示，建议使用无播放 icon 的视频封面图，只支持网络地址 |\n| codec | String | hardware | 解码器选择 |\n| http-cache | Boolean | false | 是否对 http、https 视频源开启本地缓存 |\n| play-strategy | Number | 0 | 播放策略 |\n| is-live | Boolean | - | 是否为直播源 |\n| @play | (event: [Event](/uni-app-x/component/common#event)) => void | - | 当开始/继续播放时触发play事件 |\n| @pause | (event: [Event](/uni-app-x/component/common#event)) => void | - | 当暂停播放时，触发pause事件 |\n| @ended | (event: [Event](/uni-app-x/component/common#event)) => void | - | 当播放到视频末尾时触发ended事件 |\n| @timeupdate | (event: [Event](/uni-app-x/component/common#event)) => void | - | 播放进度变化时触发，event.detail = {currentTime, duration} 。触发频率 250ms 一次 |\n| @fullscreenchange | (event: [Event](/uni-app-x/component/common#event)) => void | - | 当视频进入和退出全屏是触发，event.detail = {fullScreen, direction}，direction取为 vertical 或 horizontal |\n| @waiting | (event: [Event](/uni-app-x/component/common#event)) => void | - | 视频出现缓冲时触发 |\n| @error | (event: [Event](/uni-app-x/component/common#event)) => void | - | 播放出错试触发事件 |\n| @progress | (event: [Event](/uni-app-x/component/common#event)) => void | - | 加载进度变化时触发，只支持一段加载。event.detail = {buffered}，百分比 |\n| @loadedmetadata | (event: [Event](/uni-app-x/component/common#event)) => void | - | 视频元数据加载完成时触发。event.detail = {width, height, duration} |\n\n#### objectFit @objectFit-values \n\n| 值名称 | 描述 |\n| :- | :- |\n| contain | 包含 |\n| fill | 填充 |\n| cover | 覆盖 |\n", + "event": "\n### 事件\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n", + "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| play-btn-position | 5.0 | x | x | 9.0 | x | - |\n| auto-pause-if-navigate | 5.0 | x | x | 9.0 | x | - |\n| auto-pause-if-open-native | 5.0 | x | x | 9.0 | x | - |\n| ad-unit-id | 5.0 | x | x | 9.0 | x | - |\n| poster-for-crawler | 5.0 | x | x | 9.0 | x | - |\n| is-live | 5.0 | x | x | 9.0 | x | - |\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 | {\"progress\":{\"color\":\"#00FF00\"}} | 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```mermaid\nclassDiagram\n\nEvent <|-- WebViewMessageEvent : Extend\n```\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [{ data: any; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### UTSJSONObject\n\n\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| getAny | (key: string) => any | 是 | 获取一个 属性，返回类型是any 或者 null |\n| getBoolean | (key: string) => boolean | 是 | 获取一个Boolean属性，返回类型是Boolean 或者 null |\n| getNumber | (key: string) => number | 是 | 获取一个number属性，返回类型是number 或者 null |\n| getString | (key: string) => string | 是 | 获取一个string属性，返回类型是string 或者 null |\n| getJSON | (key: string) => UTSJSONObject | 是 | 获取一个UTSJSONObject属性，返回类型是UTSJSONObject 或者 null |\n| getArray | (key: string) => any\\[\\] | 是 | 获取一个Array属性，返回类型是Array 或者 null |\n| toMap | () => Map\\ | 是 | 将当前 UTSJSONObject 实例转换为 Map 实例。 |\n\n#### WebViewErrorEvent\n\n```mermaid\nclassDiagram\n\nEvent <|-- WebViewErrorEvent : Extend\n```\n#### 属性值\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| detail | [{ errMsg: string; }](#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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### WebViewLoadedEvent\n\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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\n| stopPropagation | () => void | 是 | 阻止当前事件的进一步传播 |\n| preventDefault | () => void | 是 | 阻止当前事件的默认行为 |\n\n#### WebViewLoadingEvent\n\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\n#### 方法\n| 名称 | 类型 | 必填 | 描述 |\n| :- | :- | :- | :- |\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/common/error.md b/docs/uni-app-x/common/error.md deleted file mode 100644 index 764d287481de7742c2c7428a631354e6d73d16f0..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/common/error.md +++ /dev/null @@ -1,10 +0,0 @@ -## Error - - - - - - - - - diff --git a/docs/uni-app-x/common/unierror.md b/docs/uni-app-x/common/unierror.md deleted file mode 100644 index 11c6f0b6189e213215bd173c676fb7e2845e2cdd..0000000000000000000000000000000000000000 --- a/docs/uni-app-x/common/unierror.md +++ /dev/null @@ -1,10 +0,0 @@ -## UniError - - - - - - - - - diff --git a/docs/uni-app-x/component/common.md b/docs/uni-app-x/component/common.md index 0ddd546946ce0e3112d8ce2f32782f99fe70e5f9..a33a4ee2bf0d6348758e2893ceccfdef78fbbc6d 100644 --- a/docs/uni-app-x/component/common.md +++ b/docs/uni-app-x/component/common.md @@ -87,28 +87,76 @@ handleClick (event : MouseEvent) { - - + + +### 方法 + + + + + + + + + + + + + + + + + + + + + + + + ## CustomEvent - - + + +### 方法 + + + + + + + + + + + + + + + + + + + + + + + + ## CustomEventOptions - - @@ -117,29 +165,72 @@ handleClick (event : MouseEvent) { - - +### 方法 + + + + + + + + + + + + + + + + + + + + + + + + ## TouchEvent - - +### 方法 + + + + + + + + + + + + + + + + + + + + + + + + ## Touch - - - diff --git a/docs/uni-app-x/dom/cssstyledeclaration.md b/docs/uni-app-x/dom/cssstyledeclaration.md index 71bd98edfbf778e77fc6ae4fcb648b76fc22a74f..9b30496ccf93bf0718382af1416ae5d07711d714 100644 --- a/docs/uni-app-x/dom/cssstyledeclaration.md +++ b/docs/uni-app-x/dom/cssstyledeclaration.md @@ -1,25 +1,35 @@ -# CSSStyleDeclaration +## CSSStyleDeclaration - - +### 方法 + + + + + + + + + + + + + + + -## setProperty(name, value)@setProperty + -```ts -CSSStyleDeclaration.setProperty(name:string, value:any):void -``` + -## getPropertyValue(property)@getPropertyValue + -```ts -CSSStyleDeclaration.getPropertyValue(property:string):any? -``` + ## 示例 ```html diff --git a/docs/uni-app-x/dom/domrect.md b/docs/uni-app-x/dom/domrect.md index 611b5cfc1d88ef57bb6443e5db1ad32910e8ef09..edfd26a9ea268a27a0dbab93dc17dd0612082d0b 100644 --- a/docs/uni-app-x/dom/domrect.md +++ b/docs/uni-app-x/dom/domrect.md @@ -2,9 +2,6 @@ - - - diff --git a/docs/uni-app-x/dom/drawablecontext.md b/docs/uni-app-x/dom/drawablecontext.md index 008a548b63d510e479ff9e7b37cada2efeab0310..caebc295b842522a59b3909143ce1897649b0fff 100644 --- a/docs/uni-app-x/dom/drawablecontext.md +++ b/docs/uni-app-x/dom/drawablecontext.md @@ -2,8 +2,188 @@ - - + +### 方法 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/uni-app-x/dom/inode.md b/docs/uni-app-x/dom/inode.md index a05de17190d90ef1dc1c6b885a75a03a00c4c2ed..c421d266b965c774d42707a779d45926b92c1e2a 100644 --- a/docs/uni-app-x/dom/inode.md +++ b/docs/uni-app-x/dom/inode.md @@ -2,8 +2,199 @@ - - + +### 方法 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +