[ { "key": "alipay", "value": [ { "key": "button", "value": { "title": "button", "type": "object", "properties": { "size": { "type": "string", "description": "有效值 default, mini（小尺寸）。", "defaultValue": "default", "enum": [ "default", "mini" ] }, "type": { "type": "string", "description": "按钮的样式类型，有效值 primary、default、warn。", "defaultValue": "default", "enum": [ "primary", "default", "warn" ] }, "plain": { "type": "boolean", "description": "是否镂空（ghost 与 plain 等效）。", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false }, "loading": { "type": "boolean", "description": "按钮文字前是否带 loading 图标。", "defaultValue": false }, "hover-class": { "type": "string", "description": "按钮按下去的样式类。button-hover 默认为 {background-color: rgba(0, 0, 0, 0.1); opacity: 0.7;}，hover-class=\"none\" 时表示没有被点击效果。", "defaultValue": "button-hover" }, "hover-start-time": { "type": "number", "description": "按住后多少时间后出现点击状态，单位毫秒。", "defaultValue": 20 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击状态保留时间，单位毫秒。", "defaultValue": 70 }, "hover-stop-propagation": { "type": "boolean", "description": "是否阻止当前元素的祖先元素出现被点击样式。", "defaultValue": false }, "form-type": { "type": "string", "description": "有效值：submit、 reset，用于 form 表单 组件，点击分别会触发 submit/reset 事件。" }, "open-type": { "type": "string", "description": "开放能力。", "enum": [ "share", "getAuthorize", "contactShare", "lifestyle" ] }, "scope": { "type": "string", "description": "当 open-type 为 getAuthorize 时有效。", "enum": [ "phoneNumber", "userInfo" ] }, "onTap": { "tsType": "() => void", "description": "点击。\n说明： 每点击一次会触发一次事件，建议自行使用代码防止重复点击,可以使用 js 防抖和节流实现。" }, "public-id": { "type": "string", "description": "生活号 id，必须是当前小程序同主体且已关联的生活号，open-type=\"lifestyle\" 时有效。" }, "onGetAuthorize": { "tsType": "() => void", "description": "当 open-type 为 getAuthorize 时有效。\n当授权成功时触发。" }, "onFollowLifestyle": { "tsType": "() => void", "description": "当 open-type 为 lifestyle 时有效。\n当点击按钮时触发。\nevent.detail = { followStatus }，folllowStatus 合法值有 1、2、3，其中 1 表示已关注。2 表示用户不允许关注。3 表示发生未知错误；\n已知问题：基础库 1.0，当用户在点击按钮前已关注生活号，event.detail.followStatus 的值为 true。" }, "onError": { "tsType": "() => void", "description": "当 open-type 为 getAuthorize 时有效。\n当授权失败时触发。event.detail = {type, errorMessage}，此时 type 的值为 getAuthorize。" }, "onGetUserInfo": { "tsType": "() => void", "description": "当 open-type 为 getAuthorize 且 scope 为 userInfo 时有效。\n当授权成功时触发。" }, "onGetPhoneNumber": { "tsType": "() => void", "description": "当 open-type 为 getAuthorize 且 scope 为 phoneNumber 时有效。\n当授权成功时触发。" } }, "additionalProperties": false } }, { "key": "camera", "value": { "title": "camera", "type": "object", "properties": { "mode": { "type": "string", "description": "应用模式。", "defaultValue": "normal", "enum": [ "normal", "scanCode" ] }, "device-position": { "type": "string", "description": "摄像头朝向，前置或后置。", "defaultValue": "back", "enum": [ "front", "back" ] }, "flash": { "type": "string", "description": "闪光灯。", "defaultValue": "auto", "enum": [ "auto", "on", "off" ] }, "output-dimension": { "type": "string", "description": "相机拍照，录制的分辨率。", "defaultValue": "720P", "enum": [ "360P", "540P", "720P", "1080P", "max" ] }, "frame-size": { "type": "string", "description": "指定期望的相机帧数据尺寸。", "defaultValue": "medium", "enum": [ "small", "medium", "large" ] }, "onReady": { "tsType": "() => void", "description": "相机初始化成功时触发。" }, "onStop": { "tsType": "() => void", "description": "摄像头在非正常终止时触发，如退出后台等情况。" }, "onError": { "tsType": "() => void", "description": "用户不允许使用摄像头时触发。event.detail = { errorCode, errorMessage }。" }, "onScanCode": { "tsType": "() => void", "description": "在扫码识别成功时触发，仅在 mode=\"scanCode\" 时生效。" } }, "additionalProperties": false } }, { "key": "canvas", "value": { "title": "canvas", "type": "object", "properties": { "id": { "type": "string", "description": "组件唯一标识符。\n注意：同一页面中的 id 不可重复。" }, "style": { "type": "string", "description": "-" }, "class": { "type": "string", "description": "-" }, "width": { "type": "string", "defaultValue": "300px" }, "height": { "type": "string", "defaultValue": "225px" }, "disable-scroll": { "type": "boolean", "description": "禁止屏幕滚动以及下拉刷新。", "defaultValue": false }, "onTap": { "tsType": "() => void", "description": "点击。" }, "onTouchStart": { "tsType": "() => void", "description": "触摸动作开始。" }, "onTouchMove": { "tsType": "() => void", "description": "触摸后移动。" }, "onTouchEnd": { "tsType": "() => void", "description": "触摸动作结束。" }, "onTouchCancel": { "tsType": "() => void", "description": "触摸动作被打断，如来电提醒，弹窗。" }, "onLongTap": { "tsType": "() => void", "description": "长按 500ms 之后触发，触发了长按事件后进行移动将不会触发屏幕的滚动。" }, "type": { "type": "string", "description": "类型。设置 type 属性后，会渲染成 native canvas。\n可选值：2d、webgl" }, "onReady": { "tsType": "() => void", "description": "canvas 组件初始化成功触发。" } }, "additionalProperties": false } }, { "key": "checkbox-group", "value": { "title": "checkbox-group", "type": "object", "properties": { "name": { "type": "string", "description": "组件名字，用于表单提交获取数据。" }, "onChange": { "tsType": "() => void", "description": "中选中项发生改变时触发， detail = {value: 选中的 checkbox 项 value 的值}。" } }, "additionalProperties": false } }, { "key": "checkbox", "value": { "title": "checkbox", "type": "object", "properties": { "value": { "type": "string", "description": "组件值，选中时 change 事件会携带的 value。" }, "checked": { "type": "boolean", "description": "当前是否选中，可用来设置默认选中。", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false }, "onChange": { "tsType": "() => void", "description": "组件发生改变时触发，detail = {value: 该 checkbox 是否 checked }。" }, "color": { "type": "string", "description": "checkbox 的颜色，同 CSS 色值。" } }, "additionalProperties": false } }, { "key": "contact-button", "value": { "title": "contact-button", "type": "object", "properties": { "tnt-inst-id": { "type": "string", "description": "必填。企业唯一编码，一个企业支付宝账号对应一个编码。" }, "scene": { "type": "string", "description": "必填。聊天窗编码，每个聊天窗的唯一编码。" }, "size": { "type": [ "number", "string" ], "description": "选填。咨询按钮大小，正方形设置边长（如 25*25 px）。", "defaultValue": "25" }, "color": { "type": "string", "description": "选填。咨询按钮颜色，默认白底蓝色。", "defaultValue": "#00A3FF" }, "icon": { "type": "imgUrl", "description": "选填。咨询按钮头像。" }, "alipay-card-no": { "type": "string", "description": "选填。支付宝访客用户 ID（2088 开头）。\n说明： 客服回答问题时，如客户已离开咨询窗口，则通过推送消息到支付宝 card 中提醒客户。" }, "ext-info": { "type": "string", "description": "选填。该属性主要用于传递一些扩展信息给组件，以实现一些高级功能。该属性值的生成方式为：encodeURIComponent({\"字段名\":\"字段值\"})， 其中，字段名和字段值要根据实际使用的功能进行替换。\n目前通过传入扩展信息可支持的 3 个功能：\n1.访客名片。需传 cinfo 和 key 两个扩展字段，代码形如在云客服中进入 设置 > 服务窗配置，点击操作栏中的 部署 ，获取 tntInstId（企业编码）和 scene（聊天窗编码）。encodeURIComponent({\"cinfo\":\"生成的 cinfo\",\"key\":\"生成的key\"})，cinfo 和 key 的值说明 支付宝小程序接入访客名片；\n2.聊天窗默认带出用户的小程序订单数据。需传 appId 字段，代码形如encodeURIComponent({\"appId\":\"商户小程序appid\"})\n3.未读客服消息同步至\"我的小程序-我的\"。同样需传 appId 字段，代码形如 encodeURIComponent({\"appId\":\"商户小程序appid\"})。" } }, "additionalProperties": false } }, { "key": "cover-image", "value": { "title": "cover-image", "type": "object", "properties": { "src": { "type": "string", "description": "图片地址，支持的地址格式同 image 一致。" }, "onTap": { "tsType": "() => void", "description": "点击事件回调。" } }, "additionalProperties": false } }, { "key": "cover-view", "value": { "title": "cover-view", "type": "object", "properties": { "class": { "type": "string", "description": "外部样式名。" }, "style": { "type": "string", "description": "内联样式名。" }, "scroll-x": { "type": "boolean", "description": "允许横向滚动。", "defaultValue": false }, "scroll-y": { "type": "boolean", "description": "允许纵向滚动。", "defaultValue": false }, "upper-threshold": { "type": "number", "description": "距顶部/左边多远时（单位px），触发 scrolltoupper 事件。", "defaultValue": "50" }, "lower-threshold": { "type": "number", "description": "距底部/右边多远时（单位px），触发 scrolltolower 事件。", "defaultValue": "50" }, "scroll-top": { "type": "number", "description": "设置竖向滚动条位置。" }, "scroll-left": { "type": "number", "description": "设置横向滚动条位置。" }, "scroll-into-view": { "type": "string", "description": "滚动到子元素，值应为某子元素的 id。当滚动到该元素时，元素顶部对齐滚动区域顶部。\n说明：scroll-into-view 的优先级高于 scroll-top。" }, "scroll-with-animation": { "type": "boolean", "description": "在设置滚动条位置时使用动画过渡。", "defaultValue": false }, "scroll-animation-duration": { "type": "number", "description": "当 scroll-with-animation设置为 true 时，可以设置 scroll-animation-duration 来控制动画的执行时间，单位 ms。" }, "enable-back-to-top": { "type": "boolean", "description": "当点击 iOS 顶部状态栏或者双击 Android 标题栏时，滚动条返回顶部，只支持竖向。", "defaultValue": false }, "trap-scroll": { "type": "boolean", "description": "纵向滚动时，当滚动到顶部或底部时，强制禁止触发页面滚动，仍然只触发 scroll-view 自身的滚动。", "defaultValue": false }, "onScrollToUpper": { "tsType": "() => void", "description": "滚动到顶部/左边，会触发 scrolltoupper 事件。" }, "onScrollToLower": { "tsType": "() => void", "description": "滚动到底部/右边，会触发 scrolltolower事件。" }, "onScroll": { "tsType": "() => void", "description": "滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth}。" }, "onTouchStart": { "tsType": "() => void", "description": "触摸动作开始。" }, "onTouchMove": { "tsType": "() => void", "description": "触摸后移动。" }, "onTouchEnd": { "tsType": "() => void", "description": "触摸动作结束。" }, "onTouchCancel": { "tsType": "() => void", "description": "触摸动作被打断，如来电提醒、弹窗。" }, "disable-lower-scroll": { "type": "string", "description": "发生滚动前，对滚动方向进行判断，当方向是顶部/左边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到顶部/左边，禁止滚动。" }, "disable-upper-scroll": { "type": "string", "description": "发生滚动前，对滚动方向进行判断，当方向是底部/右边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到底部/右边，禁止滚动。" } }, "additionalProperties": false } }, { "key": "error-view", "value": { "title": "error-view", "type": "object", "properties": { "fullscreen": { "type": "boolean", "description": "是否展示全屏错误视图，状态图案及文案大小会有差异。" }, "type": { "type": "string", "description": "异常类型。\n可选值：default、busy、error、network、trade", "defaultValue": "default" }, "title": { "type": "string", "description": "异常状态主要文案，详情可查看 默认界面及文案。" }, "message": { "type": "string", "description": "异常状态次要文案，仅在全屏状态显示，详情可查看 全屏状态。" }, "title-color": { "type": "hexColor", "description": "异常状态主要文案的自定义颜色。" }, "message-color": { "type": "hexColor", "description": "异常状态次要文案的自定义颜色。" } }, "additionalProperties": false } }, { "key": "form", "value": { "title": "form", "type": "object", "properties": { "report-submit": { "type": "boolean", "description": "onSubmit 回调是否返回 formId。用于发送 消息，使用前可使用 canIUse ('form.report-submit')判断是否支持。\n注意： formId 需要真机调试才会有返回值。" }, "onSubmit": { "tsType": "() => void", "description": "携带 form 中的数据触发 submit 事件，event.detail = {value : {'slider': '80'}, buttonTarget: {'dataset': 'buttonDataset'} } (可以在 submit 按钮上添加自定义参数)。" }, "onReset": { "tsType": "() => void", "description": "表单重置时会触发 reset 事件。" } }, "additionalProperties": false } }, { "key": "icon", "value": { "title": "icon", "type": "object", "properties": { "type": { "type": "string", "description": "icon 类型。有效值： info、warn、waiting、cancel、download、search、clear、success、success_no_circle、loading。", "enum": [ "info", "warn", "waiting", "cancel", "download", "search", "clear", "success", "success_no_circle", "loading" ] }, "size": { "type": "number", "description": "icon 大小，单位 px。", "defaultValue": 23 }, "color": { "type": "string", "description": "icon 颜色，同 CSS 色值。" } }, "additionalProperties": false } }, { "key": "image", "value": { "title": "image", "type": "object", "properties": { "src": { "type": "string", "description": "图片地址。" }, "mode": { "type": "string", "description": "图片模式。", "defaultValue": "scaleToFill" }, "class": { "type": "string", "description": "外部样式。" }, "style": { "type": "string", "description": "内联样式。" }, "lazy-load": { "type": "boolean", "description": "支持图片懒加载，不支持通过 css 来控制 image 展示隐藏的场景。", "defaultValue": false }, "default-source": { "type": "string", "description": "默认图片地址，若设置默认图片地址，会先显示默认图片，等 src 对应的图片加载成功后，再渲染对应的图片。" }, "onLoad": { "tsType": "() => void", "description": "图片载入完毕时触发，事件对象 event.detail = {height: '图片高度px', width: '图片宽度px'}。" }, "onError": { "tsType": "() => void", "description": "当图片加载错误时触发，事件对象 event.detail = {errMsg: 'something wrong'。" }, "onTap": { "tsType": "() => void", "description": "点击图片时触发。" }, "catchTap": { "tsType": "() => void", "description": "点击图片时触发，阻止事件冒泡。" } }, "additionalProperties": false } }, { "key": "input", "value": { "title": "input", "type": "object", "properties": { "value": { "type": "string", "description": "初始内容。" }, "name": { "type": "string", "description": "组件名字，用于表单提交获取数据。" }, "type": { "type": "string", "description": "input 的类型，有效值：text、 number、 idcard、 digit(可以唤起带有小数点的数字键盘)、numberpad、digitpad、 idcardpad。my.canIUse(\"input.type.numberpad\") 来检测。\n注意： 当启用数字键盘时，在 Android 客户端上，脱离文档流（如设置了 float 或 position: fixed 等样式）并指定了 bottom 属性的元素会被影响（该元素会被键盘顶起）。可以采用如下方法来暂且避免这个问题：当 input 框聚焦后隐藏被影响的元素。", "defaultValue": "text" }, "password": { "type": "boolean", "description": "是否是密码类型。", "defaultValue": false }, "placeholder": { "type": "string", "description": "占位符。" }, "placeholder-style": { "type": "string", "description": "指定 placeholder 的样式，可设置间距。" }, "placeholder-class": { "type": "string", "description": "指定 placeholder 的样式类。" }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大长度。", "defaultValue": 140 }, "focus": { "type": "boolean", "description": "获取焦点。", "defaultValue": false }, "confirm-type": { "type": "string", "description": "设置键盘右下角按钮的文字，有效值：done（显示“完成”）、go（显示“前往”）、next（显示“下一个”）、search（显示“搜索”）、send（显示“发送”），平台不同显示的文字略有差异。\n注意： 只有在 type=text 时有效。", "defaultValue": "done" }, "confirm-hold": { "type": "boolean", "description": "点击键盘右下角按钮时是否保持键盘不收起状态。", "defaultValue": false }, "cursor": { "type": "number", "description": "指定 focus 时的光标位置。" }, "selection-start": { "type": "number", "description": "获取光标时，选中文本对应的焦点光标起始位置，需要和 selection-end 配合使用。", "defaultValue": -1 }, "selection-end": { "type": "number", "description": "获取光标时，选中文本对应的焦点光标结束位置，需要和 selection-start 配合使用。", "defaultValue": -1 }, "random-number": { "type": "boolean", "description": "当 type 为 number, digit, idcard 数字键盘是否随机排列。", "defaultValue": false }, "controlled": { "type": "boolean", "description": "是否为受控组件。为 true 时，value 内容会完全受 setData 控制。\n建议当 type 值为 text 时不要将 controlled 设置为 true，详见 Bugs & Tips。", "defaultValue": false }, "always-system": { "type": "boolean", "description": "是否强制使用系统键盘和 Web-view 创建的 input 元素。为 true 时，confirm-type、confirm-hold 可能失效。", "defaultValue": false }, "onInput": { "tsType": "() => void", "description": "键盘输入时触发 input 事件，event.detail = {value: value,cursor: cursor}。" }, "onConfirm": { "tsType": "() => void", "description": "点击键盘完成时触发，event.detail = {value: value}" }, "onFocus": { "tsType": "() => void", "description": "聚焦时触发，event.detail = {value: value}。" }, "onBlur": { "tsType": "() => void", "description": "失去焦点时触发（仅支持真机），event.detail = {value: value}。" } }, "additionalProperties": false } }, { "key": "join-group-chat", "value": { "title": "join-group-chat", "type": "object", "properties": { "template-id": { "type": "string", "description": "必填，组件模板 ID，在商家平台生成。详情可查看下方 生成模板ID。" } }, "additionalProperties": false } }, { "key": "label", "value": { "title": "label", "type": "object", "properties": { "for": { "type": "string", "description": "绑定组件的 ID。" } }, "additionalProperties": false } }, { "key": "lifestyle", "value": { "title": "lifestyle", "type": "object", "properties": { "public-id": { "type": "string", "description": "必填，生活号 ID（即生活号 APPID），必须是当前小程序同账号主体且已关联的生活号。" }, "onFollow": { "tsType": "() => void", "description": "当用户关注生活号成功后执行。" }, "memo": { "type": "string", "description": "文案。支持商家自定义，最多展示一行。" } }, "additionalProperties": false } }, { "key": "lottie", "value": { "title": "lottie", "type": "object", "properties": { "autoplay": { "type": "boolean", "description": "是否自动播放。", "defaultValue": false }, "path": { "type": "string", "description": "Lottie 资源地址。包含近端（包内地址）和远端（网络）的 JSON 文件地址。" }, "speed": { "type": "float", "description": "播放速度。正数为正向播放，负数负向播放。", "defaultValue": "1.0" }, "repeat-count": { "type": "number", "description": "循环次数。\n\n如果是负数表示无限次。\n如果是 0 表示不循环，播放一次。\n如果是 1 表示循环一次，播放两次。", "defaultValue": 0 }, "auto-reverse": { "type": "boolean", "description": "是否自动回播。", "defaultValue": false }, "assets-path": { "type": "string", "description": "资源地址。\"/\" 表明是小程序根目录。" }, "placeholder": { "type": "string", "description": "兜底图或者降级图地址。\n\n1. 支持本地资源，案例：'/image/lottie/lottie2_default.png'。\n支持 http 的 cdn 地址、近端地址。" }, "md5": { "type": "string", "description": "在线资源的 md5 校验。\n可以使用 b.zip 加密 获取 md5 值\nmd5=\"77c6c86fc89ba94cc0a9271b77ae77d2\"" }, "optimize": { "type": "boolean", "description": "降级。降级是指如遇低端设备，Lottie 会降级展示为 placeholder。\n当 optimize 为 true ，并且传入了 placeholder 时，在低端设备上只会展示 placeholder，不展示 Lottie。\n低端设备如下所示：\n\niOS ：小于等于 iPhone6P\nAndroid：内存容量小于 3G", "defaultValue": false }, "onDataReady": { "tsType": "() => void", "description": "当数据下载+视图创建完成时触发。" }, "onDataFailed": { "tsType": "() => void", "description": "数据加载失败时触发。" }, "onAnimationStart": { "tsType": "() => void", "description": "动画开始时触发。" }, "onAnimationEnd": { "tsType": "() => void", "description": "动画结束时触发。" }, "onAnimationRepeat": { "tsType": "() => void", "description": "动画一次重播结束。" }, "onAnimationCancel": { "tsType": "() => void", "description": "动画取消。业务调用 Cancel 时回调。" }, "onDataLoadReady": { "tsType": "() => void", "description": "参数化时，数据准备完成，等待业务传入参数化值。" } }, "additionalProperties": false } }, { "key": "map", "value": { "title": "map", "type": "object", "properties": { "style": { "type": "string", "description": "内联样式。" }, "class": { "type": "string", "description": "样式名。" }, "latitude": { "type": "number", "description": "中心纬度。" }, "longitude": { "type": "number", "description": "中心经度。" }, "scale": { "type": "number", "description": "缩放级别，取值范围为 5-18。", "defaultValue": 16 }, "skew": { "type": "number", "description": "倾斜角度，范围 0 ~ 40 , 关于 z 轴的倾角。", "defaultValue": 0 }, "rotate": { "type": "number", "description": "顺时针旋转的角度，范围 0 ~ 360。", "defaultValue": 0 }, "markers": { "type": "array", "description": "覆盖物，在地图上的一个点绘制图标。" }, "polyline": { "type": "array", "description": "覆盖物，多个连贯点的集合（路线）。" }, "circles": { "type": "array", "description": "覆盖物，圆。" }, "controls": { "type": "array", "description": "在地图 View 之上的一个控件。" }, "polygon": { "type": "array", "description": "覆盖物，多边形。" }, "show-location": { "type": "boolean", "description": "是否显示带有方向的当前定位点。" }, "include-points": { "type": "array", "description": "视野将进行小范围延伸包含传入的坐标。\n\n[{\n\n   latitude: 30.279383,\n\n   longitude: 120.131441,\n\n}]" }, "include-padding": { "type": "object", "description": "视野在地图 padding 范围内展示。\n\n{\n\n    left:0, right:0,\n\n    top:0, bottom:0\n\n}" }, "ground-overlays": { "type": "array", "description": "覆盖物，自定义贴图。\n\n[{\n\n    // 刷新的时候需要变更id值\n\n    id:'0', \n\n    // 右上，左下\n\n    'include-points':[{\n\n        latitude: 39.935029,\n\n        longitude: 116.384377,\n\n    },{\n\n        latitude: 39.939577,\n\n        longitude: 116.388331,\n\n    }],\n\n    image:'/image/overlay.png',\n\n    alpha:0.25,\n\n    zIndex:1\n\n}]" }, "tile-overlay": { "type": "object", "description": "覆盖物，网格贴图。\n\n{\n\n    url:'http://xxx',\n\n    type:0, // url类型\n\n    tileWidth:256,\n\n    tileHeight:256,\n\n    zIndex:1,\n\n}" }, "custom-map-style": { "type": "string", "description": "设置地图样式。\n\ndefault：默认样式\nlight：精简样式" }, "panels": { "type": "array", "description": "基于 map 高级定制渲染，设置覆盖在地图上的 view。" }, "setting": { "type": "object", "description": "设置。\n\n{\n\n  // 手势\n\n  gestureEnable: 1,\n\n  // 比例尺\n\n  showScale: 1,\n\n  // 指南针\n\n  showCompass: 1,\n\n  //双手下滑\n\n  tiltGesturesEnabled: 1,\n\n  // 交通路况展示\n\n  trafficEnabled: 0,\n\n  // 地图 POI 信息\n\n  showMapText: 0,\n\n  // 高德地图 logo 位置\n\n  logoPosition: {\n\n    centerX: 150,\n\n    centerY: 90\n\n  }\n\n// 自定义地图样式\n\n customMapStyleSrc: \"/resources/style/style_v7.data\"\n\n}" }, "optimize": { "type": "string", "description": "内联样式。" }, "onMarkerTap": { "tsType": "() => void", "description": "点击 Marker 时触发。\n\n{\n\n    markerId,\n\n    latitude,\n\n    longitude, \n\n}" }, "onCalloutTap": { "tsType": "() => void", "description": "点击 Marker 对应的 callout 时触发。\n\n{\n\n    markerId,\n\n    latitude,\n\n    longitude, \n\n}" }, "onControlTap": { "tsType": "() => void", "description": "点击 control 时触发。\n\n{\n\n    controlId\n\n}" }, "onRegionChange": { "tsType": "() => void", "description": "视野发生变化时触发。\n\n基础库 1.24.0 版本新增 skew、rotate、causedBy 返回；\n\nbegin 阶段 causedBy 有效值为 update(接口触发)、gesture(手势触发)；\n\nend 阶段 causedBy 有效值为 update(接口触发)、drag/scale/skew/rotate (手势触发)。\n\n{\n\n    type: \"begin/end\", \n\n    latitude,\n\n    longitude, \n\n    scale,\n\n    skew,\n\n    rotate,\n\n    causedBy: \"update/gesture\"\n\n}" }, "onTap": { "tsType": "() => void", "description": "点击地图时触发。\n\n{\n\n    latitude,\n\n    longitude, \n\n}" }, "onPanelTap": { "tsType": "() => void", "description": "点击 panel 时触发。\n\n{ \n\n   panelId,\n\n   layoutId,\n\n}" }, "show-compass": { "type": "boolean", "description": "显示指南针。" }, "show-scale": { "type": "boolean", "description": "显示比例尺。" }, "enable-overlooking": { "type": "boolean", "description": "开启俯视。" }, "enable-zoom": { "type": "boolean", "description": "是否支持缩放。" }, "enable-scroll": { "type": "boolean", "description": "是否支持拖动。" }, "enable-rotate": { "type": "boolean", "description": "是否支持旋转。" }, "enable-traffic": { "type": "boolean", "description": "是否开启实时路况。" }, "enable-poi": { "type": "boolean", "description": "是否展示 POI 点。" }, "enable-building": { "type": "boolean", "description": "是否展示建筑物。" }, "enable-satellite": { "type": "boolean", "description": "是否开启卫星图。" }, "onInitComplete": { "tsType": "() => void", "description": "地图初始化完成即将开始渲染第一帧时触发。" } }, "additionalProperties": false } }, { "key": "match-media", "value": { "title": "match-media", "type": "object", "properties": { "min-width": { "type": "number", "description": "页面最小宽度。单位为 px。" }, "max-width": { "type": "number", "description": "页面最大宽度。单位为 px。" }, "width": { "type": "number", "description": "页面宽度。单位为 px。" }, "min-height": { "type": "number", "description": "页面最小高度。单位为 px。" }, "max-height": { "type": "number", "description": "页面最大高度。单位为 px。" }, "height": { "type": "number", "description": "页面高度。单位为 px。" }, "orientation": { "type": "string", "description": "屏幕方向。\n\nlandscape：横向\nportrait：纵向" } }, "additionalProperties": false } }, { "key": "movable-area", "value": { "title": "movable-area", "type": "object", "properties": { "scale-area": { "type": "boolean", "description": "否" } }, "additionalProperties": false } }, { "key": "movable-view", "value": { "title": "movable-view", "type": "object", "properties": { "direction": { "type": "string", "description": "movable-view 的移动方向，属性值有 all、vertical、horizontal、none。", "defaultValue": "none" }, "inertia": { "type": "boolean", "description": "movable-view 是否带有惯性。", "defaultValue": false }, "out-of-bounds": { "type": "boolean", "description": "超过可移动区域后，movable-view 是否还可以移动。", "defaultValue": false }, "x": { "type": "number", "description": "定义 x 轴方向的偏移，会换算为 left 属性，如果 x 的值不在可移动范围内，会自动移动到可移动范围。", "defaultValue": 0 }, "y": { "type": "number", "description": "定义 y 轴方向的偏移，会换算为 top 属性，如果 y 的值不在可移动范围内，会自动移动到可移动范围。", "defaultValue": 0 }, "damping": { "type": "number", "description": "阻尼系数，用于控制 x 或 y 改变时的动画和过界回弹的动画，值越大移动越快。", "defaultValue": 20 }, "friction": { "type": "number", "description": "摩擦系数，用于控制惯性滑动的动画，值越大摩擦力越大，滑动越快停止；必须大于 0，否则会被设置成", "defaultValue": 2 }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false }, "scale": { "type": "boolean", "description": "是否支持双指缩放，默认缩放手势生效区域是在 movable-view 内。", "defaultValue": false }, "scale-min": { "type": "number", "description": "定义缩放倍数最小值。", "defaultValue": 0.5 }, "scale-max": { "type": "number", "description": "定义缩放倍数最大值。", "defaultValue": 10 }, "scale-value": { "type": "number", "description": "定义缩放倍数，取值范围为 0.5 - 10。", "defaultValue": 1 }, "animation": { "type": "boolean", "description": "是否使用动画。", "defaultValue": false }, "onTouchStart": { "tsType": "() => void", "description": "触摸动作开始，事件会向父节点传递。" }, "catchTouchStart": { "tsType": "() => void", "description": "触摸动作开始，事件仅作用于组件，不向父节点传递。" }, "onTouchMove": { "tsType": "() => void", "description": "触摸移动事件，事件会向父节点传递。" }, "catchTouchMove": { "tsType": "() => void", "description": "触摸移动事件，事件仅作用于组件，不向父节点传递。" }, "onTouchEnd": { "tsType": "() => void", "description": "触摸动作结束，事件会向父节点传递。" }, "catchTouchEnd": { "tsType": "() => void", "description": "触摸动作结束，事件仅作用于组件，不向父节点传递。" }, "onTouchCancel": { "tsType": "() => void", "description": "触摸动作被打断，如来电提醒、弹窗。" }, "onChange": { "tsType": "() => void", "description": "拖动过程中触发的事件，event.detail = {x: x, y: y, source: source}，其中 source 表示产生移动的原因，值可为 touch（拖动）。" }, "onChangeEnd": { "tsType": "() => void", "description": "拖动结束触发的事件，event.detail = {x: x, y: y}。" }, "onScale": { "tsType": "() => void", "description": "缩放过程中触发的事件，event.detail = {x, y, scale}。" } }, "additionalProperties": false } }, { "key": "navigator", "value": { "title": "navigator", "type": "object", "properties": { "open-type": { "type": "string", "description": "跳转方式。", "defaultValue": "navigate", "enum": [ "navigate", "redirect", "switchTab", "navigateBack", "reLaunch", "exit" ] }, "hover-class": { "type": "string", "description": "点击后的样式类。", "defaultValue": "none" }, "hover-start-time": { "type": "number", "description": "按住后多少时间后出现点击状态，单位 ms。" }, "hover-stay-time": { "type": "number", "description": "手指松开后点击状态保留时间，单位 ms。" }, "url": { "type": "string", "description": "当前小程序内的跳转链接。" } }, "additionalProperties": false } }, { "key": "page-container", "value": { "title": "page-container", "type": "object", "properties": { "show": { "type": "boolean", "description": "是否显示容器组件。", "defaultValue": false }, "duration": { "type": "number", "description": "动画时长，单位毫秒。", "defaultValue": 300 }, "z-index": { "type": "number", "description": "z-index 层级。", "defaultValue": 100 }, "overlay": { "type": "boolean", "description": "是否显示遮罩层。", "defaultValue": true }, "position": { "type": "string", "description": "弹出位置。\n可选值： top、bottom、right、center。", "defaultValue": "bottom" }, "round": { "type": "boolean", "description": "是否显示圆角。", "defaultValue": false }, "close-on-slide-down": { "type": "boolean", "description": "是否在下滑一段距离后关闭。", "defaultValue": false }, "overlay-style": { "type": "string", "description": "自定义遮罩层样式。" }, "custom-style": { "type": "string", "description": "自定义弹出层样式。" }, "onBeforeEnter": { "tsType": "() => void", "description": "进入前触发。" }, "onEnter": { "tsType": "() => void", "description": "进入中触发。" }, "onEnterCancelled": { "tsType": "() => void", "description": "进入被打断时触发（通过 a: if 打断时不会触发）。" }, "onAfterEnter": { "tsType": "() => void", "description": "进入后触发。" }, "onBeforeLeave": { "tsType": "() => void", "description": "离开前触发。" }, "onLeave": { "tsType": "() => void", "description": "离开中触发。" }, "onLeaveCancelled": { "tsType": "() => void", "description": "离开被打断时触发（通过 a: if 打断时不会触发）。" }, "onAfterLeave": { "tsType": "() => void", "description": "离开后触发。" }, "onClickOverlay": { "tsType": "() => void", "description": "点击遮罩层时触发。" } }, "additionalProperties": false } }, { "key": "page-meta", "value": { "title": "page-meta", "type": "object", "properties": { "background-color": { "type": "string", "description": "窗口的背景色，必须为十六进制颜色值。" }, "background-color-top": { "type": "string", "description": "顶部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持。" }, "background-color-bottom": { "type": "string", "description": "底部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持。" }, "root-background-color": { "type": "string", "description": "页面内容的背景色，用于页面中的空白部分和页面大小变化 resize 动画期间的临时空闲区域。" }, "scroll-top": { "type": "string", "description": "滚动位置，可以使用 px 或者 rpx 为单位，在被设置时，页面会滚动到对应位置。" }, "scroll-duration": { "type": "number", "description": "滚动动画时长。", "defaultValue": 300 }, "page-style": { "type": "string", "description": "页面根节点样式，页面根节点是所有页面节点的祖先节点，相当于 HTML 中的 body 节点。" }, "page-font-size": { "type": "string", "description": "页面 page 的字体大小，可以设置为system，表示使用当前用户设置的支付宝字体大小。" }, "root-font-size": { "type": "string", "description": "页面的根字体大小，页面中的所有 rem 单位，将使用这个字体大小作为参考值，即 1rem 等于这个字体大小；\n\n可以设置为 system，表示使用当前用户设置的支付宝字体大小。" }, "onScroll": { "tsType": "() => void", "description": "页面滚动时触发，event.detail = { scrollTop }" } }, "additionalProperties": false } }, { "key": "picker-view", "value": { "title": "picker-view", "type": "object", "properties": { "value": { "type": "numberArray", "description": "数组中的数字表示 picker-view-column 中对应的 index （从 0 开始）。\n示例：value=“{{[2]}}”" }, "indicator-style": { "type": "string", "description": "选中框样式。" }, "indicator-class": { "type": "string", "description": "选中框的类名。" }, "mask-style": { "type": "string", "description": "蒙层的样式。" }, "mask-class": { "type": "string", "description": "蒙层的类名。" }, "immediate-change": { "type": "boolean", "description": "是否在手指松开时立即触发 change 事件，若不开启则会在滚动动画结束后触发 change 事件。", "defaultValue": false }, "onChange": { "tsType": "() => void", "description": "滚动选择 value 改变时触发，event.detail = {value: value} value 为数组，表示 picker-view 内的 picker-view-column index 索引 ，从 0 开始。" }, "onPickStart": { "tsType": "() => void", "description": "当滚动选择开始时候触发事件。" }, "onPickEnd": { "tsType": "() => void", "description": "当滚动选择结束时候触发事件。" } }, "additionalProperties": false } }, { "key": "picker", "value": { "title": "picker", "type": "object", "properties": { "title": { "type": "string", "description": "标题。" }, "range": { "type": [ "String[]", "Object[]" ], "description": "String[] 时表示可选择的字符串列表；Object[] 时需指定 range-key 表示可选择的字段。", "defaultValue": "[]" }, "range-key": { "type": "string", "description": "当 range 为 Object[] 时，通过 range-key 来指定 Object 中 key 的值作为选择器显示内容。" }, "value": { "type": "number", "description": "表示选择了 range 中的第几个（下标从 0 开始）。" }, "onChange": { "tsType": "() => void", "description": "value 改变时触发，event.detail = {value: value}。" }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false } }, "additionalProperties": false } }, { "key": "progress", "value": { "title": "progress", "type": "object", "properties": { "percent": { "type": "float", "description": "百分比(0~100)。" }, "show-info": { "type": "boolean", "description": "在右侧显示百分比值。", "defaultValue": false }, "stroke-width": { "type": "number", "description": "线的粗细，单位 px。", "defaultValue": 6 }, "active-color": { "type": "string", "description": "已选择的进度条颜色。", "defaultValue": "#09BB07" }, "background-color": { "type": "string", "description": "未选择的进度条颜色。" }, "active": { "type": "boolean", "description": "是否添加从 0% 开始加载的入场动画。", "defaultValue": false } }, "additionalProperties": false } }, { "key": "radio-group", "value": { "title": "radio-group", "type": "object", "properties": { "onChange": { "tsType": "() => void", "description": "选中项发生变化时触发，event.detail = {value: 选中项 radio 的 value}。" }, "name": { "type": "string", "description": "组件名字，用于表单提交获取数据。" } }, "additionalProperties": false } }, { "key": "radio", "value": { "title": "radio", "type": "object", "properties": { "value": { "type": "string", "description": "组件值，选中时 change 事件会携带的 value。" }, "checked": { "type": "boolean", "description": "当前是否选中。", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false }, "color": { "type": "string", "description": "radio 的颜色，同 CSS 色值。" } }, "additionalProperties": false } }, { "key": "rich-text", "value": { "title": "rich-text", "type": "object", "properties": { "nodes": { "type": [ "any[]", "string" ], "description": "节点列表。基础库 2.8.5 开始支持 HTML String，2.8.5 以下版本可使用 mini-html-parser2 将 HTML String 转化为 nodes 数组。" }, "space": { "type": "string", "description": "显示连续空格。\n有效值：\nnbsp：根据字体设置的空格大小。\nemsp：中文字符空格大小。\nensp：中文字符空格一半大小。" }, "onTap": { "tsType": "() => void", "description": "触摸。" }, "onTouchstart": { "tsType": "() => void", "description": "触摸动作开始。" }, "onTouchmove": { "tsType": "() => void", "description": "触摸移动事件。" }, "onTouchcancel": { "tsType": "() => void", "description": "触摸动作被打断。" }, "onTouchend": { "tsType": "() => void", "description": "触摸动作结束。" }, "onLongtap": { "tsType": "() => void", "description": "触摸后，超过 500ms 再离开。" } }, "additionalProperties": false } }, { "key": "root-portal", "value": { "title": "root-portal", "type": "object", "properties": { "enable": { "type": "boolean", "description": "是否从页面中脱离出来。", "defaultValue": true } }, "additionalProperties": false } }, { "key": "scroll-view", "value": { "title": "scroll-view", "type": "object", "properties": { "class": { "type": "string", "description": "外部样式名。" }, "style": { "type": "string", "description": "内联样式名。" }, "scroll-x": { "type": "boolean", "description": "允许横向滚动。", "defaultValue": false }, "scroll-y": { "type": "boolean", "description": "允许纵向滚动。", "defaultValue": false }, "upper-threshold": { "type": "number", "description": "距顶部/左边多远时（单位px），触发 scrolltoupper 事件。", "defaultValue": 50 }, "lower-threshold": { "type": "number", "description": "距底部/右边多远时（单位px），触发 scrolltolower 事件。", "defaultValue": 50 }, "scroll-top": { "type": "number", "description": "设置竖向滚动条位置。" }, "scroll-left": { "type": "number", "description": "设置横向滚动条位置。" }, "scroll-into-view": { "type": "string", "description": "滚动到子元素，值应为某子元素的 id。当滚动到该元素时，元素顶部对齐滚动区域顶部。\n说明：scroll-into-view 的优先级高于 scroll-top。" }, "scroll-with-animation": { "type": "boolean", "description": "在设置滚动条位置时使用动画过渡。", "defaultValue": false }, "scroll-animation-duration": { "type": "number", "description": "当 scroll-with-animation设置为 true 时，可以设置 scroll-animation-duration 来控制动画的执行时间，单位 ms。" }, "enable-back-to-top": { "type": "boolean", "description": "当点击 iOS 顶部状态栏或者双击 Android 标题栏时，滚动条返回顶部，只支持竖向。", "defaultValue": false }, "trap-scroll": { "type": "boolean", "description": "纵向滚动时，当滚动到顶部或底部时，强制禁止触发页面滚动，仍然只触发 scroll-view 自身的滚动。", "defaultValue": false }, "onScrollToUpper": { "tsType": "() => void", "description": "滚动到顶部/左边，会触发 scrolltoupper 事件。" }, "onScrollToLower": { "tsType": "() => void", "description": "滚动到底部/右边，会触发 scrolltolower事件。" }, "onScroll": { "tsType": "() => void", "description": "滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth}。" }, "onTouchStart": { "tsType": "() => void", "description": "触摸动作开始。" }, "onTouchMove": { "tsType": "() => void", "description": "触摸后移动。" }, "onTouchEnd": { "tsType": "() => void", "description": "触摸动作结束。" }, "onTouchCancel": { "tsType": "() => void", "description": "触摸动作被打断，如来电提醒、弹窗。" }, "disable-lower-scroll": { "type": "string", "description": "发生滚动前，对滚动方向进行判断，当方向是顶部/左边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到顶部/左边，禁止滚动。" }, "disable-upper-scroll": { "type": "string", "description": "发生滚动前，对滚动方向进行判断，当方向是底部/右边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到底部/右边，禁止滚动。" } }, "additionalProperties": false } }, { "key": "share-element", "value": { "title": "share-element", "type": "object", "properties": { "name": { "type": "string", "description": "映射标记。" }, "transform": { "type": "boolean", "description": "是否进行动画。", "defaultValue": false }, "duration": { "type": "number", "description": "动画时长，单位毫秒。", "defaultValue": 300 }, "easing-function": { "type": "string", "description": "CSS 缓动函数。", "defaultValue": "ease-out" } }, "additionalProperties": false } }, { "key": "slider", "value": { "title": "slider", "type": "object", "properties": { "name": { "type": "string", "description": "组件名字，用于表单提交获取数据。" }, "min": { "type": "number", "description": "最小值。", "defaultValue": 0 }, "max": { "type": "number", "description": "最大值。", "defaultValue": 100 }, "step": { "type": "number", "description": "步长，值必须大于 0，并可被（max-min）整除。", "defaultValue": 1 }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false }, "value": { "type": "number", "description": "当前取值。", "defaultValue": 0 }, "show-value": { "type": "boolean", "description": "是否显示当前 value。", "defaultValue": false }, "active-color": { "type": "string", "description": "已选择的颜色，同 CSS 色值。", "defaultValue": "#108ee9" }, "background-color": { "type": "string", "description": "背景条颜色，同 CSS 色值。", "defaultValue": "#ddd" }, "track-size": { "type": "number", "description": "轨道线条高度。", "defaultValue": 4 }, "handle-size": { "type": "number", "description": "滑块大小。", "defaultValue": 22 }, "handle-color": { "type": "string", "description": "滑块填充色，同 CSS 色值。", "defaultValue": "#fff" }, "onChange": { "tsType": "() => void", "description": "完成一次拖动后触发，event.detail = {value: value}。" }, "onChanging": { "tsType": "() => void", "description": "拖动过程中触发的事件，event.detail = {value: value}。" } }, "additionalProperties": false } }, { "key": "subscribe-message", "value": { "title": "subscribe-message", "type": "object", "properties": { "template-id": { "type": "string", "description": "组件 ID。可查看 调用订阅组件 获取。" }, "onComplete": { "tsType": "() => void", "description": "订阅完成后触发。" } }, "additionalProperties": false, "required": [ "template-id" ] } }, { "key": "swiper", "value": { "title": "swiper", "type": "object", "properties": { "indicator-dots": { "type": "boolean", "description": "是否显示指示点。", "defaultValue": false }, "indicator-color": { "type": "string", "description": "指示点颜色。", "defaultValue": "rgba(0, 0, 0, .3)" }, "indicator-active-color": { "type": "string", "description": "当前选中的指示点颜色。", "defaultValue": "#000" }, "active-class": { "type": "string", "description": "swiper-item 可见时的 class。" }, "changing-class": { "type": "string", "description": "acceleration 设置为 {{true}} 时且处于滑动过程中，中间若干屏处于可见时的 class。" }, "autoplay": { "type": "boolean", "description": "是否自动切换。", "defaultValue": false }, "current": { "type": "number", "description": "当前页面的 index，可以增加左右箭头来控制轮播滚动。", "defaultValue": 0 }, "duration": { "type": "number", "description": "滑动动画时长。", "defaultValue": null }, "interval": { "type": "number", "description": "自动切换时间间隔。", "defaultValue": null }, "circular": { "type": "boolean", "description": "是否启用无限滑动。", "defaultValue": false }, "vertical": { "type": "boolean", "description": "滑动方向是否为纵向。", "defaultValue": false }, "previous-margin": { "type": "string", "description": "前边距，单位 px，1.9.0 暂时只支持水平方向。说明： 去除 previous-margin 的设置距离可删除 swiper 组件左右空白距离。", "defaultValue": "0px" }, "next-margin": { "type": "string", "description": "后边距，单位 px，1.9.0 暂时只支持水平方向。说明： 去除 next-margin 的设置距离可删除 swiper 组件左右空白距离。", "defaultValue": "0px" }, "acceleration": { "type": "boolean", "description": "当开启时，会根据滑动速度，连续滑动多屏。", "defaultValue": false }, "disable-programmatic-animation": { "type": "boolean", "description": "是否禁用代码变动触发 swiper 切换时使用动画。", "defaultValue": false }, "onChange": { "tsType": "() => void", "description": "current 改变时会触发，event.detail = {current, isChanging}，其中 isChanging 需 acceleration 设置为 {{true}} 时才有值，当连续滑动多屏时，中间若干屏触发 onChange 事件时 isChanging 为 true，最后一屏返回 false。" }, "onTransition": { "tsType": "() => void", "description": "swiper 中 swiper-item 的位置发生改变时会触发 transition 事件。\n其中{dx,dy} = event.detail 基础库 2.6.0 开始支持。" }, "onAnimationEnd": { "tsType": "() => void", "description": "动画结束时会触发 animationEnd 事件，event.detail = {current, source}，其中 source 的值有 autoplay 和  touch。" }, "disable-touch": { "type": "boolean", "description": "是否禁止用户 touch 操作。", "defaultValue": false }, "swipe-ratio": { "type": "number", "description": "滑动距离阈值，当滑动距离超过阈值时进行 swiper-item 切换。", "defaultValue": 0.2 }, "swipe-speed": { "type": "number", "description": "滑动综合速度阈值，当超过阈值时进行 swiper-item 切换，数值越小越敏感。", "defaultValue": 0.05 }, "touch-angle": { "type": "number", "description": "计算用户手势时所依赖的滑动角度。角度根据 touchstart 事件和首次 touchmove 事件的坐标计算得出。数值越小越对用户的滑动方向准确度要求越高。", "defaultValue": 45 }, "display-multiple-items": { "type": "number", "description": "同时显示的滑块数量。", "defaultValue": 1 }, "easing-function": { "type": "string", "description": "切换缓动动画类型。", "defaultValue": "default" }, "snap-to-edge": { "type": "boolean", "description": "当 swiper-item 个数大于等于 2，关闭 circular 并且开启 previous-margin 或 next-margin 时，可以指定这个边距是否应用到第一个、最后一个元素。", "defaultValue": false }, "adjust-height": { "type": "string", "description": "自动以指定滑块的高度为整个容器的高度。当 vertical 为 true 时，默认不调整。可选值为：\n\nfirst：第一个滑块。\ncurrent：实时的当前滑块。\nhighest：高度最大的滑块。\nnone：不根据滑块调整高度，容器高度取决于自身样式。", "defaultValue": "first" }, "adjust-vertical-height": { "type": "boolean", "description": "vertical 为 true 时强制使 adjust-height 生效。", "defaultValue": false } }, "additionalProperties": false } }, { "key": "switch", "value": { "title": "switch", "type": "object", "properties": { "name": { "type": "string", "description": "组件名字，用于表单提交获取数据。" }, "checked": { "type": "boolean", "description": "是否选中。" }, "disabled": { "type": "boolean", "description": "是否禁用。" }, "color": { "type": "string", "description": "组件颜色，同 CSS 色值。" }, "onChange": { "tsType": "() => void", "description": "checked 改变时触发，event.detail={ value:checked}。" }, "controlled": { "type": "boolean", "description": "是否为受控组件，为 true 时，checked 会完全受 setData 控制。", "defaultValue": false } }, "additionalProperties": false } }, { "key": "text", "value": { "title": "text", "type": "object", "properties": { "selectable": { "type": "boolean", "description": "是否可选。", "defaultValue": false }, "space": { "type": "string", "description": "以何种方式显示连续空格。", "enum": [ "nbsp", "ensp", "emsp" ] }, "decode": { "type": "boolean", "description": "是否解码。为 true 时表示对文本内容进行解码，可解析的 HTML 实体字符有： <>&'  。", "defaultValue": false }, "number-of-lines": { "type": "number", "description": "多行省略，值须大于等于 1，表现同 css 的 -webkit-line-clamp 属性一致。" } }, "additionalProperties": false } }, { "key": "textarea", "value": { "title": "textarea", "type": "object", "properties": { "name": { "type": "string", "description": "组件名字，用于表单提交获取数据。" }, "value": { "type": "string", "description": "初始内容。" }, "placeholder": { "type": "string", "description": "占位符。" }, "placeholder-style": { "type": "string", "description": "指定 placeholder 的样式。" }, "placeholder-class": { "type": "string", "description": "指定 placeholder 的样式类。" }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大长度，当设置为 -1 时不限制最大长度。", "defaultValue": 140 }, "focus": { "type": "boolean", "description": "获取焦点。", "defaultValue": false }, "auto-height": { "type": "boolean", "description": "是否自动增高。", "defaultValue": false }, "show-count": { "type": "boolean", "description": "是否渲染字数统计功能（是否删除默认计数器/是否显示字数统计）。", "defaultValue": true }, "controlled": { "type": "boolean", "description": "是否为受控组件。为 true 时，value 内容会完全受 setData 控制。", "defaultValue": false }, "confirm-type": { "type": "string", "description": "设置键盘右下角按钮的文字。有效值：return（显示“换行”）、done（显示“完成”）、go（显示“前往”）、next（显示“下一个”）、search（显示“搜索”）、send（显示“发送”）。\n注意： 仅支持 Android。", "defaultValue": "return。" }, "onInput": { "tsType": "() => void", "description": "键盘输入时触发，event.detail = {value: value, cursor: cursor}。" }, "onFocus": { "tsType": "() => void", "description": "输入框聚焦时触发 event.detail = {value: value}。" }, "onBlur": { "tsType": "() => void", "description": "输入框失去焦点时触发，event.detail = {value: value}。" }, "onConfirm": { "tsType": "() => void", "description": "点击完成时触发，event.detail = {value: value}。" } }, "additionalProperties": false } }, { "key": "video", "value": { "title": "video", "type": "object", "properties": { "style": { "type": "string", "description": "内联样式。" }, "class": { "type": "string", "description": "外部样式名。" }, "src": { "type": "string", "description": "要播放视频的资源地址，支持网络地址，支持优酷视频编码（支付宝客户端 10.1.75）。\nsrc 支持的协议如下：\nvid/showId: XMzg2Mzc5MzMwMA==\napFilePath: https://resource/xxx.video。" }, "poster": { "type": "string", "description": "视频封面图的 url，支持 jpg、png 等图片，如 https://***.jpg。如果不传的话，默认取视频的首帧图作为封面图。" }, "poster-size": { "type": "string", "description": "当 poster 高宽比跟视频高宽不匹配时，如何显示 poster，设置规则同 background-size 一致。", "defaultValue": "contain" }, "object-fit": { "type": "string", "description": "当视频大小与 video 容器大小不一致时，视频的表现形式。contain：包含，fill：填充。", "defaultValue": "contain" }, "initial-time": { "type": "number", "description": "指定视频初始播放位置，单位 s。" }, "duration": { "type": "number", "description": "为无法读取时长的视频设置时长，单位 s。" }, "controls": { "type": "boolean", "description": "是否显示默认播放控件（底部工具条，包括播放/暂停按钮、播放进度、时间）。", "defaultValue": true }, "autoplay": { "type": "boolean", "description": "是否自动播放。", "defaultValue": false }, "direction": { "type": "number", "description": "设置全屏时视频的方向，不指定则根据宽高比自动判断。有效值为 0（正常竖向）, 90（屏幕逆时针 90 度）, -90（屏幕顺时针 90 度）" }, "loop": { "type": "boolean", "description": "是否循环播放。", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音播放。", "defaultValue": false }, "show-fullscreen-btn": { "type": "boolean", "description": "是否显示全屏按钮。", "defaultValue": true }, "show-play-btn": { "type": "boolean", "description": "是否显示视频底部控制栏的播放按钮。", "defaultValue": true }, "show-center-play-btn": { "type": "boolean", "description": "是否显示视频中间的播放按钮。", "defaultValue": true }, "show-mute-btn": { "type": "boolean", "description": "是否展示工具栏上的静音按钮。", "defaultValue": true }, "show-thin-progress-bar": { "type": "boolean", "description": "当底部工具条隐藏时，是否显示细进度条（controls=false 时设置无效）。", "defaultValue": false }, "enable-progress-gesture": { "type": "boolean", "description": "全屏模式下是否开启控制进度的手势。", "defaultValue": false }, "mobilenet-hint-type": { "type": "number", "description": "移动网络提醒样式。\n\n0 - 不提醒\n1 - tip 提醒\n2 - 阻塞提醒(无消耗流量大小)\n3 - 阻塞提醒(有消耗流量大小提醒)", "defaultValue": 1 }, "onPlay": { "tsType": "() => void", "description": "当开始/继续播放时触发 play 事件。" }, "onPause": { "tsType": "() => void", "description": "当暂停播放时触发 pause 事件。" }, "onEnded": { "tsType": "() => void", "description": "当播放到末尾时触发 ended 事件。" }, "onTimeUpdate": { "tsType": "() => void", "description": "播放进度变化时触发，event.detail = {currentTime: '当前播放时间',userPlayDuration:'用户实际观看时长',videoDuration:'视频总时长'}。" }, "onLoading": { "tsType": "() => void", "description": "视频出现缓冲时触发。" }, "onError": { "tsType": "() => void", "description": "视频播放出错时触发（errorCode 见下面错误码表）。" }, "onFullScreenChange": { "tsType": "() => void", "description": "视频进入和退出全屏时触发，event.detail = {fullScreen, direction}，direction 取为 vertical 或 horizontal。" }, "onTap": { "tsType": "() => void", "description": "点击视频 view 时触发，event.detail = {ptInView:{x:0,y:0}}。" }, "onUserAction": { "tsType": "() => void", "description": "用户操作事件，event.detail = {tag:\"mute\", value:0}，tag 为用户操作的元素，目前支持的 tag 有：play（底部播放按钮）、centerplay（中心播放按钮）、mute（静音按钮）、fullscreen（全屏按钮）、retry（重试按钮）、mobilenetplay（网络提醒的播放按钮）。" }, "onStop": { "tsType": "() => void", "description": "视频播放终止。" }, "onRenderStart": { "tsType": "() => void", "description": "当视频加载完真正开始播放时触发。" }, "floating-mode": { "type": "string", "description": "浮窗设置。暂时不支持全局浮窗。\n可选值：\n\nnone：无浮窗。\npage：页面内浮窗。", "defaultValue": "none" } }, "additionalProperties": false } }, { "key": "view", "value": { "title": "view", "type": "object", "properties": { "disable-scroll": { "type": "boolean", "description": "是否阻止区域内滚动页面。说明： 如果 view 中嵌套 view，外层 view 设置 disable-scroll 为 true 时禁止内部的滚动。", "defaultValue": false }, "hover-class": { "type": "string", "description": "触摸时添加的样式类。" }, "hover-start-time": { "type": "number", "description": "按住多久后出现点击状态，单位毫秒。" }, "hover-stay-time": { "type": "number", "description": "松开后点击状态保留时间，单位毫秒。" }, "hidden": { "type": "boolean", "description": "是否隐藏。", "defaultValue": false }, "class": { "type": "string", "description": "自定义样式名。" }, "style": { "type": "string", "description": "内联样式。" }, "animation": { "type": "object", "description": "用于动画，详见 my.createAnimation 。使用 my.createAnimation 生成的动画是通过过渡（Transition）实现的，只会触发 onTransitionEnd，不会触发 onAnimationStart, onAnimationIteration, onAnimationEnd。", "defaultValue": "{}" }, "hover-stop-propagation": { "type": "boolean", "description": "是否阻止当前元素的祖先元素出现点击态。", "defaultValue": false }, "onTap": { "tsType": "() => void", "description": "点击。" }, "onTouchStart": { "tsType": "() => void", "description": "触摸动作开始。" }, "onTouchMove": { "tsType": "() => void", "description": "触摸后移动。" }, "onTouchEnd": { "tsType": "() => void", "description": "触摸动作结束。" }, "onTouchCancel": { "tsType": "() => void", "description": "触摸动作被打断，如来电提醒，弹窗。" }, "onLongTap": { "tsType": "() => void", "description": "长按 500ms 之后触发，触发了长按事件后进行移动将不会触发屏幕的滚动。" }, "onTransitionEnd": { "tsType": "() => void", "description": "过渡（Transition）结束时触发。" }, "onAnimationIteration": { "tsType": "() => void", "description": "每开启一次新的动画过程时触发。（第一次不触发）" }, "onAnimationStart": { "tsType": "() => void", "description": "动画开始时触发。" }, "onAnimationEnd": { "tsType": "() => void", "description": "动画结束时触发。" }, "onAppear": { "tsType": "() => void", "description": "当前元素可见面积超过50%时触发。" }, "onDisappear": { "tsType": "() => void", "description": "当前元素不可见面积超过50%时触发。" }, "onFirstAppear": { "tsType": "() => void", "description": "当前元素首次可见面积达到50%时触发。" }, "role": { "type": "", "description": "表示组件的语义角色。设置为 img 时，组件聚焦后读屏软件会朗读出 图像 ；设置为 button 时，聚焦后读屏软件会朗读出 按钮 。详情请参见 aria-component。" } }, "additionalProperties": false } }, { "key": "web-view", "value": { "title": "web-view", "type": "object", "properties": { "src": { "type": "string", "description": "web-view 要渲染的 H5 网页 URL ，默认允许打开所有 https://render.alipay.com/p/ 开头的 URL（支付宝客户端 10.2.63 版本开始支持），其他网页需要在 开放平台控制台 > 对应小程序详情页 > 开发设置 > H5域名配置 进行 H5 域名白名单配置。\n说明：src必须是标准的 H5 链接，任何包含例如 alipays://xx... 的链接都会导致重定向出错，从而无法展示页面，即使是 https://render.alipay.com 开头的 URL 也不能包含 alipays://xx... 此类内容。" }, "onMessage": { "tsType": "() => void", "description": "网页向小程序 postMessage 消息。e.detail = { data }" }, "onLoad": { "tsType": "() => void", "description": "网页加载成功时触发此事件。e.detail = { src }" }, "onError": { "tsType": "() => void", "description": "网页加载失败时触发此事件。e.detail = { src }" } }, "additionalProperties": false } } ] }, { "key": "swan", "value": [ { "key": "ad", "value": { "title": "ad", "type": "object", "properties": { "appid": { "type": "string", "description": "小程序应用 ID" }, "apid": { "type": "string", "description": "小程序广告位 ID" }, "type": { "type": "string", "description": "广告类型：banner、feed ，需和百青藤平台上的代码位类型相匹配", "defaultValue": "feed" }, "updatetime": { "type": "string", "description": "更改该属性，可以触发广告刷新;单位毫秒" }, "bindError": { "tsType": "() => void", "description": "广告组件加载失败时触发" }, "bindLoad": { "tsType": "() => void", "description": "广告组件加载完成触发" }, "bindClose": { "tsType": "() => void", "description": "关闭广告组件时触发" }, "bindStatus": { "tsType": "() => void", "description": "贴片类型广告播放期间触发" } }, "additionalProperties": false, "required": [ "appid", "apid" ] } }, { "key": "animation-video", "value": { "title": "animation-video", "type": "object", "properties": { "resource-width": { "type": "number", "description": "组件使用的 video 视频资源的宽度（单位：px）", "defaultValue": 800 }, "resource-height": { "type": "number", "description": "组件使用的 video 视频资源的高度（单位：px）", "defaultValue": 400 }, "canvas-style": { "type": "string", "description": "用于设置动画画布的 CSS 样式", "defaultValue": "width: 400px;height: 400px" }, "path": { "type": "string", "description": "动画资源地址，支持相对路径以及远程地址。如果是远程路径，注意 response header 里需要设置 Access-Control-Allow-Origin 来防止跨域问题" }, "loop": { "type": "boolean", "description": "动画是否循环播放", "defaultValue": false }, "autoplay": { "type": "boolean", "description": "动画是否自动播放", "defaultValue": false }, "alpha-direction": { "type": "string", "description": "视频资源中 alpha 通道的方向，left 表示 alpha 通道在资源的左边，right 表示 alpha 通道在资源的右边。详情请参考透明视频设计资源示例", "defaultValue": "left" }, "bindStarted": { "tsType": "() => void", "description": "动画开始播放的回调" }, "bindEnded": { "tsType": "() => void", "description": "当播放到末尾时触发 ended 事件（自然播放结束会触发回调，循环播放结束及暂停动画不会触发）" } }, "additionalProperties": false, "required": [ "path" ] } }, { "key": "animation-view", "value": { "title": "animation-view", "type": "object", "properties": { "path": { "type": "string", "description": "动画资源地址，目前只支持绝对路径" }, "loop": { "type": "boolean", "description": "动画是否循环播放", "defaultValue": false }, "autoplay": { "type": "boolean", "description": "动画是否自动播放", "defaultValue": true }, "action": { "type": "string", "description": "动画操作，可取值 play、pause、stop", "defaultValue": "play", "enum": [ "play", "pause", "stop" ] }, "hidden": { "type": "boolean", "description": "是否隐藏动画", "defaultValue": true }, "bindEnded": { "tsType": "() => void", "description": "当播放到末尾时触发 ended 事件（自然播放结束会触发回调，循环播放结束及手动停止动画不会触发）" } }, "additionalProperties": false, "required": [ "path" ] } }, { "key": "ar-camera", "value": { "title": "ar-camera", "type": "object", "properties": { "key": { "type": "string", "description": "AR 项目唯一标识，在 DuMixAR 内容开放平台上传生成 AR 项目后获取 AR Key" }, "type": { "type": "string", "description": "AR 相机类型，在 DuMixAR 内容开放平台上传生成 AR 项目后获取 AR Type：\n2D 跟踪类型：0\nSLAM 类型：5\nIMU 类型：8", "enum": [ "0", "5", "8" ] }, "flash": { "type": "string", "description": "闪光灯，值为 auto、on、off", "defaultValue": "off", "enum": [ "auto", "on", "off" ] }, "bindError": { "tsType": "() => void", "description": "用户不允许使用摄像头或扫码失败时触发" }, "bindLoad": { "tsType": "() => void", "description": "AR 加载成功时触发" }, "bindMessage": { "tsType": "() => void", "description": "开发者制作 AR 项目时可自定义按键，用户点击时会收到事件和数据，用户自定义事件格式参见代码示例 2：用户自定义事件" }, "bindScanCode": { "tsType": "() => void", "description": "扫描识图结束后触发" } }, "additionalProperties": false, "required": [ "key", "type" ] } }, { "key": "audio", "value": { "title": "audio", "type": "object", "properties": { "id": { "type": "string", "description": "audio 组件的唯一标识符" }, "src": { "type": "string", "description": "要播放音频的资源地址" }, "loop": { "type": "boolean", "description": "是否循环播放", "defaultValue": false }, "controls": { "type": "boolean", "description": "是否显示默认控件", "defaultValue": false }, "poster": { "type": "string", "description": "默认控件上的音频封面的图片资源地址，如果 controls 属性值为 false 则设置 poster 无效" }, "name": { "type": "string", "description": "默认控件上的音频名字，如果 controls 属性值为 false 则设置 name 无效", "defaultValue": "未知音频" }, "author": { "type": "string", "description": "默认控件上的作者名字，如果 controls 属性值为 false 则设置 author 无效", "defaultValue": "未知作者" }, "bindError": { "tsType": "() => void", "description": "当发生错误时触发 error 事件，detail = {errMsg: MediaError.code}返回错误码可参考 MediaError.code" }, "bindPlay": { "tsType": "() => void", "description": "当开始/继续播放时触发 play 事件，detail = {duration}" }, "bindPause": { "tsType": "() => void", "description": "当暂停播放时触发 pause 事件，detail = {duration}" }, "bindTimeUpdate": { "tsType": "() => void", "description": "当播放进度改变时触发 timeupdate 事件，detail = {currentTime, duration}" }, "bindEnded": { "tsType": "() => void", "description": "当播放到末尾时触发 ended 事件，detail = {duration}" } }, "additionalProperties": false } }, { "key": "button", "value": { "title": "button", "type": "object", "properties": { "size": { "type": "string", "description": "大小", "defaultValue": "default", "enum": [ "default", "mini" ] }, "type": { "type": "string", "description": "类型", "defaultValue": "default", "enum": [ "primary", "default", "warn" ] }, "plain": { "type": "boolean", "description": "按钮是否镂空，背景色透明", "defaultValue": false }, "form-type": { "type": "string", "description": "用于
组件，点击分别会触发组件的 submit/reset 事件", "defaultValue": "buttonclick", "enum": [ "buttonclick", "submit", "reset" ] }, "open-type": { "type": "string", "description": "百度 App 开放能力，比如分享、获取用户信息等等", "enum": [ "share", "getUserInfo", "getPhoneNumber", "openSetting", "chooseAddress", "chooseInvoiceTitle", "contact", "login", "subscribe" ] }, "hover-class": { "type": "string", "description": "点击态。指定按钮按下去的样式类。当hover-class=\"none\"时，没有点击态效果。button-hover 默认为{background-color: rgba(0, 0, 0, 0.1); opacity: 0.7;}", "defaultValue": "button-hover" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态（单位：毫秒）", "defaultValue": 20 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间（单位：毫秒）", "defaultValue": 70 }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "loading": { "type": "boolean", "description": "名称前是否带有 loading 图标", "defaultValue": false }, "session-from": { "type": "string", "description": "会话来源，open-type=\"contact\" 时有效" }, "send-message-title": { "type": "string", "description": "会话内消息卡片标题，open-type=\"contact\" 时有效", "defaultValue": "当前标题" }, "send-message-path": { "type": "string", "description": "会话内消息卡片点击跳转小程序路径，open-type=\"contact\" 时有效", "defaultValue": "当前页面路径" }, "send-message-img": { "type": "string", "description": "会话内消息卡片图片，open-type=\"contact\" 时有效", "defaultValue": "默认图片" }, "show-message-card": { "type": "boolean", "description": "是否显示会话内消息卡片，设置此参数为 true，用户进入客服会话会在右下角显示\"可能要发送的小程序\"提示，用户点击后可以快速发送小程序消息，open-type=\"contact\" 时有效", "defaultValue": false }, "template-id": { "type": [ "string", "Array." ], "description": "发送订阅类模板消息所用的模板库标题 ID ，可通过 getTemplateLibraryList 获取\n当参数类型为 Array 时，可传递 1~3 个模板库标题 ID" }, "subscribe-id": { "type": "string", "description": "发送订阅类模板消息时所使用的唯一标识符，内容由开发者自定义，用来标识订阅场景\n注意：同一用户在同一 subscribe-id 下的多次授权不累积下发权限，只能下发一条。若要订阅多条，需要不同 subscribe-id" }, "bindGetPhoneNumber": { "tsType": "() => void", "description": "获取用户手机号回调。和 open-type 搭配使用， 使用时机：open-type=\"getPhoneNumber\"。具体申请方法请见：获取用户手机号权限申请" }, "bindGetUserInfo": { "tsType": "() => void", "description": "用户点击该按钮时，会返回获取到的用户信息，可以从返回参数的 detail 中获取到的值。当 errMsg 为getUserInfo:ok时即为获取成功；其中 userInfo 字段中包含获取到的用户头像地址（avatarUrl）、性别（gender）、昵称（nickName）。和 open-type 搭配使用， 使用时机：open-type=\"getUserInfo\"" }, "bindOpenSetting": { "tsType": "() => void", "description": "在打开授权设置页后回调，使用时机：open-type=\"openSetting\"" }, "bindContact": { "tsType": "() => void", "description": "客服消息回调，使用时机：open-type=\"contact\"" }, "bindChooseAddress": { "tsType": "() => void", "description": "用户点击该按钮时，调起用户编辑收货地址原生界面，并在编辑完成后返回用户选择的地址，从返回参数的 detail 中获取，和 swan.chooseAddress 一样的。和 open-type 搭配使用，使用时机：open-type=\"chooseAddress\"" }, "bindChooseInvoiceTitle": { "tsType": "() => void", "description": "用户点击该按钮时，选择用户的发票抬头，和 swan.chooseInvoiceTitle 一样的。和 open-type 搭配使用，使用时机：open-type=\"chooseInvoiceTitle\"" }, "bindLogin": { "tsType": "() => void", "description": "登录回调，和 open-type 搭配使用，使用时机：open-type=\"login\"。可以通过返回参数的 detail 判断是否登录成功，当 errMsg 为'login:ok'时即为成功。如想获取登录凭证请使用 swan.getLoginCode" }, "bindSubscribe": { "tsType": "() => void", "description": "订阅消息授权回调，和 open-type 搭配使用，使用时机：open-type=\"subscribe\"" } }, "additionalProperties": false } }, { "key": "camera", "value": { "title": "camera", "type": "object", "properties": { "device-position": { "type": "string", "description": "前置或后置，值为 front、back", "defaultValue": "back", "enum": [ "front", "back" ] }, "flash": { "type": "string", "description": "闪光灯，值为 auto、on、off、torch", "defaultValue": "auto", "enum": [ "auto", "on", "off", "torch" ] }, "bindStop": { "tsType": "() => void", "description": "摄像头在非正常终止时触发，如退出后台等情况" }, "bindError": { "tsType": "() => void", "description": "用户不允许使用摄像头时触发" } }, "additionalProperties": false } }, { "key": "canvas", "value": { "title": "canvas", "type": "object", "properties": { "canvas-id": { "type": "string", "description": "canvas 组件的唯一标识符" }, "disable-scroll": { "type": "boolean", "description": "是否禁止屏幕滚动以及下拉刷新。当在 canvas 中同时绑定下列手势事件时，该属性不起作用", "defaultValue": false }, "bindTouchStart": { "tsType": "() => void", "description": "手指触摸动作开始" }, "bindTouchMove": { "tsType": "() => void", "description": "手指触摸后移动" }, "bindTouchEnd": { "tsType": "() => void", "description": "手指触摸动作结束" }, "bindTouchCancel": { "tsType": "() => void", "description": "手指触摸动作被打断，如来电提醒，弹窗" }, "bindLongTap": { "tsType": "() => void", "description": "手指长按 350ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动" }, "bindError": { "tsType": "() => void", "description": "当发生错误时触发 error 事件，detail = {errMsg: 'something wrong'}" } }, "additionalProperties": false, "required": [ "canvas-id" ] } }, { "key": "checkbox-group", "value": { "title": "checkbox-group", "type": "object", "properties": { "bindChange": { "tsType": "() => void", "description": "checkbox-group 中选中项发生改变时触发 change 事件，detail = {value:[选中的 checkbox 的 value 的数组]}" } }, "additionalProperties": false } }, { "key": "checkbox", "value": { "title": "checkbox", "type": "object", "properties": { "value": { "type": "string", "description": "标识，选中时触发的 change 事件，并携带的 value" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "checked": { "type": "boolean", "description": "当前是否选中，可用来设置默认选中", "defaultValue": false }, "color": { "type": "string", "description": "checkbox 的颜色，同 CSS 的 color", "defaultValue": "#3c76ff" } }, "additionalProperties": false } }, { "key": "comment-detail", "value": { "title": "comment-detail", "type": "object", "properties": { "comment-param": { "type": "object", "description": "评论核心参数", "defaultValue": "是" }, "srid": { "type": "string", "description": "评论 ID", "defaultValue": "是" }, "is-page-scroll": { "type": "boolean", "description": "滚动方式为页面滚动，若组件作为浮层使用，该参数需设为 false", "defaultValue": false }, "need-toolbar": { "type": "boolean", "description": "是否需要底部 toolbar，若使用开发者自定义的底部 toolbar，该参数需设为 false", "defaultValue": false }, "need-like-btn": { "type": "boolean", "description": "是否需要详情顶部父级评论的点赞按钮，默认显示", "defaultValue": false }, "back-list-after-delete": { "type": "boolean", "description": "删除详情后是否返回列表项，默认一站式逻辑。若使用浮层，请设置改属性为 false", "defaultValue": false }, "add-comment": { "type": "boolean", "description": "用于调起评论发布器发布评论", "defaultValue": false }, "bindDelete": { "tsType": "() => void", "description": "删除整体详情内容时触发，返回数据为{status, data:{srid}}" }, "bindReply": { "tsType": "() => void", "description": "评论发布成功时触发，返回数据为 {status, data:{srid}}" } }, "additionalProperties": false } }, { "key": "comment-list", "value": { "title": "comment-list", "type": "object", "properties": { "comment-param": { "type": "object", "description": "评论核心参数", "defaultValue": "是" }, "toolbar-config": { "type": "object", "description": "底部 toolbar 的相关配置", "defaultValue": "否" }, "is-page-scroll": { "type": "boolean", "description": "滚动方式为页面滚动，若组件作为浮层使用，该参数需设为 false", "defaultValue": false }, "need-toolbar": { "type": "boolean", "description": "是否需要底部 toolbar ，若使用开发者自定义的底部 toolbar ，该参数需设为 false", "defaultValue": false }, "add-comment": { "type": "boolean", "description": "用于调起评论发布器发布评论，发布成功插入列表第一条，且滚动到列表顶部", "defaultValue": false }, "detail-path": { "type": "string", "description": "点击单条评论跳转的详情页页面 path ，若没有配置则不会发生跳转；配置的前提是列表与详情均是页面级", "defaultValue": "否" }, "is-folded": { "type": "boolean", "description": "是否折叠列表，默认全展示", "defaultValue": false }, "fold-num": { "type": "number", "description": "折叠后列表展示最大条数，默认 3 条，最多 10 条", "defaultValue": null }, "view-more-path": { "type": "string", "description": "传入放置评论组件的页面路径，如'/pages/list/index'，组件内部会触发跳转逻辑" }, "view-more-style": { "type": "object", "description": "『全部 xx 条』的样式，目前只支持开发者自定义字体颜色" }, "bindClickComment": { "tsType": "() => void", "description": "绑定点击单条评论的事件，点击单条评论时触发，返回数据为{status, data:{srid}}" }, "bindViewMore": { "tsType": "() => void", "description": "绑定点击更多事件，若除了页面跳转还需要其他操作，可通过该回调执行；若为浮层，也可使用该回调自定义交互逻辑" }, "bindReply": { "tsType": "() => void", "description": "评论发布成功时触发，返回数据为 {status, data:{srid}}" } }, "additionalProperties": false } }, { "key": "cover-image", "value": { "title": "cover-image", "type": "object", "properties": { "src": { "type": "string", "description": "图标路径，支持临时路径、网络地址。支持 JPG、PNG、BMP、GIF（基础库3.420.5开始支持） 格式" }, "fixed-top": { "type": "number", "description": "设置与容器顶部的固定距离，效果相当于在 CSS 中设置 position: fixed 和 top 值，该属性优先级高于 fixed-bottom，CSS 设置的 position、top、bottom 值" }, "fixed-right": { "type": "number", "description": "设置与容器右侧的固定距离，效果相当于在 CSS 中设置 position: fixed 和 right 值，该属性优先级高于 CSS 设置的 position、left、right 值" }, "fixed-bottom": { "type": "number", "description": "设置与容器底部的固定距离，效果相当于在 CSS 中设置 position: fixed 和 bottom 值，该属性优先级高于 CSS 设置的 position、top、bottom 值" }, "fixed-left": { "type": "number", "description": "设置与容器左侧的固定距离，效果相当于在 CSS 中设置 position: fixed 和 left 值，该属性优先级高于 fixed-right，CSS 设置的 position、left、right 值" }, "bindLoad": { "tsType": "() => void", "description": "图片加载成功时触发" }, "bindError": { "tsType": "() => void", "description": "图片加载失败时触发" } }, "additionalProperties": false, "required": [ "src" ] } }, { "key": "cover-view", "value": { "title": "cover-view", "type": "object", "properties": { "scroll-top": { "type": "number", "description": "设置顶部滚动偏移量，仅在设置了overflow-y: scroll成为滚动元素后生效" }, "fixed-top": { "type": "number", "description": "设置与容器顶部的固定距离，效果相当于在 CSS 中设置 position: fixed 和 top 值，该属性优先级高于 fixed-bottom，CSS 设置的 position、top、bottom 值" }, "fixed-right": { "type": "number", "description": "设置与容器右侧的固定距离，效果相当于在 CSS 中设置 position: fixed 和 right 值，该属性优先级高于 CSS 设置的 position、left、right 值" }, "fixed-bottom": { "type": "number", "description": "设置与容器底部的固定距离，效果相当于在 CSS 中设置 position: fixed 和 bottom 值，该属性优先级高于 CSS 设置的 position、top、bottom 值" }, "fixed-left": { "type": "number", "description": "设置与容器左侧的固定距离，效果相当于在 CSS 中设置 position: fixed 和 left 值，该属性优先级高于 fixed-right，CSS 设置的 position、left、right 值" } }, "additionalProperties": false } }, { "key": "follow-swan", "value": { "title": "follow-swan", "type": "object", "properties": { "size": { "type": "string", "description": "组件大小", "defaultValue": "default" }, "type": { "type": "string", "description": "组件样式", "defaultValue": "primary" }, "bindFavorStatusChange": { "tsType": "() => void", "description": "关注和取消关注成功的回调，返回关注状态 {isFavor: true|false}" } }, "additionalProperties": false } }, { "key": "form", "value": { "title": "form", "type": "object", "properties": { "report-submit": { "type": "boolean", "description": "是否返回 formId 用于发送模板消息（工具上 formId 为''，请在真机上测试），订阅消息详细说明请参考订阅消息接入", "defaultValue": false }, "report-type": { "type": "string", "description": "模板消息的类型，report-submit 为 true 时填写有效\n取值：default / subscribe", "defaultValue": "'default'" }, "template-id": { "type": [ "string", "Array." ], "description": "发送订阅类模板消息所用的模板库标题 ID ，可通过 getTemplateLibraryList 获取\n当参数类型为 Array 时，可传递 1~3 个模板库标题 ID （注：此处填写模板库id。示例：BD0001）" }, "subscribe-id": { "type": "string", "description": "发送订阅类模板消息时所使用的唯一标识符，内容由开发者自定义，用来标识订阅场景\n注意：同一用户在同一 subscribe-id 下的多次授权不累积下发权限，只能下发一条。若要订阅多条，需要不同 subscribe-id" }, "bindSubmit": { "tsType": "() => void", "description": "携带 form 中的数据触发 submit 事件，event.detail = {value : {'name': 'value'}, formId: '', message: '', status: ''}，当 report-type 为 subscribe 时，status 和 message 中返回用户授权具体信息" }, "bindReset": { "tsType": "() => void", "description": "表单重置时会触发 reset 事件" } }, "additionalProperties": false } }, { "key": "icon", "value": { "title": "icon", "type": "object", "properties": { "type": { "type": "string", "description": "生效的值见下表 type 有效值", "enum": [ "success", "info", "warn", "waiting", "success_no_circle", "clear", "search", "personal", "setting", "top", "close", "cancel", "download", "checkboxSelected", "radioSelected", "radioUnselect", "loadingGrey" ] }, "size": { "type": "number", "description": "icon 的大小（单位：px）", "defaultValue": 23 }, "color": { "type": "string", "description": "icon 的颜色" } }, "additionalProperties": false, "required": [ "type" ] } }, { "key": "image", "value": { "title": "image", "type": "object", "properties": { "src": { "type": "string", "description": "图片资源地址" }, "mode": { "type": "string", "description": "图片裁剪、缩放的模式", "defaultValue": "scaleToFill", "enum": [ "缩放", "缩放", "缩放", "缩放", "缩放", "裁剪", "裁剪", "裁剪", "裁剪", "裁剪", "裁剪", "裁剪", "裁剪", "裁剪" ] }, "webp": { "type": "boolean", "description": "只针对 iOS 端；且 iOS 系统默认不解析 WEBP 格式，但该属性设为 true 时，只支持网络资源 WEBP 格式", "defaultValue": false }, "lazy-load": { "type": "boolean", "description": "图片懒加载，在图片即将进入一定范围（距离当前屏 50px）时才开始进行加载", "defaultValue": false }, "image-menu-prevent": { "type": "boolean", "description": "阻止长按图片时弹起默认菜单（即将该属性设置为image-menu-prevent=\"true\"或image-menu-prevent），只在初始化时有效，不能动态变更；若不想阻止弹起默认菜单，则不需要设置此属性。注：长按菜单后的操作暂不支持 svg 格式", "defaultValue": false }, "preview": { "type": "boolean", "description": "点击后是否预览图片。在不设置的情况下，若 image 未监听点击事件且宽度大于 1/4 屏宽，则默认开启" }, "original-src": { "type": "string", "description": "预览时显示的图片地址" }, "bindError": { "tsType": "() => void", "description": "当错误发生时，发布到 AppService 的事件名，事件对象event.detail = {errMsg: 'something wrong'}" }, "bindLoad": { "tsType": "() => void", "description": "当图片载入完毕时，发布到 AppService 的事件名，事件对象event.detail = {height:'图片高度 px', width:'图片宽度 px'}" } }, "additionalProperties": false } }, { "key": "inline-payment-panel", "value": { "title": "inline-payment-panel", "type": "object", "properties": { "total-amount": { "type": "string", "description": "总金额，金额单位分，tip：仅支持整数型字符串" }, "deal-id": { "type": "string", "description": "百度收银台的财务结算凭证，详见平台术语" }, "app-key": { "type": "string", "description": "支付能力开通后分配的支付 appKey，详见平台术语" }, "promotion-tag": { "type": [ "string", "Array." ], "description": "平台营销信息，此处传当前订单中可使用平台券的 spuid，同时需在 支付能力中搭配使用传入该参数；注：仅与百度合作平台类目券的开发者需要填写该参数" }, "enable-page-back-modal": { "type": "boolean", "description": "是否设置挽留弹窗", "defaultValue": false }, "custom-style": { "type": "object", "description": "自定义样式设置" }, "style-type": { "type": "string", "description": "自定义样式档位配置，各档位配置项包括支付渠道/优惠券条高度、渠道图标大小、支付渠道文案字体大小、营销文案字体大小、选择器图标大小", "defaultValue": "default", "enum": [ "tiny", "small", "default", "medium", "large" ] }, "bindGetPaymentInfo": { "tsType": "() => void", "description": "获取支付相关信息，具体信息在返回值的 detail 字段中" }, "bindError": { "tsType": "() => void", "description": "当发生错误时触发 error 事件，具体信息在返回值的 detail 字段中，例如 {detail: {errMsg: \"something is wrong\"}}" } }, "additionalProperties": false, "required": [ "total-amount", "deal-id", "app-key" ] } }, { "key": "input", "value": { "title": "input", "type": "object", "properties": { "value": { "type": "string", "description": "输入框的初始内容。若要动态设置输入框内容，需设置value=\"{= value =}\"（注：若要取键盘输入后的 value 请通过 bindinput 获取）" }, "type": { "type": "string", "description": "input 的类型", "defaultValue": "text", "enum": [ "text", "number", "idcard", "digit" ] }, "password": { "type": "boolean", "description": "是否是密码类型", "defaultValue": false }, "placeholder": { "type": "string", "description": "输入框为空时占位符。其样式暂时只支持设置 text-align、font-size、font-weight、color" }, "placeholder-style": { "type": "string", "description": "placeholder 的样式" }, "placeholder-class": { "type": "string", "description": "placeholder 的样式类", "defaultValue": "input-placeholder" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大输入长度，设置为 -1 的时候不限制最大长度", "defaultValue": 140 }, "cursor-spacing": { "type": "number", "description": "指定光标与键盘的距离（单位：px）。当键盘弹出时， 如果需要页面上滑才能完整显示 input 组件, 那么此时光标与键盘的距离为设定的 cursor-spacing 值； 如果 input 组件处于屏幕上方，键盘弹出时不会挡住 input， 则忽略该属性", "defaultValue": 0 }, "focus": { "type": "boolean", "description": "获取焦点，调起键盘\n开发者工具暂不支持自动获取焦点", "defaultValue": false }, "confirm-type": { "type": "string", "description": "设置键盘右下角按钮的文字。其最终表现与手机输入法本身的实现有关，部分安卓系统输入法和第三方输入法可能不支持或不完全支持", "defaultValue": "done", "enum": [ "send", "search", "next", "go", "done" ] }, "confirm-hold": { "type": "boolean", "description": "点击键盘右下角按钮时是否保持键盘不收起", "defaultValue": false }, "cursor": { "type": "number", "description": "指定 focus 时的光标位置，自动聚焦时才会生效\n开发者工具暂不支持" }, "selection-start": { "type": "number", "description": "光标起始位置，自动聚焦时有效，需与 selection-end 搭配使用", "defaultValue": -1 }, "selection-end": { "type": "number", "description": "光标结束位置，自动聚焦时有效，需与 selection-start 搭配使用", "defaultValue": -1 }, "adjust-position": { "type": "boolean", "description": "键盘弹起时，是否自动上推页面", "defaultValue": true }, "bindInput": { "tsType": "() => void", "description": "当键盘输入时，触发 input 事件，event.detail = {value, cursor, keyCode}，keyCode 为键值。暂不支持处理函数直接 return 一个字符串" }, "bindFocus": { "tsType": "() => void", "description": "输入框聚焦时触发，event.detail = {value: value, height: height}，height 为键盘高度" }, "bindBlur": { "tsType": "() => void", "description": "输入框失去焦点时触发，event.detail = {value: value}" }, "bindConfirm": { "tsType": "() => void", "description": "点击完成按钮时触发，event.detail = {value: value}" } }, "additionalProperties": false } }, { "key": "label", "value": { "title": "label", "type": "object", "properties": { "for": { "type": "string", "description": "绑定控件的 ID" } }, "additionalProperties": false } }, { "key": "like", "value": { "title": "like", "type": "object", "properties": { "is-liked": { "type": "boolean", "description": "是否已被点赞", "defaultValue": false }, "mode": { "type": "string", "description": "按钮模式。icon：表示仅有图标；mixture：表示图标文字结合", "defaultValue": "icon" }, "icon-type": { "type": "string", "description": "图标类型。hand：表示手形；heart：表示心形", "defaultValue": "hand" }, "style": { "type": "string", "description": "仅在 mode 为 mixture 时可配置。none：无边框；border：有边框", "defaultValue": "none" }, "like-text": { "type": "string", "description": "点赞按钮上的文案。默认为赞，仅在 mode 属性值为'mixture'时有效", "defaultValue": "赞" }, "like-num": { "type": "number", "description": "点赞数量", "defaultValue": 0 }, "like-type": { "type": "number", "description": "被点赞的对象类型。0：表示对文章内容进行点赞；1：表示对评论内容进行点赞", "defaultValue": 0 }, "animation-type": { "type": "number", "description": "点赞动效形式。0：无动效；1：轻动效；2：强动效", "defaultValue": 1 }, "is-show-toast": { "type": "boolean", "description": "点赞后是否弹出 toast 提示", "defaultValue": false }, "toast-text": { "type": "array", "description": "toast 文案，默认为已点赞、已取消", "defaultValue": "['已点赞', '已取消']" }, "like-param": { "type": "object", "description": "点赞服务需要的必要参数" }, "bindError": { "tsType": "() => void", "description": "使用 npm 方式引入点赞组件时，点击按钮时在用户未登录状态下会触发此事件；使用动态库方式引入点赞组件时，点击按钮时在用户未登录状态下不会触发此事件" }, "bindSuccess": { "tsType": "() => void", "description": "点击点赞按钮，在点赞服务成功后将状态返回给使用组件者" }, "bindFail": { "tsType": "() => void", "description": "点击点赞按钮，在点赞服务失败后将状态返回给使用组件者" } }, "additionalProperties": false, "required": [ "like-param" ] } }, { "key": "live-player", "value": { "title": "live-player", "type": "object", "properties": { "id": { "type": "string", "description": "live-player 属性的唯一标志符" }, "src": { "type": "string", "description": "音视频地址，详见下方主流格式支持" }, "autoplay": { "type": "boolean", "description": "自动播放", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音", "defaultValue": false }, "orientation": { "type": "string", "description": "画面方向，有效值有 vertical、horizontal 。目前仅支持安卓端使用该属性", "defaultValue": "vertical", "enum": [ "vertical", "horizontal" ] }, "object-fit": { "type": "string", "description": "填充模式，有效值：contain、fillCrop", "defaultValue": "contain", "enum": [ "contain", "fillCrop" ] }, "background-mute": { "type": "boolean", "description": "进入后台时是否静音（已废弃，默认退台静音）", "defaultValue": false }, "min-cache": { "type": "number", "description": "最小缓冲区（单位：s）", "defaultValue": 1 }, "max-cache": { "type": "number", "description": "最大缓冲区（单位：s）", "defaultValue": 3 }, "bindStateChange": { "tsType": "() => void", "description": "播放状态变化事件，参考下方状态码，detail = {code}" }, "bindNetStatus": { "tsType": "() => void", "description": "网络状态变化通知，参考下方网络状态数据，detail = {info}" }, "bindFullScreenChange": { "tsType": "() => void", "description": "全屏变化事件，detail = {direction, fullscreen}" } }, "additionalProperties": false, "required": [ "id", "src" ] } }, { "key": "login", "value": { "title": "login", "type": "object", "properties": { "button-class": { "type": "string", "description": "组件中用户授权按钮的类名，可用于自定义样式" }, "checked-color": { "type": "string", "description": "组件中用户授权勾选框选中时的颜色，同 CSS 的 color", "defaultValue": "#3388FF" }, "theme-color": { "type": "string", "description": "主题颜色，设置后将应用于 “用户授权按钮背景色” 和 “用户授权勾选框选中时的颜色”\n注：theme-color 的优先级低于 button-class 和 checked-color，且当 button-class 存在时，theme-color 不生效", "defaultValue": "#3388FF" }, "bindGetPhoneNumber": { "tsType": "() => void", "description": "用户完成授权后，获取用户手机号：\ndetail.errMsg 值为\"getPhoneNumber:ok\" 时代表用户信息获取成功；\ndetail.errMsg 值为\"getPhoneNumber:fail auth deny\"时代表用户信息获取失败。\n参考 用户数据的签名验证和加解密 对用户数据进行处理获得用户手机号。\n用户手机号信息解密后数据示例：{\"mobile\":\"15000000000\"}\n1. 非个人开发者可申请；\n2. 审核通过后，进入小程序首页,在左侧导航栏单击“设置 -> 开发设置”。下拉页面，在“获取用户手机号权限申请”中单击“申请开通”" }, "bindLoadError": { "tsType": "() => void", "description": "组件加载失败回调" } }, "additionalProperties": false } }, { "key": "map", "value": { "title": "map", "type": "object", "properties": { "longitude": { "type": "number", "description": "gcj02 坐标系中心经度" }, "latitude": { "type": "number", "description": "gcj02 坐标系中心纬度" }, "scale": { "type": "number", "description": "缩放级别，取值范围为 4-21 。动态设置 scale 值用法：scale=\"{= scale =}\"", "defaultValue": 16 }, "markers": { "type": "array.", "description": "标记点。详情请参考 marker" }, "polyline": { "type": "array.", "description": "路线。详情请参考 polyline" }, "polygons": { "type": "array.", "description": "多边形。详情请参考 polygon" }, "circles": { "type": "array.", "description": "圆。详情请参考 circle" }, "controls": { "type": "array.", "description": "控件。详情请参考 control" }, "include-points": { "type": "array.", "description": "缩放视野以包含所有给定的坐标点" }, "show-location": { "type": "boolean", "description": "显示带有方向的当前定位点", "defaultValue": false }, "enable-3D": { "type": "boolean", "description": "显示 3D 楼块（工具暂不支持）", "defaultValue": false }, "show-compass": { "type": "boolean", "description": "显示指南针（工具暂不支持）", "defaultValue": false }, "enable-overlooking": { "type": "boolean", "description": "开启俯视（工具暂不支持）", "defaultValue": false }, "enable-zoom": { "type": "boolean", "description": "是否支持缩放（工具暂不支持）", "defaultValue": true }, "enable-scroll": { "type": "boolean", "description": "是否支持拖动（工具暂不支持）", "defaultValue": true }, "enable-rotate": { "type": "boolean", "description": "是否支持旋转（工具暂不支持）", "defaultValue": false }, "bindMarkerTap": { "tsType": "() => void", "description": "点击标记点时触发" }, "bindCallOutTap": { "tsType": "() => void", "description": "点击标记点对应的气泡时触发" }, "bindControlTap": { "tsType": "() => void", "description": "点击控件时触发" }, "bindRegionChange": { "tsType": "() => void", "description": "视野发生变化时触发" }, "bindTap": { "tsType": "() => void", "description": "点击地图时触发" }, "bindUpdated": { "tsType": "() => void", "description": "在地图渲染更新完成时触发" }, "bindPoiTap": { "tsType": "() => void", "description": "点击地图 poi 点时触发" } }, "additionalProperties": false, "required": [ "longitude", "latitude" ] } }, { "key": "movable-area", "value": { "title": "movable-area", "type": "object", "properties": { "scale-area": { "type": "boolean", "description": "当里面的 movable-view 设置为支持双指缩放时，设置此值可将缩放手势生效区域修改为整个 movable-area", "defaultValue": false } }, "additionalProperties": false } }, { "key": "movable-view", "value": { "title": "movable-view", "type": "object", "properties": { "direction": { "type": "string", "description": "movable-view 的移动方向，属性值有 all、vertical、horizontal、none", "defaultValue": "none", "enum": [ "all", "vertical", "horizontal", "none" ] }, "inertia": { "type": "boolean", "description": "movable-view 是否带有惯性", "defaultValue": false }, "out-of-bounds": { "type": "boolean", "description": "超过可移动区域后，movable-view 是否还可以移动", "defaultValue": false }, "x": { "type": "number", "description": "定义 x 轴方向的偏移，如果 x 的值不在可移动范围内，会自动移动到可移动范围；改变 x 的值会触发动画" }, "y": { "type": "number", "description": "定义 y 轴方向的偏移，如果 y 的值不在可移动范围内，会自动移动到可移动范围；改变 y 的值会触发动画" }, "damping": { "type": "number", "description": "阻尼系数，用于控制 x 或 y 改变时的动画和过界回弹的动画，值越大移动越快", "defaultValue": 20 }, "friction": { "type": "number", "description": "摩擦系数，用于控制惯性滑动的动画，值越大摩擦力越大，滑动越快停止；必须大于 0，否则会被设置成默认值", "defaultValue": 2 }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "scale": { "type": "boolean", "description": "是否支持双指缩放，默认缩放手势生效区域是在 movable-view 内", "defaultValue": false }, "scale-min": { "type": "number", "description": "定义缩放倍数最小值", "defaultValue": 0.5 }, "scale-max": { "type": "number", "description": "定义缩放倍数最大值", "defaultValue": 10 }, "scale-value": { "type": "number", "description": "定义缩放倍数，取值范围为 0.5-10", "defaultValue": 1 }, "animation": { "type": "boolean", "description": "是否使用动画", "defaultValue": true }, "bindChange": { "tsType": "() => void", "description": "拖动过程中触发的事件，event.detail = {x: x, y: y, source: source}，其中 source 表示产生移动的原因，值可为 touch（拖动）" }, "bindScale": { "tsType": "() => void", "description": "缩放过程中触发的事件，event.detail = {x: x, y: y, scale: scale}" }, "bindHTouchMove": { "tsType": "() => void", "description": "手指初次触摸后发生横向移动，如果 catch 此事件，则意味着 touchmove 事件也被 catch" }, "bindVTouchMove": { "tsType": "() => void", "description": "手指初次触摸后发生纵向移动，如果 catch 此事件，则意味着 touchmove 事件也被 catch" } }, "additionalProperties": false } }, { "key": "navigator", "value": { "title": "navigator", "type": "object", "properties": { "target": { "type": "string", "description": "在哪个目标上发生跳转，默认当前小程序，有效值 self/miniProgram", "defaultValue": "self", "enum": [ "self", "miniProgram" ] }, "url": { "type": "string", "description": "应用内的跳转链接" }, "open-type": { "type": "string", "description": "跳转方式", "defaultValue": "navigate", "enum": [ "navigate", "redirect", "switchTab", "navigateBack", "reLaunch", "exit" ] }, "delta": { "type": "number", "description": "当 open-type 为navigateBack时有效，表示回退的层数" }, "app-id": { "type": "string", "description": "当target=\"miniProgram\"时有效，要打开的小程序 App Key (小程序后台设置-开发设置中)" }, "path": { "type": "string", "description": "当target=\"miniProgram\"时有效，打开的页面路径，如果为空则打开首页" }, "extra-data": { "type": "object", "description": "当target=\"miniProgram\"时有效，需要传递给目标小程序的数据，目标小程序可在 App.onLaunch、App.onShow 中获取到这份数据" }, "version": { "type": "string", "description": "当target=\"miniProgram\"时有效，要打开的小程序版本，有效值 develop（开发版），trial（体验版），release（正式版），仅在当前小程序为开发版或体验版时此参数有效；如果当前小程序是正式版，则打开的小程序必定是正式版", "defaultValue": "release", "enum": [ "develop", "trial", "release" ] }, "hover-class": { "type": "string", "description": "指定点击时的样式类，当hover-class=\"none\"时，没有点击态效果", "defaultValue": "navigator-hover" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态（单位：毫秒）", "defaultValue": 50 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间（单位：毫秒）", "defaultValue": 600 }, "bindSuccess": { "tsType": "() => void", "description": "当target=\"miniProgram\"时有效，跳转小程序成功时触发 success 事件,event.detail = {errMsg: errMsg}" }, "bindFail": { "tsType": "() => void", "description": "当target=\"miniProgram\"时有效，跳转小程序失败时触发 fail 事件，event.detail 同上" }, "bindComplete": { "tsType": "() => void", "description": "当target=\"miniProgram\"时有效，跳转小程序完成时触发 complete 事件，event.detail 同上" } }, "additionalProperties": false } }, { "key": "open-data", "value": { "title": "open-data", "type": "object", "properties": { "type": { "type": "string", "description": "开放数据类型", "enum": [ "userNickName", "userAvatarUrl", "userGender" ] } }, "additionalProperties": false, "required": [ "type" ] } }, { "key": "picker-view", "value": { "title": "picker-view", "type": "object", "properties": { "value": { "type": "array", "description": "数组中的数字依次表示 picker-view 内的 picker-view-colume 选择的第几项（下标从 0 开始），数字大于 picker-view-column 可选项长度时，选择最后一项", "defaultValue": "[]" }, "indicator-style": { "type": "string", "description": "设置选择器中间选中框的样式" }, "indicator-class": { "type": "string", "description": "设置选择器中间选中框的类名" }, "mask-style": { "type": "string", "description": "设置蒙层的样式" }, "mask-class": { "type": "string", "description": "设置蒙层的类名" }, "title": { "type": "string", "description": "选择器标题，建议标题控制在 12 个中文汉字长度内，避免出现截断现象, 截断部分将以 ... 形式展示" }, "bindChange": { "tsType": "() => void", "description": "当滚动选择，value 改变时触发 change 事件，event.detail = {value: value};value 为数组，表示 picker-view 内的 picker-view-column 当前选择的是第几项（下标从 0 开始）" } }, "additionalProperties": false } }, { "key": "picker", "value": { "title": "picker", "type": "object", "properties": { "mode": { "type": "string", "description": "选择器类型", "defaultValue": "selector" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "bindCancel": { "tsType": "() => void", "description": "取消选择或点击遮罩层收起 picker 时触发" } }, "additionalProperties": false } }, { "key": "progress", "value": { "title": "progress", "type": "object", "properties": { "percent": { "type": "number", "description": "百分比 0~100%", "defaultValue": 0 }, "show-info": { "type": "boolean", "description": "在进度条右侧显示百分比", "defaultValue": false }, "stroke-width": { "type": [ "number", "string" ], "description": "进度条的高度（单位：px）", "defaultValue": "2" }, "border-radius": { "type": [ "number", "string" ], "description": "圆角大小（单位：px）", "defaultValue": "0" }, "font-size": { "type": [ "number", "string" ], "description": "右侧百分比字体大小（单位：px）", "defaultValue": "16" }, "color": { "type": "string", "description": "进度条颜色（推荐使用 active-color）", "defaultValue": "#09BB07" }, "active-color": { "type": "string", "description": "已选择的进度条的颜色", "defaultValue": "#09BB07" }, "background-color": { "type": "string", "description": "未选择的进度条的颜色", "defaultValue": "#E6E6E6" }, "active": { "type": "boolean", "description": "进度条从左往右的动画", "defaultValue": false }, "active-mode": { "type": "string", "description": "backwards：动画从头播；forwards：动画从上次结束点接着播", "defaultValue": "backwards" }, "duration": { "type": "number", "description": "进度增加 1% 所需毫秒数", "defaultValue": 20 } }, "additionalProperties": false } }, { "key": "radio-group", "value": { "title": "radio-group", "type": "object", "properties": { "bindChange": { "tsType": "() => void", "description": " 中的选中项发生变化时触发 change 事件，event.detail = {value: 选中项 radio 的 value}" } }, "additionalProperties": false } }, { "key": "radio", "value": { "title": "radio", "type": "object", "properties": { "value": { "type": "string", "description": " 组件标识。当该 选中时， 的 change 事件会携带 的 value", "defaultValue": " " }, "checked": { "type": "boolean", "description": "当前是否选中", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "color": { "type": "string", "description": "radio 的颜色，同 CSS 的 color", "defaultValue": "#3c76ff" } }, "additionalProperties": false } }, { "key": "rich-text", "value": { "title": "rich-text", "type": "object", "properties": { "nodes": { "type": [ "any[]", "string" ], "description": "节点列表/HTML String 。推荐使用 Array 类型，由于组件会将 String 类型转换为 Array 类型，性能有所下降", "defaultValue": "[]" }, "selectable": { "type": "boolean", "description": "富文本是否可以长按选中，可用于复制，粘贴，长按搜索等场景", "defaultValue": false }, "image-menu-prevent": { "type": "boolean", "description": "阻止长按图片时弹起默认菜单（将该属性设置为image-menu-prevent或image-menu-prevent=\"true\"），只在初始化时有效，不能动态变更；若不想阻止弹起默认菜单，则不需要设置此属性", "defaultValue": false }, "preview": { "type": "boolean", "description": "富文本中的图片是否可点击预览。在不设置的情况下，若 rich-text 未监听点击事件，则默认开启。未显示设置 preview 时会进行点击默认预览判断，建议显示设置 preview" } }, "additionalProperties": false } }, { "key": "rtc-room-item", "value": { "title": "rtc-room-item", "type": "object", "properties": { "id": { "type": "string", "description": "rtc-room-item 组件的唯一标识符" }, "type": { "type": "string", "description": "指定 item 展示本地 / 远端画面，有效值：local、remote ，不可动态变更" }, "user-id": { "type": "number", "description": "item 展示画面的用户 id" } }, "additionalProperties": false, "required": [ "type", "user-id" ] } }, { "key": "rtc-room", "value": { "title": "rtc-room", "type": "object", "properties": { "id": { "type": "string", "description": "rtc-room 组件的唯一标识符" }, "enable-camera": { "type": "boolean", "description": "是否开启摄像头", "defaultValue": true }, "enable-auto-focus": { "type": "boolean", "description": "是否开启摄像头自动对焦", "defaultValue": true }, "enable-zoom": { "type": "boolean", "description": "是否支持双手滑动调整摄像头聚焦", "defaultValue": false }, "device-position": { "type": "string", "description": "设置前置还是后置摄像头，有效值：front、back", "defaultValue": "front", "enum": [ "front", "back" ] }, "enable-mic": { "type": "boolean", "description": "是否开启麦克风", "defaultValue": true }, "enable-agc": { "type": "boolean", "description": "是否开启音频自动增益", "defaultValue": false }, "enable-ans": { "type": "boolean", "description": "是否开启音频噪声抑制", "defaultValue": false }, "bitrate": { "type": "number", "description": "最大码率", "defaultValue": 900 }, "video-width": { "type": "number", "description": "视频分辨率宽", "defaultValue": 360 }, "video-height": { "type": "number", "description": "视频分辨率高", "defaultValue": 640 }, "enable-remote-mirror": { "type": "boolean", "description": "设置远端看到的画面的镜像效果，该属性的变化不会影响到本地画面，仅影响远端看到的画面效果", "defaultValue": false }, "local-mirror": { "type": "string", "description": "设置本地摄像头预览画面的镜像效果，有效值：auto、enable、disable", "defaultValue": "auto", "enum": [ "auto", "enable", "disable" ] }, "sound-mode": { "type": "string", "description": "设置声音输出方式，有效值：speaker、ear", "defaultValue": "speaker", "enum": [ "speaker", "ear" ] }, "bindStateChange": { "tsType": "() => void", "description": "房间状态变化事件，参考下方状态码，detail = { code, msg, userInfo }" }, "bindError": { "tsType": "() => void", "description": "错误事件。参考下方错误码，detail = { errMsg, errCode }" } }, "additionalProperties": false, "required": [ "id" ] } }, { "key": "scroll-view", "value": { "title": "scroll-view", "type": "object", "properties": { "scroll-x": { "type": "boolean", "description": "允许横向滚动", "defaultValue": false }, "scroll-y": { "type": "boolean", "description": "允许纵向滚动", "defaultValue": false }, "upper-threshold": { "type": [ "number", "string" ], "description": "距顶部 / 左边多远时（单位 px），触发 scrolltoupper 事件", "defaultValue": "50" }, "lower-threshold": { "type": [ "number", "string" ], "description": "距底部 / 右边多远时（单位 px），触发 scrolltolower 事件", "defaultValue": "50" }, "enhanced": { "type": "boolean", "description": "启用 scroll-view 增强特性", "defaultValue": false }, "bounces": { "type": "boolean", "description": "iOS 下 scroll-view 边界弹性控制 (同时开启 enhanced 属性后生效)", "defaultValue": true }, "scroll-top": { "type": [ "number", "string" ], "description": "设置竖向滚动条位置。要动态设置滚动条位置，用法scroll-top=\"{= scrollTop =}\"。\n如果在设置组件渲染数据的同时设置了 scroll-top、scroll-left 值，需要在 swan.nextTick 回调中设置 scroll-top、scroll-left ，确保滚动条位置准确" }, "scroll-left": { "type": [ "number", "string" ], "description": "设置横向滚动条位置。要动态设置滚动条位置，用法scroll-left=\"{= scrollLeft =}\"。\n如果在设置组件渲染数据的同时设置了 scroll-top、scroll-left 值，需要在 swan.nextTick 回调中设置 scroll-top、scroll-left ，确保滚动条位置准确" }, "scroll-into-view": { "type": "string", "description": "值应为某子元素 id（id 不能以数字开头）。设置滚动方向后，按方向滚动到该元素，动态设置用法scroll-into-view=\"{= scrollIntoView =}\"" }, "scroll-with-animation": { "type": "boolean", "description": "在设置滚动条位置时使用动画过渡", "defaultValue": false }, "enable-back-to-top": { "type": "boolean", "description": "安卓双击标题栏时，滚动条返回顶部，只支持竖向\n注：iOS 端暂不支持", "defaultValue": false }, "bindScrollToUpper": { "tsType": "() => void", "description": "滚动到顶部 / 左边，会触发 scrolltoupper 事件" }, "bindScrollToLower": { "tsType": "() => void", "description": "滚动到底部 / 右边，会触发 scrolltolower 事件" }, "bindScroll": { "tsType": "() => void", "description": "滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY}" } }, "additionalProperties": false } }, { "key": "slider", "value": { "title": "slider", "type": "object", "properties": { "min": { "type": "number", "description": "最小值", "defaultValue": 0 }, "max": { "type": "number", "description": "最大值", "defaultValue": 100 }, "step": { "type": "number", "description": "步长，取值必须大于 0，并且可被 max - min 整除", "defaultValue": 1 }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "value": { "type": "number", "description": "当前取值", "defaultValue": 0 }, "background-color": { "type": "string", "description": "背景条的颜色", "defaultValue": "#cccccc" }, "block-size": { "type": "number", "description": "滑块的大小，取值范围为 12-28", "defaultValue": 24 }, "block-color": { "type": "string", "description": "滑块的颜色", "defaultValue": "#ffffff" }, "active-color": { "type": "string", "description": "已选择的颜色", "defaultValue": "#3c76ff" }, "show-value": { "type": "boolean", "description": "是否显示当前 value", "defaultValue": false }, "bindChange": { "tsType": "() => void", "description": "完成一次拖动后触发的事件，event.detail = {value: value}" }, "bindChanging": { "tsType": "() => void", "description": "拖动过程中触发的事件，event.detail = {value: value}" } }, "additionalProperties": false } }, { "key": "swiper-item", "value": { "title": "swiper-item", "type": "object", "properties": { "item-id": { "type": "string", "description": "该 swiper-item 的标识符" } }, "additionalProperties": false } }, { "key": "swiper", "value": { "title": "swiper", "type": "object", "properties": { "indicator-dots": { "type": "boolean", "description": "是否显示面板指示点", "defaultValue": false }, "indicator-color": { "type": "string", "description": "指示点颜色", "defaultValue": "rgba(0, 0, 0, .3)" }, "indicator-active-color": { "type": "string", "description": "当前选中的指示点颜色", "defaultValue": "#333" }, "autoplay": { "type": "boolean", "description": "是否自动切换", "defaultValue": false }, "current": { "type": "number", "description": "当前所在页面的 index", "defaultValue": 0 }, "current-item-id": { "type": "string", "description": "当前所在滑块的 item-id ，不能与 current 被同时指定" }, "interval": { "type": "number", "description": "自动切换时间间隔（单位：ms）", "defaultValue": 5000 }, "duration": { "type": "number", "description": "滑动动画时长（单位：ms）", "defaultValue": 500 }, "circular": { "type": "boolean", "description": "是否采用衔接滑动", "defaultValue": false }, "vertical": { "type": "boolean", "description": "滑动方向是否为纵向", "defaultValue": false }, "previous-margin": { "type": "string", "description": "前边距，可用于露出前一项的一小部分，支持 px 和 rpx", "defaultValue": "\"0px\"" }, "next-margin": { "type": "string", "description": "后边距，可用于露出后一项的一小部分，支持 px 和 rpx", "defaultValue": "\"0px\"" }, "display-multiple-items": { "type": "number", "description": "同时显示的滑块数量", "defaultValue": 1 }, "disable-touchmove": { "type": "boolean", "description": "是否停止响应用户 touchmove 操作", "defaultValue": false }, "bindChange": { "tsType": "() => void", "description": "current 改变时会触发 change 事件，event.detail = {current: current, source: source}" }, "bindAnimationFinish": { "tsType": "() => void", "description": "动画结束时会触发 animationfinish 事件，event.detail 同上" } }, "additionalProperties": false } }, { "key": "switch", "value": { "title": "switch", "type": "object", "properties": { "checked": { "type": "boolean", "description": "是否选中", "defaultValue": false }, "type": { "type": "string", "description": "样式，有效值：switch、checkbox", "defaultValue": "switch", "enum": [ "switch", "checkbox" ] }, "color": { "type": "string", "description": "switch 的颜色，同 CSS 的 color", "defaultValue": "#3388ff" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "bindChange": { "tsType": "() => void", "description": "checked 改变时触发 change 事件，event.detail = {checked: true}" } }, "additionalProperties": false } }, { "key": "tab-item", "value": { "title": "tab-item", "type": "object", "properties": { "label": { "type": "string", "description": "tab-item 内显示的文字", "defaultValue": "无" }, "name": { "type": "string", "description": "tab-item 对应的 name 值", "defaultValue": "无" }, "badge-type": { "type": "string", "description": "徽标类型 badge-type 分为圆点“dot”和文本“text”，不设置 badge-type 则不显示徽标", "defaultValue": "无" }, "badge-text": { "type": "string", "description": "badge-type 为 text 的时候，徽标内的数字，为空时badge-type=\"text\"不生效", "defaultValue": "无" } }, "additionalProperties": false, "required": [ "label", "name" ] } }, { "key": "tabs", "value": { "title": "tabs", "type": "object", "properties": { "tabs-background-color": { "type": "string", "description": "tabs 背景色,必须填写十六进制颜色", "defaultValue": "'#fff'" }, "tabs-active-text-color": { "type": "string", "description": "tabs 激活 tab-item 文字颜色", "defaultValue": "'#000'" }, "tabs-inactive-text-color": { "type": "string", "description": "tabs 非激活 tab-item 文字颜色", "defaultValue": "'#666'" }, "tabs-underline-color": { "type": "string", "description": "tabs 激活 tab-item 下划线颜色", "defaultValue": "'#333'" }, "active-name": { "type": "string", "description": "仅用于普通标签栏组件，当前激活 tab-item 的对应的 name 值，须搭配 bindtabchange 一起使用。", "defaultValue": "无" }, "url-query-name": { "type": "string", "description": "仅用于可寻址标签栏组件，当前 tab 所改变的 url query 中参数 key，需要通过 tabs 修改页面 url 的时候设置。", "defaultValue": "无" }, "max-tab-item-amount": { "type": "number", "description": "当前 tabs 视图中最多容纳的 tab-item 数量，低于此数量均分排列，超出此数量划屏。默认五个，开发者可根据业务需求调整", "defaultValue": 5 }, "bindTabChange": { "tsType": "() => void", "description": "tab 被点击的回调，可以在 e.detail.name 中取到当前点击的 tab-item 对应的 name 值" } }, "additionalProperties": false } }, { "key": "text", "value": { "title": "text", "type": "object", "properties": { "space": { "type": "string", "description": "显示连续空格", "enum": [ "ensp", "emsp", "nbsp" ] }, "selectable": { "type": "boolean", "description": "文本是否可选。true：可用于文本复制，粘贴，长按搜索等场景。3.150.1 以后版本只能通过字面量的方式设置，不支持变量", "defaultValue": false } }, "additionalProperties": false } }, { "key": "textarea", "value": { "title": "textarea", "type": "object", "properties": { "value": { "type": "string", "description": "输入框的内容，若要动态设置输入框内容，需设置value = \"{= value =}\"（注：若要取键盘输入后的 value 请通过 bindinput 获取）" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大输入长度，设置为 -1 的时候不限制最大长度", "defaultValue": 140 }, "placeholder": { "type": "string", "description": "输入框为空时占位符。其样式暂时只支持设置 text-align、font-size、font-weight、color" }, "placeholder-style": { "type": "string", "description": "指定 placeholder 的样式" }, "placeholder-class": { "type": "string", "description": "指定 placeholder 的样式类" }, "auto-height": { "type": "boolean", "description": "是否自动增高，设置 auto-height 时，style.height 不生效", "defaultValue": false }, "cursor": { "type": "number", "description": "指定 focus 时的光标位置，自动聚焦时才会生效", "defaultValue": -1 }, "auto-focus": { "type": "boolean", "description": "自动聚焦，调起键盘", "defaultValue": false }, "confirm-type": { "type": "string", "description": "设置键盘右下角按钮的文字", "defaultValue": "default", "enum": [ "default", "done", "send", "search", "next", "go" ] }, "confirm-hold": { "type": "boolean", "description": "点击键盘右下角按钮时是否保持键盘不收起", "defaultValue": false }, "focus": { "type": "boolean", "description": "获取焦点，调起键盘", "defaultValue": false }, "fixed": { "type": "boolean", "description": "如果 textarea 是在一个position: fixed的区域，需要显示指定属性 fixed 为 true", "defaultValue": false }, "cursor-spacing": { "type": "number", "description": "指定光标与键盘的距离（单位：px）。取 textarea 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离", "defaultValue": 0 }, "show-confirm-bar": { "type": "boolean", "description": "是否显示键盘上方带有“完成”按钮那一栏", "defaultValue": true }, "selection-start": { "type": "number", "description": "光标起始位置，自动聚焦时有效，需与 selection-end 搭配使用", "defaultValue": -1 }, "selection-end": { "type": "number", "description": "光标结束位置，自动聚焦时有效，需与 selection-start 搭配使用", "defaultValue": -1 }, "adjust-position": { "type": "boolean", "description": "键盘弹起时，是否自动上推页面", "defaultValue": true }, "bindFocus": { "tsType": "() => void", "description": "输入框聚焦时触发，event.detail = {value, height}，height 为键盘高度" }, "bindBlur": { "tsType": "() => void", "description": "输入框失去焦点时触发，event.detail = {value, cursor}" }, "bindLineChange": { "tsType": "() => void", "description": "输入框行数变化时调用，event.detail = {height: 0, heightRpx: 0, lineCount: 0, lineHeight: 0}" }, "bindInput": { "tsType": "() => void", "description": "当键盘输入时，触发 input 事件，event.detail = {value, cursor}，bindinput 处理函数的返回值并不会反映到 textarea 上" }, "bindConfirm": { "tsType": "() => void", "description": "点击完成时，触发 confirm 事件，event.detail = {value: value}" } }, "additionalProperties": false } }, { "key": "video", "value": { "title": "video", "type": "object", "properties": { "src": { "type": "string", "description": "视频的资源地址，支持云文件 ID" }, "title": { "type": "string", "description": "视频标题，全屏时在视频顶部展示" }, "initial-time": { "type": "number", "description": "指定视频初始播放位置" }, "controls": { "type": "boolean", "description": "是否显示默认播放控件（播放/暂停按钮、播放进度、时间）", "defaultValue": true }, "autoplay": { "type": "boolean", "description": "是否自动播放", "defaultValue": false }, "loop": { "type": "boolean", "description": "是否循环播放", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音播放", "defaultValue": false }, "objectFit": { "type": "string", "description": "当视频大小与 video 容器大小不一致时，视频的表现形式。contain：包含；fill：填充；cover：覆盖", "defaultValue": "contain", "enum": [ "contain", "fill", "cover" ] }, "poster": { "type": "string", "description": "视频封面的图片网络资源地址，支持云文件 ID" }, "page-gesture": { "type": "boolean", "description": "在非全屏模式下，是否开启使用手势调节亮度与音量，兼容 vslide-gesture 属性", "defaultValue": false }, "direction": { "type": "number", "description": "按设置的视频全屏方向进入全屏。不指定视频全屏方向时则根据设备方向判断全屏方向。0：正常竖向；90：屏幕顺时针 90 度；-90：屏幕逆时针 90 度", "enum": [ "0", "90", "-90" ] }, "show-progress": { "type": "boolean", "description": "若不设置，宽度大于 240 时才会显示", "defaultValue": true }, "show-fullscreen-btn": { "type": "boolean", "description": "是否显示全屏按钮", "defaultValue": true }, "enable-progress-gesture": { "type": "boolean", "description": "是否开启使用手势控制进度", "defaultValue": true }, "danmu-list": { "type": "array.", "description": "弹幕列表" }, "danmu-btn": { "type": "boolean", "description": "是否显示弹幕按钮，只在初始化时有效，不能动态变更", "defaultValue": false }, "enable-danmu": { "type": "boolean", "description": "是否展示弹幕，只在初始化时有效，不能动态变更", "defaultValue": false }, "show-play-btn": { "type": "boolean", "description": "是否显示视频底部控制栏的播放按钮", "defaultValue": true }, "show-center-play-btn": { "type": "boolean", "description": "是否显示视频中间的播放按钮", "defaultValue": true }, "show-mute-btn": { "type": "boolean", "description": "是否显示静音按钮", "defaultValue": false }, "show-no-wifi-tip": { "type": "boolean", "description": "非 wifi 环境下是否显示继续播放浮层", "defaultValue": true }, "vslide-gesture": { "type": "boolean", "description": "非全屏模式下，是否开启亮度与音量调节手势，兼容 page-gesture 属性", "defaultValue": false }, "vslide-gesture-in-fullscreen": { "type": "boolean", "description": "全屏模式下，是否开启亮度与音量调节手势", "defaultValue": true }, "show-lock-btn": { "type": "boolean", "description": "全屏模式下，是否显示锁屏按钮", "defaultValue": true }, "enable-play-gesture": { "type": "boolean", "description": "是否开启播放手势，即双击切换播放/暂停", "defaultValue": false }, "show-rate-btn": { "type": "boolean", "description": "是否显示倍速播放按钮", "defaultValue": false }, "show-vslide-btn-in-fullscreen": { "type": "boolean", "description": "全屏模式下，是否显示侧边栏控制按钮", "defaultValue": true }, "silent-play": { "type": "boolean", "description": "是否进入无声视频模式，进入无声视频模式后，视频将静音播放且不响应系统物理音量变化，点击播放器提示无声视频，手势调节失效", "defaultValue": false }, "bindPlay": { "tsType": "() => void", "description": "当开始播放时触发 play 事件" }, "bindPause": { "tsType": "() => void", "description": "当暂停播放时触发 pause 事件" }, "bindEnded": { "tsType": "() => void", "description": "当播放到末尾时触发 ended 事件" }, "bindTimeUpdate": { "tsType": "() => void", "description": "播放进度变化时触发。event.detail = {currentTime, duration}" }, "bindFullScreenChange": { "tsType": "() => void", "description": "当视频进入和退出全屏时触发。event.detail = {fullscreen, direction}，direction 取为 vertical 或 horizontal" }, "bindWaiting": { "tsType": "() => void", "description": "视频出现缓冲时触发" }, "bindError": { "tsType": "() => void", "description": "视频播放出错时触发" }, "bindLoadedMetaData": { "tsType": "() => void", "description": "视频元数据加载完成时触发。event.detail = {width, height, duration}" }, "bindControlsToggle": { "tsType": "() => void", "description": "切换controls控件显示隐藏时触发。event.detail = {show}" } }, "additionalProperties": false, "required": [ "src" ] } }, { "key": "view", "value": { "title": "view", "type": "object", "properties": { "hover-class": { "type": "string", "description": "指定按下去的样式类。当hover-class=\"none\"时，没有点击态效果", "defaultValue": "none" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后出现点击态的时间长度（单位：毫秒）", "defaultValue": 50 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留的时间长度（单位：毫秒）", "defaultValue": 400 } }, "additionalProperties": false } }, { "key": "web-view", "value": { "title": "web-view", "type": "object", "properties": { "src": { "type": "string", "description": "web-view 指向网页的链接" }, "bindMessage": { "tsType": "() => void", "description": "网页向小程序 postMessage 时，会在特定时机（小程序后退、组件销毁、分享）触发并收到消息。e.detail = { data }" } }, "additionalProperties": false, "required": [ "src" ] } } ] }, { "key": "weapp", "value": [ { "key": "ad-custom", "value": { "title": "ad-custom", "type": "object", "properties": { "unit-id": { "type": "string", "description": "广告单元id，可在小程序管理后台的流量主模块新建" }, "ad-intervals": { "type": "number", "description": "广告自动刷新的间隔时间，单位为秒，参数值必须大于等于30（该参数不传入时 模板 广告不会自动刷新）" }, "bindLoad": { "tsType": "() => void", "description": "广告加载成功的回调" }, "bindError": { "tsType": "() => void", "description": "广告加载失败的回调，event.detail = {errCode: 1002}" } }, "additionalProperties": false, "required": [ "unit-id" ] } }, { "key": "ad", "value": { "title": "ad", "type": "object", "properties": { "unit-id": { "type": "string", "description": "广告单元id，可在小程序管理后台的流量主模块新建" }, "ad-intervals": { "type": "number", "description": "广告自动刷新的间隔时间，单位为秒，参数值必须大于等于30（该参数不传入时 Banner 广告不会自动刷新）" }, "ad-type": { "type": "string", "description": "广告类型，默认为展示banner，可通过设置该属性为video展示视频广告, grid为格子广告", "defaultValue": "banner" }, "ad-theme": { "type": "string", "defaultValue": "white" }, "bindLoad": { "tsType": "() => void", "description": "广告加载成功的回调" }, "bindError": { "tsType": "() => void", "description": "广告加载失败的回调，event.detail = {errCode: 1002}" }, "bindClose": { "tsType": "() => void", "description": "广告关闭的回调" } }, "additionalProperties": false, "required": [ "unit-id" ] } }, { "key": "audio", "value": { "title": "audio", "type": "object", "properties": { "id": { "type": "string", "description": "audio 组件的唯一标识符" }, "src": { "type": "string", "description": "要播放音频的资源地址" }, "loop": { "type": "boolean", "description": "是否循环播放", "defaultValue": false }, "controls": { "type": "boolean", "description": "是否显示默认控件", "defaultValue": false }, "poster": { "type": "string", "description": "默认控件上的音频封面的图片资源地址，如果 controls 属性值为 false 则设置 poster 无效" }, "name": { "type": "string", "description": "默认控件上的音频名字，如果 controls 属性值为 false 则设置 name 无效", "defaultValue": "未知音频" }, "author": { "type": "string", "description": "默认控件上的作者名字，如果 controls 属性值为 false 则设置 author 无效", "defaultValue": "未知作者" }, "bindError": { "tsType": "() => void", "description": "当发生错误时触发 error 事件，detail = {errMsg:MediaError.code}" }, "bindPlay": { "tsType": "() => void", "description": "当开始/继续播放时触发play事件" }, "bindPause": { "tsType": "() => void", "description": "当暂停播放时触发 pause 事件" }, "bindTimeUpdate": { "tsType": "() => void", "description": "当播放进度改变时触发 timeupdate 事件，detail = {currentTime, duration}" }, "bindEnded": { "tsType": "() => void", "description": "当播放到末尾时触发 ended 事件" } }, "additionalProperties": false } }, { "key": "button", "value": { "title": "button", "type": "object", "properties": { "size": { "type": "string", "description": "按钮的大小", "defaultValue": "default", "enum": [ "default", "mini" ] }, "type": { "type": "string", "description": "按钮的样式类型", "defaultValue": "default", "enum": [ "primary", "default", "warn" ] }, "plain": { "type": "boolean", "description": "按钮是否镂空，背景色透明", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "loading": { "type": "boolean", "description": "loading 动画样式暂未支持", "defaultValue": false }, "form-type": { "type": "string", "description": "用于 form 组件，点击分别会触发 form 组件的 submit/reset 事件", "enum": [ "submit", "reset" ] }, "open-type": { "type": "string", "description": "微信开放能力", "enum": [ "contact", "share", "getPhoneNumber", "getUserInfo", "launchApp", "openSetting", "feedback", "chooseAvatar" ] }, "hover-class": { "type": "string", "description": "指定按钮按下去的样式类。当 `hover-class=\"none\"` 时，没有点击态效果", "defaultValue": "button-hover" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒", "defaultValue": 20 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒", "defaultValue": 70 }, "lang": { "type": "string", "description": "指定返回用户信息的语言，zh_CN 简体中文，zh_TW 繁体中文，en 英文。", "defaultValue": "en", "enum": [ "en", "zh_CN", "zh_TW" ] }, "session-from": { "type": "string", "description": "会话来源，open-type=\"contact\"时有效" }, "send-message-title": { "type": "string", "description": "会话内消息卡片标题，open-type=\"contact\"时有效", "defaultValue": "当前标题" }, "send-message-path": { "type": "string", "description": "会话内消息卡片点击跳转小程序路径，open-type=\"contact\"时有效", "defaultValue": "当前分享路径" }, "send-message-img": { "type": "string", "description": "会话内消息卡片图片，open-type=\"contact\"时有效", "defaultValue": "截图" }, "app-parameter": { "type": "string", "description": "打开 APP 时，向 APP 传递的参数，open-type=launchApp时有效" }, "show-message-card": { "type": "boolean", "description": "是否显示会话内消息卡片，设置此参数为 true，用户进入客服会话会在右下角显示\"可能要发送的小程序\"提示，用户点击后可以快速发送小程序消息，open-type=\"contact\"时有效", "defaultValue": false }, "bindGetUserInfo": { "tsType": "() => void", "description": "用户点击该按钮时，会返回获取到的用户信息，回调的detail数据与wx.getUserInfo返回的一致，open-type=\"getUserInfo\"时有效" }, "bindContact": { "tsType": "() => void", "description": "客服消息回调，open-type=\"contact\"时有效" }, "bindGetPhoneNumber": { "tsType": "() => void", "description": "获取用户手机号回调，open-type=getPhoneNumber时有效" }, "bindError": { "tsType": "() => void", "description": "当使用开放能力时，发生错误的回调，open-type=launchApp时有效" }, "bindOpenSetting": { "tsType": "() => void", "description": "在打开授权设置页后回调，open-type=openSetting时有效" }, "bindLaunchApp": { "tsType": "() => void", "description": "打开 APP 成功的回调，open-type=launchApp时有效" }, "bindChooseAvatar": { "tsType": "() => void", "description": "获取用户头像回调，open-type=chooseAvatar时有效" } }, "additionalProperties": false } }, { "key": "camera", "value": { "title": "camera", "type": "object", "properties": { "mode": { "type": "string", "description": "应用模式，只在初始化时有效，不能动态变更", "defaultValue": "normal", "enum": [ "normal", "scanCode" ] }, "resolution": { "type": "string", "description": "分辨率，不支持动态修改", "defaultValue": "medium", "enum": [ "low", "medium", "high" ] }, "device-position": { "type": "string", "description": "摄像头朝向", "defaultValue": "back", "enum": [ "front", "back" ] }, "flash": { "type": "string", "description": "闪光灯，值为auto, on, off", "defaultValue": "auto", "enum": [ "auto", "on", "off", "torch" ] }, "frame-size": { "type": "string", "description": "指定期望的相机帧数据尺寸", "defaultValue": "medium", "enum": [ "small", "medium", "large" ] }, "bindStop": { "tsType": "() => void", "description": "摄像头在非正常终止时触发，如退出后台等情况" }, "bindError": { "tsType": "() => void", "description": "用户不允许使用摄像头时触发" }, "bindInitDone": { "tsType": "() => void", "description": "相机初始化完成时触发，e.detail = {maxZoom}" }, "bindScanCode": { "tsType": "() => void", "description": "在扫码识别成功时触发，仅在 mode=\"scanCode\" 时生效" } }, "additionalProperties": false } }, { "key": "canvas", "value": { "title": "canvas", "type": "object", "properties": { "type": { "type": "string", "description": "指定 canvas 类型，支持 2d (2.9.0) 和 webgl (2.7.0)" }, "canvas-id": { "type": "string", "description": "canvas 组件的唯一标识符，若指定了 type 则无需再指定该属性" }, "disable-scroll": { "type": "boolean", "description": "当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新", "defaultValue": false }, "bindTouchStart": { "tsType": "() => void", "description": "手指触摸动作开始" }, "bindTouchMove": { "tsType": "() => void", "description": "手指触摸后移动" }, "bindTouchEnd": { "tsType": "() => void", "description": "手指触摸动作结束" }, "bindTouchCancel": { "tsType": "() => void", "description": "手指触摸动作被打断，如来电提醒，弹窗" }, "bindLongTap": { "tsType": "() => void", "description": "手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动" }, "bindError": { "tsType": "() => void", "description": "当发生错误时触发 error 事件，detail = {errMsg}" } }, "additionalProperties": false } }, { "key": "channel-live", "value": { "title": "channel-live", "type": "object", "properties": { "feed-id": { "type": "string", "description": "视频 feedId" }, "finder-user-name": { "type": "string", "description": "视频号 id，以“sph”开头的id，可在视频号助手获取。视频号必须与当前小程序相同主体。" } }, "additionalProperties": false, "required": [ "feed-id", "finder-user-name" ] } }, { "key": "channel-video", "value": { "title": "channel-video", "type": "object", "properties": { "feed-id": { "type": "string", "description": "仅视频号视频与小程序同主体时生效。若内嵌非同主体视频，请使用 feed-token。" }, "finder-user-name": { "type": "string", "description": "视频号 id，以“sph”开头的id，可在视频号助手获取。" }, "feed-token": { "type": "string", "description": "仅内嵌小程序非同主体视频号视频时使用，获取方式参考本指引。" }, "autoplay": { "type": "boolean", "description": "是否自动播放", "defaultValue": false }, "loop": { "type": "boolean", "description": "是否循环播放", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音播放", "defaultValue": false }, "object-fit": { "type": "string", "description": "当视频大小与 video 容器大小不一致时，视频的表现形式", "defaultValue": "contain", "enum": [ "contain", "fill", "cover" ] }, "bindError": { "tsType": "() => void", "description": "视频播放出错时触发" } }, "additionalProperties": false, "required": [ "feed-id", "finder-user-name", "feed-token", "autoplay" ] } }, { "key": "checkbox-group", "value": { "title": "checkbox-group", "type": "object", "properties": { "bindChange": { "tsType": "() => void", "description": "checkbox-group中选中项发生改变时触发 change 事件，detail = {value:[选中的checkbox的value的数组]}" } }, "additionalProperties": false } }, { "key": "checkbox", "value": { "title": "checkbox", "type": "object", "properties": { "value": { "type": "string", "description": "checkbox标识，选中时触发checkbox-group的 change 事件，并携带 checkbox 的 value" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "checked": { "type": "boolean", "description": "当前是否选中，可用来设置默认选中", "defaultValue": false }, "color": { "type": "string", "description": "checkbox的颜色，同css的color", "defaultValue": "#09BB07" } }, "additionalProperties": false } }, { "key": "cover-image", "value": { "title": "cover-image", "type": "object", "properties": { "src": { "type": "string", "description": "图标路径，支持临时路径、网络地址（1.6.0起支持）、云文件ID（2.2.3起支持）。" }, "referrer-policy": { "type": "string", "description": "格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；", "defaultValue": "no-referrer", "enum": [ "origin", "no-referrer" ] }, "bindLoad": { "tsType": "() => void", "description": "图片加载成功时触发" }, "bindError": { "tsType": "() => void", "description": "图片加载失败时触发" } }, "additionalProperties": false } }, { "key": "cover-view", "value": { "title": "cover-view", "type": "object", "properties": { "scroll-top": { "type": [ "number", "string" ], "description": "设置顶部滚动偏移量，仅在设置了 overflow-y: scroll 成为滚动元素后生效" } }, "additionalProperties": false } }, { "key": "editor", "value": { "title": "editor", "type": "object", "properties": { "read-only": { "type": "boolean", "description": "设置编辑器为只读", "defaultValue": false }, "placeholder": { "type": "string", "description": "提示信息" }, "show-img-size": { "type": "boolean", "description": "点击图片时显示图片大小控件", "defaultValue": false }, "show-img-toolbar": { "type": "boolean", "description": "点击图片时显示工具栏控件", "defaultValue": false }, "show-img-resize": { "type": "boolean", "description": "点击图片时显示修改尺寸控件", "defaultValue": false }, "bindReady": { "tsType": "() => void", "description": "编辑器初始化完成时触发" }, "bindFocus": { "tsType": "() => void", "description": "编辑器聚焦时触发，event.detail = {html, text, delta}" }, "bindBlur": { "tsType": "() => void", "description": "编辑器失去焦点时触发，detail = {html, text, delta}" }, "bindInput": { "tsType": "() => void", "description": "编辑器内容改变时触发，detail = {html, text, delta}" }, "bindStatusChange": { "tsType": "() => void", "description": "通过 Context 方法改变编辑器内样式时触发，返回选区已设置的样式" } }, "additionalProperties": false } }, { "key": "form", "value": { "title": "form", "type": "object", "properties": { "report-submit": { "type": "boolean", "description": "是否返回 formId 用于发送模板消息", "defaultValue": false }, "report-submit-timeout": { "type": "number", "description": "等待一段时间（毫秒数）以确认 formId 是否生效。如果未指定这个参数，formId 有很小的概率是无效的（如遇到网络失败的情况）。指定这个参数将可以检测 formId 是否有效，以这个参数的时间作为这项检测的超时时间。如果失败，将返回 requestFormId:fail 开头的 formId", "defaultValue": 0 }, "bindSubmit": { "tsType": "() => void", "description": "携带 form 中的数据触发 submit 事件，event.detail = {value : {'name': 'value'} , formId: ''}" }, "bindReset": { "tsType": "() => void", "description": "表单重置时会触发 reset 事件" } }, "additionalProperties": false } }, { "key": "functional-page-navigator", "value": { "title": "functional-page-navigator", "type": "object", "properties": { "version": { "type": "string", "description": "跳转到的小程序版本，**线上版本必须设置为 release**", "defaultValue": "release", "enum": [ "develop", "trial", "release" ] }, "name": { "type": "string", "description": "要跳转到的功能页", "enum": [ "loginAndGetUserInfo", "requestPayment", "chooseAddress", "chooseInvoice", "chooseInvoiceTitle" ] }, "args": { "type": "object", "description": "功能页参数，参数格式与具体功能页相关" }, "bindSuccess": { "tsType": "() => void", "description": "功能页返回，且操作成功时触发， detail 格式与具体功能页相关" }, "bindFail": { "tsType": "() => void", "description": "功能页返回，且操作失败时触发， detail 格式与具体功能页相关" }, "bindCancel": { "tsType": "() => void", "description": "因用户操作从功能页返回时触发" } }, "additionalProperties": false } }, { "key": "grid-view", "value": { "title": "grid-view", "type": "object", "properties": { "type": { "type": "string", "description": "布局方式", "defaultValue": "aligned", "enum": [ "aligned", "masonry" ] }, "cross-axis-count": { "type": "number", "description": "交叉轴元素数量", "defaultValue": 2 }, "max-cross-axis-extent": { "type": "number", "description": "交叉轴元素最大范围", "defaultValue": 0 }, "main-axis-gap": { "type": "number", "description": "主轴方向间隔", "defaultValue": 0 }, "cross-axis-gap": { "type": "number", "description": "交叉轴方向间隔", "defaultValue": 0 } }, "additionalProperties": false, "required": [ "type" ] } }, { "key": "icon", "value": { "title": "icon", "type": "object", "properties": { "type": { "type": "string", "description": "icon的类型，有效值：success, success_no_circle, info, warn, waiting, cancel, download, search, clear" }, "size": { "type": [ "number", "string" ], "description": "icon的大小，单位默认为px，2.4.0起支持传入单位(rpx/px)，2.21.3起支持传入其余单位(rem 等)。", "defaultValue": "23" }, "color": { "type": "string", "description": "icon的颜色，同css的color" } }, "additionalProperties": false, "required": [ "type" ] } }, { "key": "image", "value": { "title": "image", "type": "object", "properties": { "src": { "type": "string", "description": "图片资源地址" }, "mode": { "type": "string", "description": "图片裁剪、缩放的模式", "defaultValue": "scaleToFill", "enum": [ "scaleToFill", "aspectFit", "aspectFill", "widthFix", "heightFix", "top", "bottom", "center", "left", "right", "top left", "top right", "bottom left", "bottom right" ] }, "webp": { "type": "boolean", "description": "无需指定，默认支持", "defaultValue": false }, "lazy-load": { "type": "boolean", "description": "受 scroll-view 按需渲染影响，默认生效", "defaultValue": false }, "show-menu-by-longpress": { "type": "boolean", "description": "长按图片显示发送给朋友、收藏、保存图片、搜一搜、打开名片/前往群聊/打开小程序（若图片中包含对应二维码或小程序码）的菜单。", "defaultValue": false }, "fade-in": { "type": "boolean", "description": "是否渐显", "defaultValue": false }, "bindError": { "tsType": "() => void", "description": "当错误发生时触发，event.detail = {errMsg}" }, "bindLoad": { "tsType": "() => void", "description": "当图片载入完毕时触发，event.detail = {height, width}" } }, "additionalProperties": false } }, { "key": "input", "value": { "title": "input", "type": "object", "properties": { "value": { "type": "string", "description": "输入框的初始内容" }, "type": { "type": "string", "description": "input 的类型", "defaultValue": "text", "enum": [ "text", "number", "idcard", "digit", "safe-password", "nickname" ] }, "password": { "type": "boolean", "description": "是否是密码类型", "defaultValue": false }, "placeholder": { "type": "string", "description": "输入框为空时占位符" }, "placeholder-style": { "type": "string", "description": "指定 placeholder 的样式" }, "placeholder-class": { "type": "string", "description": "指定 placeholder 的样式类", "defaultValue": "input-placeholder" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大输入长度，设置为 -1 的时候不限制最大长度", "defaultValue": 140 }, "cursor-spacing": { "type": "number", "description": "指定光标与键盘的距离，取 input 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离", "defaultValue": 0 }, "auto-focus": { "type": "boolean", "description": "(即将废弃，请直接使用 focus )自动聚焦，拉起键盘", "defaultValue": false }, "focus": { "type": "boolean", "description": "获取焦点", "defaultValue": false }, "confirm-type": { "type": "string", "description": "设置键盘右下角按钮的文字，仅在type='text'时生效", "defaultValue": "done", "enum": [ "send", "search", "next", "go", "done" ] }, "always-embed": { "type": "boolean", "description": "强制 input 处于同层状态，默认 focus 时 input 会切到非同层状态 (仅在 iOS 下生效)", "defaultValue": false }, "confirm-hold": { "type": "boolean", "description": "点击键盘右下角按钮时是否保持键盘不收起", "defaultValue": false }, "cursor": { "type": "number", "description": "指定focus时的光标位置" }, "selection-start": { "type": "number", "description": "光标起始位置，自动聚集时有效，需与selection-end搭配使用", "defaultValue": -1 }, "selection-end": { "type": "number", "description": "光标结束位置，自动聚集时有效，需与selection-start搭配使用", "defaultValue": -1 }, "adjust-position": { "type": "boolean", "description": "键盘弹起时，是否自动上推页面", "defaultValue": true }, "hold-keyboard": { "type": "boolean", "description": "focus时，点击页面的时候不收起键盘", "defaultValue": false }, "safe-password-cert-path": { "type": "string", "description": "安全键盘加密公钥的路径，只支持包内路径" }, "safe-password-length": { "type": "number", "description": "安全键盘输入密码长度" }, "safe-password-time-stamp": { "type": "number", "description": "安全键盘加密时间戳" }, "safe-password-nonce": { "type": "string", "description": "安全键盘加密盐值" }, "safe-password-salt": { "type": "string", "description": "安全键盘计算hash盐值，若指定custom-hash 则无效" }, "safe-password-custom-hash": { "type": "string", "description": "安全键盘计算hash的算法表达式，如 `md5(sha1('foo' + sha256(sm3(password + 'bar'))))`" }, "bindInput": { "tsType": "() => void", "description": "键盘输入时触发，event.detail = {value, cursor, keyCode}，keyCode 为键值，2.1.0 起支持，处理函数可以直接 return 一个字符串，将替换输入框的内容。" }, "bindFocus": { "tsType": "() => void", "description": "输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度，在基础库 1.9.90 起支持" }, "bindBlur": { "tsType": "() => void", "description": "输入框失去焦点时触发，event.detail = { value, encryptedValue, encryptError }" }, "bindConfirm": { "tsType": "() => void", "description": "点击完成按钮时触发，event.detail = { value }" }, "bindKeyboardHeightChange": { "tsType": "() => void", "description": "键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration}" }, "bindNickNameReview": { "tsType": "() => void", "description": "用户昵称审核完毕后触发，仅在 type 为 \"nickname\" 时有效，event.detail = { pass, timeout }" } }, "additionalProperties": false, "required": [ "value", "placeholder", "placeholder-style", "cursor", "bindinput", "bindfocus", "bindblur", "bindconfirm", "bindkeyboardheightchange", "bindnicknamereview", "placeholder-style" ] } }, { "key": "label", "value": { "title": "label", "type": "object", "properties": { "for": { "type": "string", "description": "绑定控件的 id" } }, "additionalProperties": false } }, { "key": "live-player", "value": { "title": "live-player", "type": "object", "properties": { "src": { "type": "string", "description": "音视频地址。目前仅支持 flv, rtmp 格式" }, "mode": { "type": "string", "description": "模式", "defaultValue": "live", "enum": [ "live", "RTC" ] }, "autoplay": { "type": "boolean", "description": "自动播放", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音", "defaultValue": false }, "orientation": { "type": "string", "description": "画面方向", "defaultValue": "vertical", "enum": [ "vertical", "horizontal" ] }, "object-fit": { "type": "string", "description": "填充模式，可选值有 contain，fillCrop", "defaultValue": "contain", "enum": [ "contain", "fillCrop" ] }, "background-mute": { "type": "boolean", "description": "进入后台时是否静音（已废弃，默认退后台静音）", "defaultValue": false }, "min-cache": { "type": "number", "description": "最小缓冲区，单位s（RTC 模式推荐 0.2s）", "defaultValue": 1 }, "max-cache": { "type": "number", "description": "最大缓冲区，单位s（RTC 模式推荐 0.8s）。缓冲区用来抵抗网络波动，缓冲数据越多，网络抗性越好，但时延越大。", "defaultValue": 3 }, "sound-mode": { "type": "string", "description": "声音输出方式", "defaultValue": "speaker", "enum": [ "speaker", "ear" ] }, "auto-pause-if-navigate": { "type": "boolean", "description": "当跳转到本小程序的其他页面时，是否自动暂停本页面的实时音视频播放", "defaultValue": true }, "auto-pause-if-open-native": { "type": "boolean", "description": "当跳转到其它微信原生页面时，是否自动暂停本页面的实时音视频播放", "defaultValue": true }, "picture-in-picture-mode": { "type": [ "string", "any[]" ], "description": "设置小窗模式： push, pop，空字符串或通过数组形式设置多种模式（如： [\"push\", \"pop\"]）", "enum": [ "[]", "push", "pop" ] }, "enable-auto-rotation": { "type": "boolean", "description": "是否开启手机横屏时自动全屏，当系统设置开启自动旋转时生效", "defaultValue": false }, "referrer-policy": { "type": "string", "description": "格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；", "defaultValue": "no-referrer", "enum": [ "origin", "no-referrer" ] }, "enable-casting": { "type": "boolean", "description": "是否支持投屏。开启后，可以通过 LivePlayerContext 上相关方法进行操作。", "defaultValue": false }, "bindStateChange": { "tsType": "() => void", "description": "播放状态变化事件，detail = {code}" }, "bindFullScreenChange": { "tsType": "() => void", "description": "全屏变化事件，detail = {direction, fullScreen}" }, "bindNetStatus": { "tsType": "() => void", "description": "网络状态通知，detail = {info}" }, "bindAudioVolumeNotify": { "tsType": "() => void", "description": "播放音量大小通知，detail = {}" }, "bindEnterPictureInPicture": { "tsType": "() => void", "description": "播放器进入小窗" }, "bindLeavePictureInPicture": { "tsType": "() => void", "description": "播放器退出小窗" }, "bindCastingUserSelect": { "tsType": "() => void", "description": "用户选择投屏设备时触发 detail = { state: \"success\"/\"fail\" }" }, "bindCastingStateChange": { "tsType": "() => void", "description": "投屏成功/失败时触发 detail = { type, state: \"success\"/\"fail\" }" }, "bindCastingInterrupt": { "tsType": "() => void", "description": "投屏被中断时触发" } }, "additionalProperties": false } }, { "key": "live-pusher", "value": { "title": "live-pusher", "type": "object", "properties": { "url": { "type": "string", "description": "推流地址。目前仅支持 rtmp 格式" }, "mode": { "type": "string", "description": "SD（标清）, HD（高清）, FHD（超清）, RTC（实时通话）", "defaultValue": "RTC" }, "autopush": { "type": "boolean", "description": "自动推流", "defaultValue": false }, "enableVideoCustomRender": { "type": "boolean", "description": "自定义渲染，允许开发者自行处理所采集的视频帧，详见LivePusherContext", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音。即将废弃，可用 enable-mic 替代", "defaultValue": false }, "enable-camera": { "type": "boolean", "description": "开启摄像头", "defaultValue": true }, "auto-focus": { "type": "boolean", "description": "自动聚集", "defaultValue": true }, "orientation": { "type": "string", "description": "画面方向", "defaultValue": "vertical", "enum": [ "vertical", "horizontal" ] }, "beauty": { "type": "number", "description": "美颜，取值范围 0-9 ，0 表示关闭", "defaultValue": 0 }, "whiteness": { "type": "number", "description": "美白，取值范围 0-9 ，0 表示关闭", "defaultValue": 0 }, "aspect": { "type": "string", "description": "宽高比，可选值有 3:4, 9:16", "defaultValue": "9:16" }, "min-bitrate": { "type": "number", "description": "最小码率", "defaultValue": 200 }, "max-bitrate": { "type": "number", "description": "最大码率", "defaultValue": 1000 }, "audio-quality": { "type": "string", "description": "高音质(48KHz)或低音质(16KHz)，值为high, low", "defaultValue": "high" }, "waiting-image": { "type": "string", "description": "进入后台时推流的等待画面" }, "waiting-image-hash": { "type": "string", "description": "等待画面资源的MD5值" }, "zoom": { "type": "boolean", "description": "调整焦距", "defaultValue": false }, "device-position": { "type": "string", "description": "前置或后置，值为front, back", "defaultValue": "front" }, "background-mute": { "type": "boolean", "description": "进入后台时是否静音（已废弃，默认退后台静音）", "defaultValue": false }, "mirror": { "type": "boolean", "description": "设置推流画面是否镜像，产生的效果在 live-player 反应到", "defaultValue": false }, "remote-mirror": { "type": "boolean", "description": "同 mirror 属性，后续 mirror 将废弃", "defaultValue": false }, "local-mirror": { "type": "string", "description": "控制本地预览画面是否镜像", "defaultValue": "auto", "enum": [ "auto", "enable", "disable" ] }, "audio-reverb-type": { "type": "number", "description": "音频混响类型", "defaultValue": 0, "enum": [ "0", "1", "2", "3", "4", "5", "6", "7" ] }, "enable-mic": { "type": "boolean", "description": "开启或关闭麦克风", "defaultValue": true }, "enable-agc": { "type": "boolean", "description": "是否开启音频自动增益", "defaultValue": false }, "enable-ans": { "type": "boolean", "description": "是否开启音频噪声抑制", "defaultValue": false }, "audio-volume-type": { "type": "string", "description": "音量类型", "defaultValue": "auto", "enum": [ "auto", "media", "voicecall" ] }, "video-width": { "type": "number", "description": "上推的视频流的分辨率宽度", "defaultValue": 360 }, "video-height": { "type": "number", "description": "上推的视频流的分辨率高度", "defaultValue": 640 }, "beauty-style": { "type": "string", "description": "设置美颜类型", "defaultValue": "smooth", "enum": [ "smooth", "nature" ] }, "filter": { "type": "string", "description": "设置色彩滤镜", "defaultValue": "standard", "enum": [ "standard", "pink", "nostalgia", "blues", "romantic", "cool", "fresher", "solor", "aestheticism", "whitening", "cerisered" ] }, "picture-in-picture-mode": { "type": [ "string", "any[]" ], "description": "设置小窗模式： push, pop，空字符串或通过数组形式设置多种模式（如： [\"push\", \"pop\"]）", "enum": [ "[]", "push", "pop" ] }, "voice-changer-type": { "type": "number", "description": "0：关闭变声；1：熊孩子；2：萝莉；3：大叔；4：重金属；6：外国人；7：困兽；8：死肥仔；9：强电流；10：重机械；11：空灵", "defaultValue": 0, "enum": [ 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11 ] }, "custom-effect": { "type": "boolean", "description": "是否启动自定义特效，设定后不能更改", "defaultValue": false }, "skin-whiteness": { "type": "number", "description": "自定义特效美白效果，取值 0~1。需要开启 custom-effect", "defaultValue": 0 }, "skin-smoothness": { "type": "number", "description": "自定义特效磨皮效果，取值 0~1。需要开启 custom-effect", "defaultValue": 0 }, "face-thinness": { "type": "number", "description": "自定义特效瘦脸效果，取值 0~1。需要开启 custom-effect", "defaultValue": 0 }, "eye-bigness": { "type": "number", "description": "自定义特效大眼效果，取值 0~1。需要开启 custom-effect", "defaultValue": 0 }, "fps": { "type": "number", "description": "帧率，有效值为 1~30", "defaultValue": 15 }, "bindStateChange": { "tsType": "() => void", "description": "状态变化事件，detail = {code}" }, "bindNetStatus": { "tsType": "() => void", "description": "网络状态通知，detail = {info}" }, "bindError": { "tsType": "() => void", "description": "渲染错误事件，detail = {errMsg, errCode}" }, "bindBgmStart": { "tsType": "() => void", "description": "背景音开始播放时触发" }, "bindBgmProgress": { "tsType": "() => void", "description": "背景音进度变化时触发，detail = {progress, duration}" }, "bindBgmComplete": { "tsType": "() => void", "description": "背景音播放完成时触发" }, "bindAudioVolumeNotify": { "tsType": "() => void", "description": "返回麦克风采集的音量大小" }, "bindEnterPictureInPicture": { "tsType": "() => void", "description": "进入小窗" }, "bindLeavePictureInPicture": { "tsType": "() => void", "description": "退出小窗" } }, "additionalProperties": false } }, { "key": "map", "value": { "title": "map", "type": "object", "properties": { "longitude": { "type": "number", "description": "中心经度" }, "latitude": { "type": "number", "description": "中心纬度" }, "scale": { "type": "number", "description": "缩放级别，取值范围为3-20", "defaultValue": 16 }, "min-scale": { "type": "number", "description": "最小缩放级别", "defaultValue": 3 }, "max-scale": { "type": "number", "description": "最大缩放级别", "defaultValue": 20 }, "markers": { "type": "array.", "description": "标记点" }, "covers": { "type": "array.", "description": "即将移除，请使用 markers" }, "polyline": { "type": "array.", "description": "路线" }, "circles": { "type": "array.", "description": "圆" }, "controls": { "type": "array.", "description": "控件（即将废弃，建议使用 cover-view 代替）" }, "include-points": { "type": "array.", "description": "缩放视野以包含所有给定的坐标点" }, "show-location": { "type": "boolean", "description": "显示带有方向的当前定位点", "defaultValue": false }, "polygons": { "type": "array.", "description": "多边形" }, "subkey": { "type": "string", "description": "个性化地图使用的key" }, "layer-style": { "type": "number", "description": "个性化地图配置的 style，不支持动态修改", "defaultValue": 1 }, "rotate": { "type": "number", "description": "旋转角度，范围 0 ~ 360, 地图正北和设备 y 轴角度的夹角", "defaultValue": 0 }, "skew": { "type": "number", "description": "倾斜角度，范围 0 ~ 40 , 关于 z 轴的倾角", "defaultValue": 0 }, "enable-3D": { "type": "boolean", "description": "展示3D楼块", "defaultValue": false }, "show-compass": { "type": "boolean", "description": "显示指南针", "defaultValue": false }, "show-scale": { "type": "boolean", "description": "显示比例尺，工具暂不支持", "defaultValue": false }, "enable-overlooking": { "type": "boolean", "description": "开启俯视", "defaultValue": false }, "enable-auto-max-overlooking": { "type": "boolean", "description": "开启最大俯视角，俯视角度从 45 度拓展到 75 度", "defaultValue": false }, "enable-zoom": { "type": "boolean", "description": "是否支持缩放", "defaultValue": true }, "enable-scroll": { "type": "boolean", "description": "是否支持拖动", "defaultValue": true }, "enable-rotate": { "type": "boolean", "description": "是否支持旋转", "defaultValue": false }, "enable-satellite": { "type": "boolean", "description": "是否开启卫星图", "defaultValue": false }, "enable-traffic": { "type": "boolean", "description": "是否开启实时路况", "defaultValue": false }, "enable-poi": { "type": "boolean", "description": "是否展示 POI 点", "defaultValue": true }, "enable-building": { "type": "boolean", "description": "是否展示建筑物" }, "setting": { "type": "object", "description": "配置项" }, "bindTap": { "tsType": "() => void", "description": "点击地图时触发，2.9.0起返回经纬度信息" }, "bindMarkerTap": { "tsType": "() => void", "description": "点击标记点时触发，e.detail = {markerId}" }, "bindLabelTap": { "tsType": "() => void", "description": "点击label时触发，e.detail = {markerId}" }, "bindControlTap": { "tsType": "() => void", "description": "点击控件时触发，e.detail = {controlId}" }, "bindCallOutTap": { "tsType": "() => void", "description": "点击标记点对应的气泡时触发e.detail = {markerId}" }, "bindUpdated": { "tsType": "() => void", "description": "在地图渲染更新完成时触发" }, "bindRegionChange": { "tsType": "() => void", "description": "视野发生变化时触发，" }, "bindPoiTap": { "tsType": "() => void", "description": "点击地图poi点时触发，e.detail = {name, longitude, latitude}" }, "bindAnchorPointTap": { "tsType": "() => void", "description": "点击定位标时触发，e.detail = {longitude, latitude}" } }, "additionalProperties": false, "required": [ "longitude", "latitude" ] } }, { "key": "match-media", "value": { "title": "match-media", "type": "object", "properties": { "min-width": { "type": "number", "description": "页面最小宽度（ px 为单位）" }, "max-width": { "type": "number", "description": "页面最大宽度（ px 为单位）" }, "width": { "type": "number", "description": "页面宽度（ px 为单位）" }, "min-height": { "type": "number", "description": "页面最小高度（ px 为单位）" }, "max-height": { "type": "number", "description": "页面最大高度（ px 为单位）" }, "height": { "type": "number", "description": "页面高度（ px 为单位）" }, "orientation": { "type": "string", "description": "屏幕方向（ landscape 或 portrait ）" } }, "additionalProperties": false } }, { "key": "movable-area", "value": { "title": "movable-area", "type": "object", "properties": { "scale-area": { "type": "boolean", "description": "当里面的movable-view设置为支持双指缩放时，设置此值可将缩放手势生效区域修改为整个movable-area", "defaultValue": false } }, "additionalProperties": false } }, { "key": "movable-view", "value": { "title": "movable-view", "type": "object", "properties": { "direction": { "type": "string", "description": "movable-view的移动方向，属性值有all、vertical、horizontal、none", "defaultValue": "none" }, "inertia": { "type": "boolean", "description": "movable-view是否带有惯性", "defaultValue": false }, "out-of-bounds": { "type": "boolean", "description": "超过可移动区域后，movable-view是否还可以移动", "defaultValue": false }, "x": { "type": [ "number", "string" ], "description": "定义x轴方向的偏移，如果x的值不在可移动范围内，会自动移动到可移动范围；改变x的值会触发动画；单位支持px（默认）、rpx；" }, "y": { "type": [ "number", "string" ], "description": "定义y轴方向的偏移，如果y的值不在可移动范围内，会自动移动到可移动范围；改变y的值会触发动画；单位支持px（默认）、rpx；" }, "damping": { "type": "number", "description": "阻尼系数，用于控制x或y改变时的动画和过界回弹的动画，值越大移动越快", "defaultValue": 20 }, "friction": { "type": "number", "description": "摩擦系数，用于控制惯性滑动的动画，值越大摩擦力越大，滑动越快停止；必须大于0，否则会被设置成默认值", "defaultValue": 2 }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "scale": { "type": "boolean", "description": "是否支持双指缩放，默认缩放手势生效区域是在movable-view内", "defaultValue": false }, "scale-min": { "type": "number", "description": "定义缩放倍数最小值", "defaultValue": 0.1 }, "scale-max": { "type": "number", "description": "定义缩放倍数最大值", "defaultValue": 10 }, "scale-value": { "type": "number", "description": "定义缩放倍数，取值范围为 0.1 - 10", "defaultValue": 1 }, "animation": { "type": "boolean", "description": "是否使用动画", "defaultValue": true }, "bindChange": { "tsType": "() => void", "description": "拖动过程中触发的事件，event.detail = {x, y, source}" }, "bindScale": { "tsType": "() => void", "description": "缩放过程中触发的事件，event.detail = {x, y, scale}，x和y字段在2.1.0之后支持" }, "bindHTouchMove": { "tsType": "() => void", "description": "初次手指触摸后移动为横向的移动时触发，如果catch此事件，则意味着touchmove事件也被catch" }, "bindVTouchMove": { "tsType": "() => void", "description": "初次手指触摸后移动为纵向的移动时触发，如果catch此事件，则意味着touchmove事件也被catch" } }, "additionalProperties": false } }, { "key": "navigation-bar", "value": { "title": "navigation-bar", "type": "object", "properties": { "title": { "type": "string", "description": "导航条标题" }, "loading": { "type": "boolean", "description": "是否在导航条显示 loading 加载提示", "defaultValue": false }, "front-color": { "type": "string", "description": "导航条前景颜色值，包括按钮、标题、状态栏的颜色，仅支持 #ffffff 和 #000000" }, "background-color": { "type": "string", "description": "导航条背景颜色值，有效值为十六进制颜色" }, "color-animation-duration": { "type": "number", "description": "改变导航栏颜色时的动画时长，默认为 0 （即没有动画效果）", "defaultValue": 0 }, "color-animation-timing-func": { "type": "string", "description": "改变导航栏颜色时的动画方式，支持 linear 、 easeIn 、 easeOut 和 easeInOut", "defaultValue": "\"linear\"" } }, "additionalProperties": false } }, { "key": "navigator", "value": { "title": "navigator", "type": "object", "properties": { "target": { "type": "string", "description": "在哪个目标上发生跳转，默认当前小程序", "defaultValue": "self", "enum": [ "self", "miniProgram" ] }, "url": { "type": "string", "description": "当前小程序内的跳转链接" }, "open-type": { "type": "string", "description": "跳转方式", "defaultValue": "navigate", "enum": [ "navigate", "redirect", "switchTab", "reLaunch", "navigateBack", "exit" ] }, "delta": { "type": "number", "description": "当 open-type 为 'navigateBack' 时有效，表示回退的层数", "defaultValue": 1 }, "app-id": { "type": "string", "description": "当`target=\"miniProgram\"`且`open-type=\"navigate\"`时有效，要打开的小程序 appId" }, "path": { "type": "string", "description": "当`target=\"miniProgram\"`且`open-type=\"navigate\"`时有效，打开的页面路径，如果为空则打开首页" }, "extra-data": { "type": "object", "description": "当`target=\"miniProgram\"`且`open-type=\"navigate/navigateBack\"`时有效，需要传递给目标小程序的数据，目标小程序可在 `App.onLaunch()`，`App.onShow()` 中获取到这份数据。详情" }, "version": { "type": "string", "description": "当`target=\"miniProgram\"`且`open-type=\"navigate\"`时有效，要打开的小程序版本", "defaultValue": "release", "enum": [ "develop", "trial", "release" ] }, "short-link": { "type": "string", "description": "当`target=\"miniProgram\"`时有效，当传递该参数后，可以不传 app-id 和 path。链接可以通过【小程序菜单】->【复制链接】获取。" }, "hover-class": { "type": "string", "description": "指定点击时的样式类，当`hover-class=\"none\"`时，没有点击态效果", "defaultValue": "navigator-hover" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒", "defaultValue": 50 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒", "defaultValue": 600 }, "bindSuccess": { "type": "string", "description": "当`target=\"miniProgram\"`且`open-type=\"navigate/navigateBack\"`时有效时有效，跳转小程序成功" }, "bindFail": { "type": "string", "description": "当`target=\"miniProgram\"`且`open-type=\"navigate/navigateBack\"`时有效时有效，跳转小程序失败" }, "bindComplete": { "type": "string", "description": "当`target=\"miniProgram\"`且`open-type=\"navigate/navigateBack\"`时有效时有效，跳转小程序完成" } }, "additionalProperties": false } }, { "key": "official-account", "value": { "title": "official-account", "type": "object", "properties": { "bindLoad": { "tsType": "() => void", "defaultValue": "组件加载成功时触发" }, "bindError": { "tsType": "() => void", "defaultValue": "组件加载失败时触发" } }, "additionalProperties": false } }, { "key": "open-data", "value": { "title": "open-data", "type": "object", "properties": { "type": { "type": "string", "description": "开放数据类型", "enum": [ "groupName", "userNickName", "userAvatarUrl", "userGender", "userCity", "userProvince", "userCountry", "userLanguage" ] }, "open-gid": { "type": "string", "description": "当 type=\"groupName\" 时生效, 群id" }, "lang": { "type": "string", "description": "当 type=\"user*\" 时生效，以哪种语言展示 userInfo", "defaultValue": "en", "enum": [ "en", "zh_CN", "zh_TW" ] }, "default-text": { "type": "string", "description": "数据为空时的默认文案" }, "default-avatar": { "type": "string", "description": "用户头像为空时的默认图片，支持相对路径和网络图片路径" }, "bindError": { "tsType": "() => void", "description": "群名称或用户信息为空时触发" } }, "additionalProperties": false } }, { "key": "page-container", "value": { "title": "page-container", "type": "object", "properties": { "show": { "type": "boolean", "description": "是否显示容器组件", "defaultValue": false }, "duration": { "type": "number", "description": "动画时长，单位毫秒", "defaultValue": 300 }, "z-index": { "type": "number", "description": "z-index 层级", "defaultValue": 100 }, "overlay": { "type": "boolean", "description": "是否显示遮罩层", "defaultValue": true }, "position": { "type": "string", "description": "弹出位置，可选值为 top bottom right center", "defaultValue": "bottom" }, "round": { "type": "boolean", "description": "是否显示圆角", "defaultValue": false }, "close-on-slide-down": { "type": "boolean", "description": "是否在下滑一段距离后关闭", "defaultValue": false }, "overlay-style": { "type": "string", "description": "自定义遮罩层样式" }, "custom-style": { "type": "string", "description": "自定义弹出层样式" }, "bindBeforeEnter": { "tsType": "() => void", "description": "进入前触发" }, "bindEnter": { "tsType": "() => void", "description": "进入中触发" }, "bindAfterEnter": { "tsType": "() => void", "description": "进入后触发" }, "bindBeforeLeave": { "tsType": "() => void", "description": "离开前触发" }, "bindLeave": { "tsType": "() => void", "description": "离开中触发" }, "bindAfterLeave": { "tsType": "() => void", "description": "离开后触发" }, "bindClickOverlay": { "tsType": "() => void", "description": "点击遮罩层时触发" } }, "additionalProperties": false } }, { "key": "page-meta", "value": { "title": "page-meta", "type": "object", "properties": { "background-text-style": { "type": "string", "description": "下拉背景字体、loading 图的样式，仅支持 dark 和 light" }, "background-color": { "type": "string", "description": "窗口的背景色，必须为十六进制颜色值" }, "background-color-top": { "type": "string", "description": "顶部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持" }, "background-color-bottom": { "type": "string", "description": "底部窗口的背景色，必须为十六进制颜色值，仅 iOS 支持" }, "root-background-color": { "type": "string", "description": "页面内容的背景色，用于页面中的空白部分和页面大小变化 resize 动画期间\b的临时空闲区域" }, "scroll-top": { "type": "string", "description": "滚动位置，可以使用 px 或者 rpx 为单位，在被设置时，页面会滚动到对应位置" }, "scroll-duration": { "type": "number", "description": "滚动动画时长", "defaultValue": "300" }, "page-style": { "type": "string", "description": "页面根节点样式，页面根节点是所有页面节点的祖先节点，相当于 HTML 中的 body 节点" }, "page-font-size": { "type": "string", "description": "页面 page 的字体大小，可以设置为 system ，表示使用当前用户设置的微信字体大小" }, "root-font-size": { "type": "string", "description": "页面的根字体大小，页面中的所有 rem 单位，将使用这个字体大小作为参考值，即 1rem 等于这个字体大小；自小程序版本 2.11.0 起，也可以设置为 system" }, "page-orientation": { "type": "string", "description": "页面的方向，可为 auto portrait 或 landscape" }, "bindResize": { "tsType": "() => void", "description": "页面尺寸变化时会触发 resize 事件， event.detail = { size: { windowWidth, windowHeight } }" }, "bindScroll": { "tsType": "() => void", "description": "页面滚动时会触发 scroll 事件， event.detail = { scrollTop }" }, "bindScrollDone": { "tsType": "() => void", "description": "如果通过改变 scroll-top 属性来使页面滚动，页面滚动结束后会触发 scrolldone 事件" } }, "additionalProperties": false } }, { "key": "picker-view", "value": { "title": "picker-view", "type": "object", "properties": { "value": { "type": "array.", "description": "数组中的数字依次表示 picker-view 内的 picker-view-column 选择的第几项（下标从 0 开始），数字大于 picker-view-column 可选项长度时，选择最后一项。" }, "indicator-style": { "type": "string", "description": "设置选择器中间选中框的样式" }, "indicator-class": { "type": "string", "description": "设置选择器中间选中框的类名" }, "mask-style": { "type": "string", "description": "设置蒙层的样式" }, "mask-class": { "type": "string", "description": "设置蒙层的类名" }, "immediate-change": { "type": "boolean", "description": "是否在手指松开时立即触发 change 事件。若不开启则会在滚动动画结束后触发 change 事件。", "defaultValue": false }, "bindChange": { "tsType": "() => void", "description": "滚动选择时触发change事件，event.detail = {value}；value为数组，表示 picker-view 内的 picker-view-column 当前选择的是第几项（下标从 0 开始）" }, "bindPickStart": { "tsType": "() => void", "description": "当滚动选择开始时候触发事件" }, "bindPickEnd": { "tsType": "() => void", "description": "当滚动选择结束时候触发事件" } }, "additionalProperties": false } }, { "key": "picker", "value": { "title": "picker", "type": "object", "properties": { "header-text": { "type": "string", "description": "选择器的标题，仅安卓可用" }, "mode": { "type": "string", "description": "选择器类型", "defaultValue": "selector", "enum": [ "selector", "multiSelector", "time", "date", "region" ] }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "bindCancel": { "tsType": "() => void", "description": "取消选择时触发" } }, "additionalProperties": false } }, { "key": "progress", "value": { "title": "progress", "type": "object", "properties": { "percent": { "type": "number", "description": "百分比0~100" }, "show-info": { "type": "boolean", "description": "在进度条右侧显示百分比", "defaultValue": false }, "border-radius": { "type": [ "number", "string" ], "description": "圆角大小", "defaultValue": "0" }, "font-size": { "type": [ "number", "string" ], "description": "右侧百分比字体大小", "defaultValue": "16" }, "stroke-width": { "type": [ "number", "string" ], "description": "进度条线的宽度", "defaultValue": "6" }, "color": { "type": "string", "description": "进度条颜色（请使用activeColor）", "defaultValue": "#09BB07" }, "activeColor": { "type": "string", "description": "已选择的进度条的颜色", "defaultValue": "#09BB07" }, "backgroundColor": { "type": "string", "description": "未选择的进度条的颜色", "defaultValue": "#EBEBEB" }, "active": { "type": "boolean", "description": "进度条从左往右的动画", "defaultValue": false }, "active-mode": { "type": "string", "description": "backwards: 动画从头播；forwards：动画从上次结束点接着播", "defaultValue": "backwards" }, "duration": { "type": "number", "description": "进度增加1%所需毫秒数", "defaultValue": 30 }, "bindActiveEnd": { "tsType": "() => void", "description": "动画完成事件" } }, "additionalProperties": false } }, { "key": "radio-group", "value": { "title": "radio-group", "type": "object", "properties": { "bindChange": { "tsType": "() => void", "description": "radio-group中选中项发生改变时触发 change 事件，detail = {value:[选中的radio的value的数组]}" } }, "additionalProperties": false } }, { "key": "radio", "value": { "title": "radio", "type": "object", "properties": { "value": { "type": "string", "description": "radio 标识。当该radio 选中时，radio-group 的 change 事件会携带radio的value" }, "checked": { "type": "boolean", "description": "当前是否选中", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "color": { "type": "string", "description": "radio的颜色，同css的color", "defaultValue": "#09BB07" } }, "additionalProperties": false } }, { "key": "rich-text", "value": { "title": "rich-text", "type": "object", "properties": { "nodes": { "type": [ "array", "string" ], "description": "节点列表/HTML String", "defaultValue": "[]" }, "space": { "type": "string", "description": "显示连续空格", "enum": [ "ensp", "emsp", "nbsp" ] }, "user-select": { "type": "boolean", "description": "文本是否可选，该属性会使节点显示为 block", "defaultValue": false } }, "additionalProperties": false } }, { "key": "root-portal", "value": { "title": "root-portal", "type": "object", "properties": { "enable": { "type": "boolean", "description": "是否从页面中脱离出来", "defaultValue": true } }, "additionalProperties": false } }, { "key": "scroll-view", "value": { "title": "scroll-view", "type": "object", "properties": { "scroll-x": { "type": "boolean", "description": "允许横向滚动", "defaultValue": false }, "scroll-y": { "type": "boolean", "description": "允许纵向滚动", "defaultValue": false }, "upper-threshold": { "type": [ "number", "string" ], "description": "距顶部/左边多远时，触发 scrolltoupper 事件", "defaultValue": "50" }, "lower-threshold": { "type": [ "number", "string" ], "description": "距底部/右边多远时，触发 scrolltolower 事件", "defaultValue": "50" }, "scroll-top": { "type": [ "number", "string" ], "description": "设置竖向滚动条位置" }, "scroll-left": { "type": [ "number", "string" ], "description": "设置横向滚动条位置" }, "scroll-into-view": { "type": "string", "description": "值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素" }, "scroll-with-animation": { "type": "boolean", "description": "在设置滚动条位置时使用动画过渡", "defaultValue": false }, "enable-back-to-top": { "type": "boolean", "description": "暂未支持", "defaultValue": false }, "enable-flex": { "type": "boolean", "description": "不支持，默认 flex", "defaultValue": false }, "scroll-anchoring": { "type": "boolean", "description": "暂未支持", "defaultValue": false }, "enable-passive": { "type": "boolean", "description": "开启 passive 特性，能优化一定的滚动性能", "defaultValue": false }, "refresher-enabled": { "type": "boolean", "description": "开启自定义下拉刷新", "defaultValue": false }, "refresher-threshold": { "type": "number", "description": "设置自定义下拉刷新阈值", "defaultValue": 45 }, "refresher-default-style": { "type": "string", "description": "设置自定义下拉刷新默认样式，支持设置 `black | white | none`， none 表示不使用默认样式", "defaultValue": "\"black\"" }, "refresher-background": { "type": "string", "description": "设置自定义下拉刷新区域背景颜色", "defaultValue": "\"#FFF\"" }, "refresher-triggered": { "type": "boolean", "description": "设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发", "defaultValue": false }, "enhanced": { "type": "boolean", "description": "不支持，默认开启", "defaultValue": false }, "bounces": { "type": "boolean", "description": "iOS 下 scroll-view 边界弹性控制 (同时开启 enhanced 属性后生效)", "defaultValue": true }, "show-scrollbar": { "type": "boolean", "description": "滚动条显隐控制 (同时开启 enhanced 属性后生效)", "defaultValue": true }, "paging-enabled": { "type": "boolean", "description": "不支持，可用 Skyline 手势系统实现", "defaultValue": false }, "fast-deceleration": { "type": "boolean", "description": "滑动减速速率控制, 仅在 iOS 下生效 (同时开启 enhanced 属性后生效)", "defaultValue": false }, "type": { "type": "string", "description": "渲染模式", "defaultValue": "list", "enum": [ "list", "custom" ] }, "reverse": { "type": "boolean", "description": "是否反向滚动。一般初始滚动位置是在顶部，反向滚动则是在底部。", "defaultValue": false }, "cache-extent": { "type": "number", "description": "指定视口外渲染区域的距离，默认情况下视口外节点不渲染。指定 cache-extent 可优化滚动体验和加载速度，但会提高内存占用且影响首屏速度，可按需启用。" }, "scroll-into-view-within-extent": { "type": "boolean", "description": "只 scroll-into-view 到 cacheExtent 以内的目标节点，性能更佳", "defaultValue": false }, "scroll-into-view-alignment": { "type": "string", "description": "指定 scroll-into-view 目标节点在视口内的位置", "defaultValue": "start", "enum": [ "start", "center", "end", "nearest" ] }, "bindDragStart": { "tsType": "() => void", "description": "滑动开始事件 (同时开启 enhanced 属性后生效) detail { scrollTop, scrollLeft }" }, "bindDragging": { "tsType": "() => void", "description": "滑动事件 (同时开启 enhanced 属性后生效) detail { scrollTop, scrollLeft }" }, "bindDragEnd": { "tsType": "() => void", "description": "滑动结束事件 (同时开启 enhanced 属性后生效) detail { scrollTop, scrollLeft, velocity }" }, "bindScrollToUpper": { "tsType": "() => void", "description": "滚动到顶部/左边时触发" }, "bindScrollToLower": { "tsType": "() => void", "description": "滚动到底部/右边时触发" }, "bindScroll": { "tsType": "() => void", "description": "滚动事件，多返回 isDrag 字段。event.detail = { isDrag }" }, "bindRefresherPulling": { "tsType": "() => void", "description": "自定义下拉刷新控件被下拉" }, "bindRefresherRefresh": { "tsType": "() => void", "description": "自定义下拉刷新被触发" }, "bindRefresherRestore": { "tsType": "() => void", "description": "自定义下拉刷新被复位" }, "bindRefresherAbort": { "tsType": "() => void", "description": "自定义下拉刷新被中止" }, "bindScrollStart": { "tsType": "() => void", "description": "滚动开始事件。event.detail = { isDrag }" }, "bindScrollEnd": { "tsType": "() => void", "description": "滚动结束事件。event.detail = { isDrag }" }, "bindRefresherWillRefresh": { "tsType": "() => void", "description": "自定义下拉刷新即将触发刷新（拖动超过 refresher-threshold 时）的事件" } }, "additionalProperties": false, "required": [ "type" ] } }, { "key": "share-element", "value": { "title": "share-element", "type": "object", "properties": { "key": { "type": "string", "description": "映射标记，页面内唯一" }, "transform": { "type": "boolean", "description": "是否进行动画", "defaultValue": false }, "duration": { "type": "number", "description": "动画时长，单位毫秒", "defaultValue": 300 }, "easing-function": { "type": "string", "description": "`css`缓动函数", "defaultValue": "ease-out" }, "transition-on-gesture": { "type": "boolean", "description": "手势返回时是否进行动画", "defaultValue": false }, "shuttle-on-push": { "type": "string", "description": "指定 push 阶段的飞跃物", "defaultValue": "to", "enum": [ "from", "to", "from", "to" ] }, "shuttle-on-pop": { "type": "string", "description": "指定 pop 阶段的飞跃物", "defaultValue": "to" }, "on-frame": { "type": "function", "description": "动画帧回调" }, "rect-tween-type": { "type": "string", "description": "动画插值曲线", "defaultValue": "materialRectArc", "enum": [ "materialRectArc", "materialRectCenterArc", "linear", "elasticIn", "elasticOut", "elasticInOut", "bounceIn", "bounceOut", "bounceInOut", "cubic-bezier(x1, y1, x2, y2)" ] } }, "additionalProperties": false, "required": [ "key" ] } }, { "key": "slider", "value": { "title": "slider", "type": "object", "properties": { "min": { "type": "number", "description": "最小值", "defaultValue": 0 }, "max": { "type": "number", "description": "最大值", "defaultValue": 100 }, "step": { "type": "number", "description": "步长，取值必须大于 0，并且可被(max - min)整除", "defaultValue": 1 }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "value": { "type": "number", "description": "当前取值", "defaultValue": 0 }, "color": { "type": "string", "description": "背景条的颜色（请使用 backgroundColor）", "defaultValue": "#e9e9e9" }, "selected-color": { "type": "string", "description": "已选择的颜色（请使用 activeColor）", "defaultValue": "#1aad19" }, "activeColor": { "type": "string", "description": "已选择的颜色", "defaultValue": "#1aad19" }, "backgroundColor": { "type": "string", "description": "背景条的颜色", "defaultValue": "#e9e9e9" }, "block-size": { "type": "number", "description": "滑块的大小，取值范围为 12 - 28", "defaultValue": 28 }, "block-color": { "type": "string", "description": "滑块的颜色", "defaultValue": "#ffffff" }, "show-value": { "type": "boolean", "description": "是否显示当前 value", "defaultValue": false }, "bindChange": { "tsType": "() => void", "description": "完成一次拖动后触发的事件，event.detail = {value}" }, "bindChanging": { "tsType": "() => void", "description": "拖动过程中触发的事件，event.detail = {value}" } }, "additionalProperties": false } }, { "key": "sticky-section", "value": { "title": "sticky-section", "type": "object", "properties": { "push-pinned-header": { "type": "boolean", "description": "吸顶元素重叠时是否继续上推", "defaultValue": true } }, "additionalProperties": false } }, { "key": "swiper-item", "value": { "title": "swiper-item", "type": "object", "properties": { "item-id": { "type": "string", "description": "该 swiper-item 的标识符" }, "skip-hidden-item-layout": { "type": "boolean", "description": "是否跳过未显示的滑块布局，设为 true 可优化复杂情况下的滑动性能，但会丢失隐藏状态滑块的布局信息", "defaultValue": false } }, "additionalProperties": false } }, { "key": "swiper", "value": { "title": "swiper", "type": "object", "properties": { "indicator-dots": { "type": "boolean", "description": "是否显示面板指示点", "defaultValue": false }, "indicator-color": { "type": "string", "description": "指示点颜色", "defaultValue": "rgba(0, 0, 0, .3)" }, "indicator-active-color": { "type": "string", "description": "当前选中的指示点颜色", "defaultValue": "#000000" }, "autoplay": { "type": "boolean", "description": "是否自动切换", "defaultValue": false }, "current": { "type": "number", "description": "当前所在滑块的 index", "defaultValue": 0 }, "interval": { "type": "number", "description": "自动切换时间间隔", "defaultValue": 5000 }, "duration": { "type": "number", "description": "滑动动画时长", "defaultValue": 500 }, "circular": { "type": "boolean", "description": "是否采用衔接滑动", "defaultValue": false }, "vertical": { "type": "boolean", "description": "滑动方向是否为纵向", "defaultValue": false }, "previous-margin": { "type": "string", "description": "前边距，可用于露出前一项的一小部分，接受 px 和 rpx 值", "defaultValue": "\"0px\"" }, "next-margin": { "type": "string", "description": "后边距，可用于露出后一项的一小部分，接受 px 和 rpx 值", "defaultValue": "\"0px\"" }, "snap-to-edge": { "type": "boolean", "description": "当 swiper-item 的个数大于等于 2，关闭 circular 并且开启 previous-margin 或 next-margin 的时候，可以指定这个边距是否应用到第一个、最后一个元素", "defaultValue": false }, "display-multiple-items": { "type": "number", "description": "同时显示的滑块数量", "defaultValue": 1 }, "easing-function": { "type": "string", "description": "指定 swiper 切换缓动动画类型", "defaultValue": "\"default\"", "enum": [ "default", "linear", "easeInCubic", "easeOutCubic", "easeInOutCubic" ] }, "scroll-with-animation": { "type": "boolean", "description": "改变 current 时使用动画过渡", "defaultValue": true }, "cache-extent": { "type": "number", "description": "缓存区域大小，值为 1 表示提前渲染上下各一屏区域（swiper 容器大小）", "defaultValue": 0 }, "bindChange": { "tsType": "() => void", "description": "current 改变时会触发 change 事件，event.detail = {current, source}" }, "bindTransition": { "tsType": "() => void", "description": "swiper-item 的位置发生改变时会触发 transition 事件，event.detail = {dx: dx, dy: dy}" }, "bindAnimationFinish": { "tsType": "() => void", "description": "动画结束时会触发 animationfinish 事件，event.detail 同上" } }, "additionalProperties": false } }, { "key": "switch", "value": { "title": "switch", "type": "object", "properties": { "checked": { "type": "boolean", "description": "是否选中", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "type": { "type": "string", "description": "样式，有效值：switch, checkbox", "defaultValue": "switch" }, "color": { "type": "string", "description": "switch 的颜色，同 css 的 color", "defaultValue": "#04BE02" }, "bindChange": { "tsType": "() => void", "description": "点击导致 checked 改变时会触发 change 事件，event.detail={ value}" } }, "additionalProperties": false } }, { "key": "text", "value": { "title": "text", "type": "object", "properties": { "selectable": { "type": "boolean", "description": "文本是否可选 (已废弃)", "defaultValue": false }, "user-select": { "type": "boolean", "description": "文本是否可选，该属性会使文本节点显示为 inline-block", "defaultValue": false }, "space": { "type": "string", "description": "显示连续空格", "enum": [ "ensp", "emsp", "nbsp" ] }, "decode": { "type": "boolean", "description": "是否解码", "defaultValue": false }, "max-lines": { "type": "number", "description": "限制文本最大行数" } }, "additionalProperties": false, "required": [ "max-lines" ] } }, { "key": "textarea", "value": { "title": "textarea", "type": "object", "properties": { "value": { "type": "string", "description": "输入框的内容" }, "placeholder": { "type": "string", "description": "输入框为空时占位符" }, "placeholder-style": { "type": "string", "description": "指定 placeholder 的样式，目前仅支持color,font-size和font-weight" }, "placeholder-class": { "type": "string", "description": "指定 placeholder 的样式类", "defaultValue": "textarea-placeholder" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大输入长度，设置为 -1 的时候不限制最大长度", "defaultValue": 140 }, "auto-focus": { "type": "boolean", "description": "自动聚焦，拉起键盘。", "defaultValue": false }, "focus": { "type": "boolean", "description": "获取焦点", "defaultValue": false }, "auto-height": { "type": "boolean", "description": "是否自动增高，设置auto-height时，style.height不生效", "defaultValue": false }, "fixed": { "type": "boolean", "description": "如果 textarea 是在一个 `position:fixed` 的区域，需要显示指定属性 fixed 为 true", "defaultValue": false }, "cursor-spacing": { "type": "number", "description": "指定光标与键盘的距离。取`textarea`距离底部的距离和`cursor-spacing`指定的距离的最小值作为光标与键盘的距离", "defaultValue": 0 }, "cursor": { "type": "number", "description": "指定focus时的光标位置", "defaultValue": -1 }, "show-confirm-bar": { "type": "boolean", "description": "是否显示键盘上方带有”完成“按钮那一栏", "defaultValue": true }, "selection-start": { "type": "number", "description": "光标起始位置，自动聚集时有效，需与`selection-end`搭配使用", "defaultValue": -1 }, "selection-end": { "type": "number", "description": "光标结束位置，自动聚集时有效，需与`selection-start`搭配使用", "defaultValue": -1 }, "adjust-position": { "type": "boolean", "description": "键盘弹起时，是否自动上推页面", "defaultValue": true }, "hold-keyboard": { "type": "boolean", "description": "focus时，点击页面的时候不收起键盘", "defaultValue": false }, "disable-default-padding": { "type": "boolean", "description": "是否去掉 iOS 下的默认内边距", "defaultValue": false }, "confirm-type": { "type": "string", "description": "设置键盘右下角按钮的文字", "defaultValue": "return", "enum": [ "send", "search", "next", "go", "done", "return" ] }, "confirm-hold": { "type": "boolean", "description": "点击键盘右下角按钮时是否保持键盘不收起", "defaultValue": false }, "adjust-keyboard-to": { "type": "boolean", "description": "键盘对齐位置", "defaultValue": false, "enum": [ "cursor", "bottom" ] }, "bindFocus": { "tsType": "() => void", "description": "输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度，在基础库 1.9.90 起支持" }, "bindBlur": { "tsType": "() => void", "description": "输入框失去焦点时触发，event.detail = {value, cursor}" }, "bindLineChange": { "tsType": "() => void", "description": "输入框行数变化时调用，event.detail = {height: 0, heightRpx: 0, lineCount: 0}" }, "bindInput": { "tsType": "() => void", "description": "当键盘输入时，触发 input 事件，event.detail = {value, cursor, keyCode}，keyCode 为键值，目前工具还不支持返回keyCode参数。**bindinput 处理函数的返回值并不会反映到 textarea 上**" }, "bindConfirm": { "tsType": "() => void", "description": "点击完成时， 触发 confirm 事件，event.detail = {value: value}" }, "bindKeyboardHeightChange": { "tsType": "() => void", "description": "键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration}" } }, "additionalProperties": false } }, { "key": "video", "value": { "title": "video", "type": "object", "properties": { "src": { "type": "string", "description": "要播放视频的资源地址，支持网络路径、本地临时路径、云文件ID（2.3.0）" }, "duration": { "type": "number", "description": "指定视频时长" }, "controls": { "type": "boolean", "description": "是否显示默认播放控件（播放/暂停按钮、播放进度、时间）", "defaultValue": true }, "danmu-list": { "type": "array.", "description": "弹幕列表" }, "danmu-btn": { "type": "boolean", "description": "是否显示弹幕按钮，只在初始化时有效，不能动态变更", "defaultValue": false }, "enable-danmu": { "type": "boolean", "description": "是否展示弹幕，只在初始化时有效，不能动态变更", "defaultValue": false }, "autoplay": { "type": "boolean", "description": "是否自动播放", "defaultValue": false }, "loop": { "type": "boolean", "description": "是否循环播放", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音播放", "defaultValue": false }, "initial-time": { "type": "number", "description": "指定视频初始播放位置", "defaultValue": 0 }, "page-gesture": { "type": "boolean", "description": "在非全屏模式下，是否开启亮度与音量调节手势（废弃，见 vslide-gesture）", "defaultValue": false }, "direction": { "type": "number", "description": "设置全屏时视频的方向，不指定则根据宽高比自动判断", "enum": [ "0", "90", "-90" ] }, "show-progress": { "type": "boolean", "description": "若不设置，宽度大于240时才会显示", "defaultValue": true }, "show-fullscreen-btn": { "type": "boolean", "description": "是否显示全屏按钮", "defaultValue": true }, "show-play-btn": { "type": "boolean", "description": "是否显示视频底部控制栏的播放按钮", "defaultValue": true }, "show-center-play-btn": { "type": "boolean", "description": "是否显示视频中间的播放按钮", "defaultValue": true }, "enable-progress-gesture": { "type": "boolean", "description": "是否开启控制进度的手势", "defaultValue": true }, "object-fit": { "type": "string", "description": "当视频大小与 video 容器大小不一致时，视频的表现形式", "defaultValue": "contain", "enum": [ "contain", "fill", "cover" ] }, "poster": { "type": "string", "description": "视频封面的图片网络资源地址或云文件ID（2.3.0）。若 controls 属性值为 false 则设置 poster 无效" }, "show-mute-btn": { "type": "boolean", "description": "是否显示静音按钮", "defaultValue": false }, "title": { "type": "string", "description": "视频的标题，全屏时在顶部展示" }, "play-btn-position": { "type": "string", "description": "播放按钮的位置", "defaultValue": "bottom", "enum": [ "bottom", "center" ] }, "enable-play-gesture": { "type": "boolean", "description": "是否开启播放手势，即双击切换播放/暂停", "defaultValue": false }, "auto-pause-if-navigate": { "type": "boolean", "description": "当跳转到本小程序的其他页面时，是否自动暂停本页面的视频播放", "defaultValue": true }, "auto-pause-if-open-native": { "type": "boolean", "description": "当跳转到其它微信原生页面时，是否自动暂停本页面的视频", "defaultValue": true }, "vslide-gesture": { "type": "boolean", "description": "在非全屏模式下，是否开启亮度与音量调节手势（同 page-gesture）", "defaultValue": false }, "vslide-gesture-in-fullscreen": { "type": "boolean", "description": "在全屏模式下，是否开启亮度与音量调节手势", "defaultValue": true }, "show-bottom-progress": { "type": "boolean", "description": "是否展示底部进度条", "defaultValue": true }, "ad-unit-id": { "type": "string", "description": "视频前贴广告单元ID，更多详情可参考开放能力视频前贴广告" }, "poster-for-crawler": { "type": "string", "description": "用于给搜索等场景作为视频封面展示，建议使用无播放 icon 的视频封面图，只支持网络地址" }, "show-casting-button": { "type": "boolean", "description": "显示投屏按钮。安卓在同层渲染下生效，支持 DLNA 协议；iOS 支持 AirPlay 和 DLNA 协议。可以通过VideoContext的相关方法进行操作。", "defaultValue": false }, "picture-in-picture-mode": { "type": [ "string", "any[]" ], "description": "设置小窗模式： push, pop，空字符串或通过数组形式设置多种模式（如： [\"push\", \"pop\"]）", "enum": [ "[]", "push", "pop" ] }, "picture-in-picture-show-progress": { "type": "boolean", "description": "是否在小窗模式下显示播放进度", "defaultValue": false }, "enable-auto-rotation": { "type": "boolean", "description": "是否开启手机横屏时自动全屏，当系统设置开启自动旋转时生效", "defaultValue": false }, "show-screen-lock-button": { "type": "boolean", "description": "是否显示锁屏按钮，仅在全屏时显示，锁屏后控制栏的操作", "defaultValue": false }, "show-snapshot-button": { "type": "boolean", "description": "是否显示截屏按钮，仅在全屏时显示", "defaultValue": false }, "show-background-playback-button": { "type": "boolean", "description": "是否展示后台音频播放按钮", "defaultValue": false }, "background-poster": { "type": "string", "description": "进入后台音频播放后的通知栏图标（Android 独有）" }, "referrer-policy": { "type": "string", "description": "格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；", "defaultValue": "no-referrer", "enum": [ "origin", "no-referrer" ] }, "is-drm": { "type": "boolean", "description": "是否为 DRM 视频源" }, "is-live": { "type": "boolean", "description": "是否为直播源" }, "provision-url": { "type": "string", "description": "DRM 设备身份认证 url，仅 is-drm 为 true 时生效 (Android)" }, "certificate-url": { "type": "string", "description": "DRM 设备身份认证 url，仅 is-drm 为 true 时生效 (iOS)" }, "license-url": { "type": "string", "description": "DRM 获取加密信息 url，仅 is-drm 为 true 时生效" }, "preferred-peak-bit-rate": { "type": "number", "description": "指定码率上界，单位为比特每秒" }, "bindPlay": { "tsType": "() => void", "description": "当开始/继续播放时触发play事件" }, "bindPause": { "tsType": "() => void", "description": "当暂停播放时触发 pause 事件" }, "bindEnded": { "tsType": "() => void", "description": "当播放到末尾时触发 ended 事件" }, "bindTimeUpdate": { "tsType": "() => void", "description": "播放进度变化时触发，event.detail = {currentTime, duration} 。触发频率 250ms 一次" }, "bindFullScreenChange": { "tsType": "() => void", "description": "视频进入和退出全屏时触发，event.detail = {fullScreen, direction}，direction 有效值为 vertical 或 horizontal" }, "bindWaiting": { "tsType": "() => void", "description": "视频出现缓冲时触发" }, "bindError": { "tsType": "() => void", "description": "视频播放出错时触发" }, "bindProgress": { "tsType": "() => void", "description": "加载进度变化时触发，只支持一段加载。event.detail = {buffered}，百分比" }, "bindLoadedMetaData": { "tsType": "() => void", "description": "视频元数据加载完成时触发。event.detail = {width, height, duration}" }, "bindControlsToggle": { "tsType": "() => void", "description": "切换 controls 显示隐藏时触发。event.detail = {show}" }, "bindEnterPictureInPicture": { "tsType": "() => void", "description": "播放器进入小窗" }, "bindLeavePictureInPicture": { "tsType": "() => void", "description": "播放器退出小窗" }, "bindSeekComplete": { "tsType": "() => void", "description": "seek 完成时触发 (position iOS 单位 s, Android 单位 ms)" }, "bindCastingUserSelect": { "tsType": "() => void", "description": "用户选择投屏设备时触发 detail = { state: \"success\"/\"fail\" }" }, "bindCastingStateChange": { "tsType": "() => void", "description": "投屏成功/失败时触发 detail = { type, state: \"success\"/\"fail\" }" }, "bindCastingInterrupt": { "tsType": "() => void", "description": "投屏被中断时触发" } }, "additionalProperties": false, "required": [ "src", "ad-unit-id", "poster-for-crawler" ] } }, { "key": "view", "value": { "title": "view", "type": "object", "properties": { "hover-class": { "type": "string", "description": "指定按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果", "defaultValue": "none" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒", "defaultValue": 50 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒", "defaultValue": 400 } }, "additionalProperties": false } }, { "key": "voip-room", "value": { "title": "voip-room", "type": "object", "properties": { "mode": { "type": "string", "description": "对话窗口类型", "defaultValue": "camera", "enum": [ "camera", "video" ] }, "device-position": { "type": "string", "description": "摄像头方向，仅在 mode 为 camera 时有效", "defaultValue": "front", "enum": [ "front", "back" ] }, "object-fit": { "type": "string", "description": "画面与容器比例不一致时，画面的表现形式", "defaultValue": "fill", "enum": [ "fill", "contain", "cover" ] }, "openId": { "type": "string", "description": "进入房间用户的 openid" }, "bindError": { "tsType": "() => void", "description": "创建对话窗口失败时触发" } }, "additionalProperties": false, "required": [ "openid", "mode", "device-position", "object-fit" ] } }, { "key": "web-view", "value": { "title": "web-view", "type": "object", "properties": { "src": { "type": "string", "description": "webview 指向网页的链接。可打开关联的公众号的文章，其它网页需登录小程序管理后台配置业务域名。" }, "bindMessage": { "tsType": "() => void", "description": "网页向小程序 postMessage 时，会在以下特定时机触发并收到消息：小程序后退、组件销毁、分享、复制链接（2.31.1）。e.detail = { data }，data是多次 postMessage 的参数组成的数组。" }, "bindLoad": { "tsType": "() => void", "description": "网页加载成功时候触发此事件。e.detail = { src }" }, "bindError": { "tsType": "() => void", "description": "网页加载失败的时候触发此事件。e.detail = { url, fullUrl }，其中 fullUrl 为加载失败时的完整 url" } }, "additionalProperties": false } } ] }, { "key": "jd", "value": [ { "key": "button", "value": { "title": "button", "type": "object", "properties": { "size": { "type": "string", "description": "按钮的大小", "defaultValue": "default", "enum": [ "default", "mini" ] }, "type": { "type": "string", "description": "按钮的样式类型", "defaultValue": "default", "enum": [ "primary", "default", "warn" ] }, "plain": { "type": "boolean", "description": "按钮是否镂空，背景色透明", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "loading": { "type": "boolean", "description": "名称前是否带 loading 图标", "defaultValue": false }, "form-type": { "type": "string", "description": "用于 组件，点击分别会触发 组件的 submit/reset 事件", "enum": [ "submit", "reset" ] }, "open-type": { "type": "string", "description": "京东开放能力", "enum": [ "share", "getUserInfo", "getPhoneNumber", "launchApp", "openSetting" ] }, "hover-class": { "type": "string", "description": "指定按钮按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果", "defaultValue": "button-hover" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒", "defaultValue": 20 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒", "defaultValue": 70 }, "lang": { "type": "string", "description": "指定返回用户信息的语言，zh_CN 简体中文，zh_TW 繁体中文，en 英文。", "defaultValue": "en" }, "app-parameter": { "type": "string", "description": "打开 App 时，向 App 传递的参数" }, "bindGetUserInfo": { "tsType": "() => void", "description": "用户点击该按钮时，会返回获取到的用户信息，回调的detail数据与jd.getUserInfo返回的一致" }, "bindGetPhoneNumber": { "tsType": "() => void", "description": "获取用户手机号回调" }, "bindError": { "tsType": "() => void", "description": "当使用开放能力时，发生错误的回调" }, "bindOpenSetting": { "tsType": "() => void", "description": "在打开授权设置页后回调" } }, "additionalProperties": false } }, { "key": "camera", "value": { "title": "camera", "type": "object", "properties": { "mode": { "type": "string", "description": "否", "defaultValue": "normal", "enum": [ "normal" ] }, "device-position": { "type": "string", "description": "否", "defaultValue": "back", "enum": [ "front", "back" ] }, "flash": { "type": "string", "description": "否", "defaultValue": "auto", "enum": [ "auto", "on", "off" ] }, "bindStop": { "tsType": "() => void", "description": "否" }, "bindError": { "tsType": "() => void", "description": "否" } }, "additionalProperties": false } }, { "key": "canvas", "value": { "title": "canvas", "type": "object", "properties": { "canvas-id": { "type": "string", "description": "canvas 组件的唯一标识符" }, "disableScroll": { "type": "boolean", "description": "当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新", "defaultValue": false }, "bindTouchStart": { "tsType": "() => void", "description": "手指触摸动作开始" }, "bindTouchMove": { "tsType": "() => void", "description": "手指触摸后移动" }, "bindTouchEnd": { "tsType": "() => void", "description": "手指触摸动作结束" }, "bindTouchCancel": { "tsType": "() => void", "description": "手指触摸动作被打断，如来电提醒，弹窗" }, "bindLongTap": { "tsType": "() => void", "description": "手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动" }, "bindError": { "tsType": "() => void", "description": "当发生错误时触发 error 事件，detail = {errMsg}" } }, "additionalProperties": false } }, { "key": "checkbox-group", "value": { "title": "checkbox-group", "type": "object", "properties": { "bindChange": { "tsType": "() => void", "description": " 中选中项发生改变是触发 change 事件，detail = {value: [ 选中的 checkbox 的 value 的数组 ]}" } }, "additionalProperties": false } }, { "key": "checkbox", "value": { "title": "checkbox", "type": "object", "properties": { "value": { "type": "string", "description": " 标识，选中时触发 的 change 事件，并携带 的 value" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "checked": { "type": "boolean", "description": "当前是否选中，可用来设置默认选中", "defaultValue": false }, "color": { "type": "string", "description": "checkbox 的颜色，同 css 的 color" } }, "additionalProperties": false } }, { "key": "cover-image", "value": { "title": "cover-image", "type": "object", "properties": { "src": { "type": "string", "description": "图标路径，支持临时路径、网络地址。暂不支持 base64 格式。" }, "bindLoad": { "tsType": "() => void", "description": "图片加载成功时触发" }, "bindError": { "tsType": "() => void", "description": "图片加载失败时触发" } }, "additionalProperties": false } }, { "key": "cover-view", "value": { "title": "cover-view", "type": "object", "properties": { "scroll-top": { "type": "number", "description": "设置顶部滚动偏移量，仅在设置了 overflow-y: scroll 成为滚动元素后生效" } }, "additionalProperties": false } }, { "key": "form", "value": { "title": "form", "type": "object", "properties": { "report-submit": { "type": "boolean", "defaultValue": false }, "bindSubmit": { "tsType": "() => void", "defaultValue": "携带 form 中的数据触发 submit 事件，event.detail = {value : {'name': 'value'} , formId: ''}" }, "bindReset": { "tsType": "() => void", "defaultValue": "表单重置时会触发 reset 事件" } }, "additionalProperties": false } }, { "key": "icon", "value": { "title": "icon", "type": "object", "properties": { "type": { "type": "string", "description": "icon 的类型，有效值：success, success_no_circle, info, warn, waiting, cancel, download, search, clear" }, "size": { "type": "number", "description": "icon 的大小，单位 px", "defaultValue": 23 }, "color": { "type": "string", "description": "icon 的颜色，同 css 的 color" } }, "additionalProperties": false } }, { "key": "image", "value": { "title": "image", "type": "object", "properties": { "src": { "type": "string", "description": "图片资源地址" }, "mode": { "type": "string", "description": "图片裁剪、缩放的模式", "defaultValue": "'scaleToFill'" }, "bindError": { "type": "handleEvent", "description": "当错误发生时，发布到 AppService 的事件名，事件对象 event.detail = {errMsg: 'something wrong'}" }, "bindLoad": { "type": "handleEvent", "description": "当图片载入完毕时，发布到 AppService 的事件名，事件对象 event.detail = {height:'图片高度px', width:'图片宽度px'}" } }, "additionalProperties": false } }, { "key": "input", "value": { "title": "input", "type": "object", "properties": { "value": { "type": "string", "description": "输入框的初始内容" }, "type": { "type": "string", "description": "input 的类型", "defaultValue": "text" }, "password": { "type": "boolean", "description": "是否是密码类型", "defaultValue": false }, "placeholder": { "type": "string", "description": "输入框为空时占位符" }, "placeholder-style": { "type": "string", "description": "指定 placeholder 的样式" }, "placeholder-class": { "type": "string", "description": "指定 placeholder 的样式类", "defaultValue": "input-placeholder" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大输入长度，设置为 -1 的时候不限制最大长度", "defaultValue": 140 }, "cursor-spacing": { "type": "number", "description": "指定光标与键盘的距离，单位 px 。取 input 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离", "defaultValue": 0 }, "auto-focus": { "type": "boolean", "description": "(即将废弃，请直接使用 focus 自动聚焦，拉起键盘", "defaultValue": false }, "focus": { "type": "boolean", "description": "获取焦点", "defaultValue": false }, "confirm-type": { "type": "string", "description": "设置键盘右下角按钮的文字，仅在type='text'时生效", "defaultValue": "done", "enum": [ "send", "search", "next", "go", "done" ] }, "confirm-hold": { "type": "boolean", "description": "点击键盘右下角按钮时是否保持键盘不收起", "defaultValue": false }, "cursor": { "type": "number", "description": "指定 focus 时的光标位置" }, "selection-start": { "type": "number", "description": "光标起始位置，自动聚集时有效，需与selection-end搭配使用", "defaultValue": -1 }, "selection-end": { "type": "number", "description": "光标结束位置，自动聚集时有效，需与selection-start搭配使用", "defaultValue": -1 }, "adjust-position": { "type": "boolean", "description": "键盘弹起时，是否自动上推页面", "defaultValue": true }, "bindInput": { "tsType": "() => void", "description": "键盘输入时触发，event.detail = {value, cursor, keyCode}，keyCode 为键值，处理函数可以直接 return 一个字符串，将替换输入框的内容。" }, "bindFocus": { "tsType": "() => void", "description": "输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度" }, "bindBlur": { "tsType": "() => void", "description": "输入框失去焦点时触发，event.detail = {value: value}" }, "bindConfirm": { "tsType": "() => void", "description": "点击完成按钮时触发，event.detail = {value: value}" } }, "additionalProperties": false } }, { "key": "label", "value": { "title": "label", "type": "object", "properties": { "for": { "type": "string", "defaultValue": "绑定控件的 id" } }, "additionalProperties": false } }, { "key": "live-player", "value": { "title": "live-player", "type": "object", "properties": { "src": { "type": "string", "description": "否" }, "mode": { "type": "string", "description": "否", "defaultValue": "live" }, "autoplay": { "type": "boolean", "description": "否", "defaultValue": false }, "muted": { "type": "boolean", "description": "否", "defaultValue": false }, "orientation": { "type": "string", "description": "否", "defaultValue": "vertical" }, "object-fit": { "type": "string", "description": "否", "defaultValue": "contain" }, "sound-mode": { "type": "string", "description": "否", "defaultValue": "speaker" }, "bindStateChange": { "tsType": "() => void", "description": "否" }, "bindFullScreenChange": { "tsType": "() => void", "description": "否" } }, "additionalProperties": false } }, { "key": "map", "value": { "title": "map", "type": "object", "properties": { "longitude": { "type": "number", "description": "是" }, "latitude": { "type": "number", "description": "是" }, "scale": { "type": "number", "description": "否", "defaultValue": 16 }, "theme": { "type": "string", "description": "否", "defaultValue": "normal" }, "showLocation": { "type": "boolean", "description": "否", "defaultValue": false }, "includePoints": { "type": "array（point)", "description": "否" }, "markers": { "type": "array(marker)", "description": "否" }, "polyline": { "type": "array(polyline)", "description": "否" }, "circles": { "type": "array(circle)", "description": "否" }, "controls": { "type": "array(control)", "description": "否" }, "bindMarkerTap": { "tsType": "() => void", "description": "否" }, "bindCallOutTap": { "tsType": "() => void", "description": "否" }, "bindControlTap": { "tsType": "() => void", "description": "否" }, "bindRegionChange": { "tsType": "() => void", "description": "否" }, "bindTap": { "tsType": "() => void", "description": "否" } }, "additionalProperties": false } }, { "key": "movable-area", "value": { "title": "movable-area", "type": "object", "properties": { "scale-area": { "type": "boolean", "description": "当里面的movable-view设置为支持双指缩放时，设置此值可将缩放手势生效区域修改为整个movable-area", "defaultValue": false } }, "additionalProperties": false } }, { "key": "navigator", "value": { "title": "navigator", "type": "object", "properties": { "url": { "type": "string", "description": "当前小程序内的跳转链接" }, "open-type": { "type": "string", "description": "跳转方式", "defaultValue": "navigate", "enum": [ "navigate", "redirect", "switchTab", "reLaunch", "navigateBack" ] }, "delta": { "type": "number", "description": "当 open-type 为 'navigateBack' 时有效，表示回退的层数" }, "hover-class": { "type": "string", "description": "指定点击时的样式类，当 hover-class=\"none\" 时，没有点击态效果", "defaultValue": "navigator-hover" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒", "defaultValue": 50 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒", "defaultValue": 600 } }, "additionalProperties": false } }, { "key": "picker-view", "value": { "title": "picker-view", "type": "object", "properties": { "value": { "type": "numberArray", "defaultValue": "数组中的数字依次表示 picker-view 内的 picker-view-column 选择的第几项（下标从 0 开始），数字大于 picker-view-column 可选项长度时，选择最后一项。" }, "indicator-style": { "type": "string", "defaultValue": "设置选择器中间选中框的样式" }, "indicator-class": { "type": "string", "defaultValue": "设置选择器中间选中框的类名" }, "mask-style": { "type": "string", "defaultValue": "设置蒙层的样式" }, "mask-class": { "type": "string", "defaultValue": "设置蒙层的类名" }, "bindChange": { "tsType": "() => void", "defaultValue": "当滚动选择，value 改变时触发 change 事件，event.detail = {value: value}；value为数组，表示 picker-view 内的 picker-view-column 当前选择的是第几项（下标从 0 开始）" } }, "additionalProperties": false } }, { "key": "picker", "value": { "title": "picker", "type": "object", "properties": { "range": { "type": [ "any[]", "Record" ], "description": "mode 为 selector 或 multiSelector 时，range 有效", "defaultValue": "[]" }, "range-key": { "type": "string", "description": "当 range 是一个 Object Array 时，通过 range-key 来指定 Object 中 key 的值作为选择器显示内容" }, "value": { "type": "number", "description": "value 的值表示选择了 range 中的第几个（下标从 0 开始）", "defaultValue": 0 }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "bindChange": { "tsType": "() => void", "description": "value 改变时触发 change 事件，event.detail = {value: value}" }, "bindCancel": { "tsType": "() => void", "description": "取消选择或点遮罩层收起 picker 时触发" } }, "additionalProperties": false } }, { "key": "progress", "value": { "title": "progress", "type": "object", "properties": { "percent": { "type": "float", "description": "百分比 0~100", "defaultValue": "无" }, "show-info": { "type": "boolean", "description": "在进度条右侧显示百分比", "defaultValue": false }, "stroke-width": { "type": "number", "description": "进度条线的宽度，单位 px", "defaultValue": 6 }, "color": { "type": "string", "description": "进度条颜色 （请使用 activeColor）", "defaultValue": "#F0250F" }, "activeColor": { "type": "string", "description": "已选择的进度条的颜色" }, "backgroundColor": { "type": "string", "description": "未选择的进度条的颜色" }, "active": { "type": "boolean", "description": "进度条从左往右的动画", "defaultValue": false }, "active-mode": { "type": "string", "description": "backwards: 动画从头播；forwards：动画从上次结束点接着播", "defaultValue": "backwards" }, "border-radius": { "type": [ "number", "string" ], "description": "圆角大小", "defaultValue": "0" }, "font-size": { "type": [ "number", "string" ], "description": "右侧百分比字体大小", "defaultValue": "16" }, "duration": { "type": "number", "description": "进度增加1%所需毫秒数", "defaultValue": 30 }, "bindActiveEnd": { "tsType": "() => void", "description": "动画完成事件" } }, "additionalProperties": false } }, { "key": "radio-group", "value": { "title": "radio-group", "type": "object", "properties": { "bindChange": { "tsType": "() => void", "description": " 中的选中项发生变化时触发 change 事件，event.detail = {value: 选中项radio的value}" } }, "additionalProperties": false } }, { "key": "radio", "value": { "title": "radio", "type": "object", "properties": { "value": { "type": "string", "description": " 标识。当该 选中时， 的 change 事件会携带 的 value" }, "checked": { "type": "boolean", "description": "当前是否选中", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "color": { "type": "string", "description": "radio 的颜色，同 css 的 color", "defaultValue": "#F0250F" } }, "additionalProperties": false } }, { "key": "scroll-view", "value": { "title": "scroll-view", "type": "object", "properties": { "scroll-x": { "type": "boolean", "description": "允许横向滚动", "defaultValue": false }, "scroll-y": { "type": "boolean", "description": "允许纵向滚动", "defaultValue": false }, "upper-threshold": { "type": "number", "description": "距顶部/左边多远时（单位px），触发 scrolltoupper 事件", "defaultValue": 50 }, "lower-threshold": { "type": "number", "description": "距底部/右边多远时（单位px），触发 scrolltolower 事件", "defaultValue": 50 }, "scroll-top": { "type": "number", "description": "设置竖向滚动条位置" }, "scroll-left": { "type": "number", "description": "设置横向滚动条位置" }, "scroll-into-view": { "type": "string", "description": "值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素" }, "scroll-with-animation": { "type": "boolean", "description": "在设置滚动条位置时使用动画过渡", "defaultValue": false }, "enable-back-to-top": { "type": "boolean", "description": "iOS点击顶部状态栏、安卓双击标题栏时，滚动条返回顶部，只支持竖向", "defaultValue": false }, "enable-flex": { "type": "boolean", "description": "启用 flexbox 布局。开启后，当前节点声明了 display: flex 就会成为 flex container，并作用于其孩子节点。", "defaultValue": false }, "bindScrollToUpper": { "tsType": "() => void", "description": "滚动到顶部/左边，会触发 scrolltoupper 事件" }, "bindScrollToLower": { "tsType": "() => void", "description": "滚动到底部/右边，会触发 scrolltolower 事件" }, "bindScroll": { "tsType": "() => void", "description": "滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY}" } }, "additionalProperties": false } }, { "key": "slider", "value": { "title": "slider", "type": "object", "properties": { "min": { "type": "number", "description": "最小值", "defaultValue": 0 }, "max": { "type": "number", "description": "最大值", "defaultValue": 100 }, "step": { "type": "number", "description": "步长，取值必须大于 0，并且可被 (max - min) 整除", "defaultValue": 1 }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "value": { "type": "number", "description": "当前取值", "defaultValue": 0 }, "color": { "type": "string", "description": "背景条的颜色（请使用 backgroundColor）", "defaultValue": "#DADADA" }, "selected-color": { "type": "string", "description": "已选择的颜色（请使用 activeColor）", "defaultValue": "#F0250F" }, "activeColor": { "type": "string", "description": "已选择的颜色", "defaultValue": "#F0250F" }, "backgroundColor": { "type": "string", "description": "背景条的颜色", "defaultValue": "#DADADA" }, "block-size": { "type": "number", "description": "滑块的大小，取值范围为 12 - 28", "defaultValue": 28 }, "block-color": { "type": "string", "description": "滑块的颜色", "defaultValue": "#FFFFFF" }, "show-value": { "type": "boolean", "description": "是否显示当前 value", "defaultValue": false }, "bindChange": { "tsType": "() => void", "description": "完成一次拖动后触发的事件，event.detail = {value: value}" }, "bindChanging": { "tsType": "() => void", "description": "拖动过程中触发的事件，event.detail = {value: value}" } }, "additionalProperties": false } }, { "key": "swiper-item", "value": { "title": "swiper-item", "type": "object", "properties": { "item-id": { "type": "string", "description": "该 swiper-item 的标识符", "defaultValue": "" } }, "additionalProperties": false } }, { "key": "swiper", "value": { "title": "swiper", "type": "object", "properties": { "indicator-dots": { "type": "boolean", "description": "是否显示面板指示点", "defaultValue": false }, "indicator-color": { "type": "string", "description": "指示点颜色", "defaultValue": "rgba(0, 0, 0, .3)" }, "indicator-active-color": { "type": "string", "description": "当前选中的指示点颜色", "defaultValue": "#000000" }, "autoplay": { "type": "boolean", "description": "是否自动切换", "defaultValue": false }, "current": { "type": "number", "description": "当前所在滑块的 index", "defaultValue": 0 }, "current-item-id": { "type": "string", "description": "当前所在滑块的 item-id ，不能与 current 被同时指定", "defaultValue": "" }, "interval": { "type": "number", "description": "自动切换时间间隔", "defaultValue": 5000 }, "duration": { "type": "number", "description": "滑动动画时长", "defaultValue": 500 }, "circular": { "type": "boolean", "description": "是否采用衔接滑动", "defaultValue": false }, "vertical": { "type": "boolean", "description": "滑动方向是否为纵向", "defaultValue": false }, "previous-margin": { "type": "string", "description": "前边距，可用于露出前一项的一小部分，接受 px 和 rpx 值", "defaultValue": "0px" }, "next-margin": { "type": "string", "description": "后边距，可用于露出后一项的一小部分，接受 px 和 rpx 值", "defaultValue": "0px" }, "display-multiple-items": { "type": "number", "description": "同时显示的滑块数量", "defaultValue": 1 }, "skip-hidden-item-layout": { "type": "boolean", "description": "是否跳过未显示的滑块布局，设为 true 可优化复杂情况下的滑动性能，但会丢失隐藏状态滑块的布局信息", "defaultValue": false }, "easing-function": { "type": "string", "description": "指定 swiper 切换缓动动画类型", "defaultValue": "default", "enum": [ "default", "linear", "easeInCubic", "easeOutCubic", "easeInOutCubic" ] }, "bindChange": { "tsType": "() => void", "description": "current改变时会触发 change 事件，event.detail = {current: current, source: source}" }, "bindAnimationFinish": { "tsType": "() => void", "description": "动画结束时会触发 animationfinish 事件，event.detail 同上" } }, "additionalProperties": false } }, { "key": "switch", "value": { "title": "switch", "type": "object", "properties": { "checked": { "type": "boolean", "description": "是否选中", "defaultValue": false }, "type": { "type": "string", "description": "样式，有效值：switch, checkbox", "defaultValue": "switch" }, "color": { "type": "string", "description": "switch 的颜色，同 css 的 color" }, "bindChange": { "tsType": "() => void", "description": "checked 改变时触发 change 事件，event.detail={ value:checked}" } }, "additionalProperties": false } }, { "key": "text", "value": { "title": "text", "type": "object", "properties": { "selectable": { "type": "boolean", "description": "文本是否可选", "defaultValue": false }, "space": { "type": "string", "description": "显示连续空格", "enum": [ "ensp", "emsp", "nbsp" ] }, "decode": { "type": "boolean", "description": "是否解码", "defaultValue": false } }, "additionalProperties": false } }, { "key": "textarea", "value": { "title": "textarea", "type": "object", "properties": { "value": { "type": "string", "description": "输入框的内容" }, "placeholder": { "type": "string", "description": "输入框为空时占位符" }, "placeholder-style": { "type": "string", "description": "指定 placeholder 的样式" }, "placeholder-class": { "type": "string", "description": "指定 placeholder 的样式类", "defaultValue": "textarea-placeholder" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大输入长度，设置为 -1 的时候不限制最大长度", "defaultValue": 140 }, "auto-focus": { "type": "boolean", "description": "自动聚焦，拉起键盘。", "defaultValue": false }, "focus": { "type": "boolean", "description": "获取焦点", "defaultValue": false }, "auto-height": { "type": "boolean", "description": "是否自动增高，设置 auto-height 时，style.height 不生效", "defaultValue": false }, "fixed": { "type": "boolean", "description": "如果 textarea 是在一个 position:fixed 的区域，需要显示指定属性 fixed 为 true", "defaultValue": false }, "cursor-spacing": { "type": "number", "description": "指定光标与键盘的距离，单位 px 。取 textarea 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离", "defaultValue": 0 }, "cursor": { "type": "number", "description": "指定 focus 时的光标位置" }, "show-confirm-bar": { "type": "boolean", "description": "是否显示键盘上方带有\"完成\"按钮那一栏", "defaultValue": true }, "selection-start": { "type": "number", "description": "光标起始位置，自动聚集时有效，需与 selection-end 搭配使用", "defaultValue": -1 }, "selection-end": { "type": "number", "description": "光标结束位置，自动聚集时有效，需与 selection-start 搭配使用", "defaultValue": -1 }, "adjust-position": { "type": "boolean", "description": "键盘弹起时，是否自动上推页面", "defaultValue": true }, "bindFocus": { "tsType": "() => void", "description": "输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度" }, "bindBlur": { "tsType": "() => void", "description": "输入框失去焦点时触发，event.detail = {value, cursor}" }, "bindLineChange": { "tsType": "() => void", "description": "输入框行数变化时调用，event.detail = {height: 0, heightRpx: 0, lineCount: 0}" }, "bindInput": { "tsType": "() => void", "description": "当键盘输入时，触发 input 事件，event.detail = {value, cursor}，bindinput 处理函数的返回值并不会反映到 textarea 上" }, "bindConfirm": { "tsType": "() => void", "description": "点击完成时， 触发 confirm 事件，event.detail = {value: value}" } }, "additionalProperties": false } }, { "key": "video", "value": { "title": "video", "type": "object", "properties": { "src": { "type": "string", "description": "是" }, "autoplay": { "type": "boolean", "description": "否", "defaultValue": false }, "muted": { "type": "boolean", "description": "否", "defaultValue": false }, "controls": { "type": "boolean", "description": "否", "defaultValue": true }, "loop": { "type": "boolean", "description": "否", "defaultValue": false }, "objectFit": { "type": "string", "description": "否", "defaultValue": "contain" }, "initialTime": { "type": "number", "description": "否", "defaultValue": 0 }, "poster": { "type": "string", "description": "否" }, "mobilenet-hint-type": { "type": "number", "description": "否", "defaultValue": 1 }, "bindPlay": { "tsType": "() => void", "description": "否" }, "bindPause": { "tsType": "() => void", "description": "否" }, "bindEnded": { "tsType": "() => void", "description": "否" }, "bindTimeUpdate": { "tsType": "() => void", "description": "否" }, "bindFullScreenChange": { "tsType": "() => void", "description": "否" }, "bindError": { "tsType": "() => void", "description": "否" }, "bindWaiting": { "tsType": "() => void", "description": "否" }, "bindLoadedData": { "tsType": "() => void", "description": "否" }, "bindLoadedMetaData": { "tsType": "() => void", "description": "否" }, "bindLoadStart": { "tsType": "() => void", "description": "否" }, "bindSeeked": { "tsType": "() => void", "description": "否" }, "bindSeeking": { "tsType": "() => void", "description": "否" } }, "additionalProperties": false } }, { "key": "view", "value": { "title": "view", "type": "object", "properties": { "hover-class": { "type": "string", "description": "指定按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果", "defaultValue": "none" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒", "defaultValue": 50 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒", "defaultValue": 400 } }, "additionalProperties": false } }, { "key": "web-view", "value": { "title": "web-view", "type": "object", "properties": { "src": { "type": "string", "description": "webview 指向网页的链接。" }, "bindMessage": { "tsType": "() => void", "description": "网页向小程序 postMessage 时，会在特定时机（小程序后退、组件销毁、分享）触发并收到消息。e.detail = { data }" } }, "additionalProperties": false } } ] }, { "key": "qq", "value": [ { "key": "ad", "value": { "title": "ad", "type": "object", "properties": { "unit-id": { "type": "string", "description": "广告单元 id，可在QQ 小程序管理后台的流量主模块新建" }, "type": { "type": "string", "description": "广告类型", "defaultValue": "banner", "enum": [ "banner", "card", "feeds", "block" ] }, "ad-left": { "type": "number", "description": "type 为 feeds 时广告左边距（px），必须大于 0" }, "ad-top": { "type": "number", "description": "type 为 feeds 时广告上边距（px），必须大于 0" }, "ad-width": { "type": "number", "description": "type 为 feeds 时广告宽度（px），默认 100%，最大值为屏幕宽度，最小值为 265" }, "ad-height": { "type": "number", "description": "type 为 feeds 时广告高度（px），最小 85，最大 160" }, "block-size": { "type": "number", "description": "type 为 block 时请求积木广告数量（展示以实际拉取广告数量为准）", "defaultValue": 1 }, "block-orientation": { "type": "string", "description": "type 为 block 时请求积木广告排列方向", "defaultValue": "landscape", "enum": [ "vertical", "landscape" ] }, "test-banner-type": { "type": "string", "description": "开发者工具下，type 为 banner 时，指定 banner 广告展示三图文还是单图", "defaultValue": "three", "enum": [ "one", "three" ] }, "bindSize": { "tsType": "() => void", "description": "type 为 feeds 时广告实际宽高回调，event.detail = {width:296,height:150}" }, "bindLoad": { "tsType": "() => void", "description": "广告加载成功的回调" }, "bindError": { "tsType": "() => void", "description": "广告加载失败的回调，event.detail = {errCode: 1002}" } }, "additionalProperties": false, "required": [ "unit-id" ] } }, { "key": "audio", "value": { "title": "audio", "type": "object", "properties": { "id": { "type": "string", "description": "audio 组件的唯一标识符" }, "src": { "type": "string", "description": "要播放音频的资源地址" }, "loop": { "type": "boolean", "description": "是否循环播放", "defaultValue": false }, "controls": { "type": "boolean", "description": "是否显示默认控件", "defaultValue": false }, "poster": { "type": "string", "description": "默认控件上的音频封面的图片资源地址，如果 controls 属性值为 false 则设置 poster 无效" }, "name": { "type": "string", "description": "默认控件上的音频名字，如果 controls 属性值为 false 则设置 name 无效", "defaultValue": "未知音频" }, "author": { "type": "string", "description": "默认控件上的作者名字，如果 controls 属性值为 false 则设置 author 无效", "defaultValue": "未知作者" }, "bindError": { "tsType": "() => void", "description": "当发生错误时触发 error 事件，detail = {errMsg: MediaError.code}" }, "bindPlay": { "tsType": "() => void", "description": "当开始/继续播放时触发play事件" }, "bindPause": { "tsType": "() => void", "description": "当暂停播放时触发 pause 事件" }, "bindTimeUpdate": { "tsType": "() => void", "description": "当播放进度改变时触发 timeupdate 事件，detail = {currentTime, duration}" }, "bindEnded": { "tsType": "() => void", "description": "当播放到末尾时触发 ended 事件" } }, "additionalProperties": false } }, { "key": "button", "value": { "title": "button", "type": "object", "properties": { "size": { "type": "string", "description": "按钮的大小", "defaultValue": "default", "enum": [ "default", "mini" ] }, "type": { "type": "string", "description": "按钮的样式类型", "defaultValue": "default", "enum": [ "primary", "default", "warn" ] }, "plain": { "type": "boolean", "description": "按钮是否镂空，背景色透明", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "loading": { "type": "boolean", "description": "名称前是否带 loading 图标", "defaultValue": false }, "form-type": { "type": "string", "description": "用于 组件，点击分别会触发 组件的 submit/reset 事件", "enum": [ "submit", "reset" ] }, "open-type": { "type": "string", "description": "QQ 开放能力", "enum": [ "share", "getUserInfo", "launchApp", "openSetting", "feedback", "openGroupProfile", "openGuildProfile", "contact", "addFriend", "addColorSign", "openPublicProfile", "addGroupApp", "shareMessageToFriend", "addToFavorites" ] }, "hover-class": { "type": "string", "description": "指定按钮按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果", "defaultValue": "button-hover" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒", "defaultValue": 20 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒", "defaultValue": 70 }, "lang": { "type": "string", "description": "指定返回用户信息的语言，zh_CN 简体中文，zh_TW 繁体中文，en 英文。", "defaultValue": "en" }, "app-parameter": { "type": "string", "description": "打开 APP 时，向 APP 传递的参数" }, "group-id": { "type": "string", "description": "打开群资料卡时，传递的群号" }, "guild-id": { "type": "string", "description": "打开频道页面时，传递的频道号" }, "public-id": { "type": "string", "description": "打开公众号资料卡时，传递的号码" }, "share-type": { "type": "number", "description": "分享类型集合，请参考下面share-type有效值说明。share-type后续将不再维护，请更新为share-mode", "defaultValue": 27 }, "share-mode": { "type": "array", "description": "分享类型集合，请参考下面share-mode有效值说明", "defaultValue": "['qq', 'qzone']" }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" }, "open-id": { "type": "string", "description": "添加好友时，对方的 openid" }, "share-message-friend-info": { "type": "friendInfo", "description": "发送对象的 FriendInfo" }, "share-message-title": { "type": "string", "description": "转发标题，不传则默认使用当前小程序的昵称。 FriendInfo" }, "share-message-img": { "type": "string", "description": "转发显示图片的链接，可以是网络图片路径（仅 QQ CDN 域名路径）或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4FriendInfo" }, "bindGetUserInfo": { "tsType": "() => void", "description": "用户点击该按钮时，会返回获取到的用户信息，回调的 detail 数据与qq.getUserInfo返回的一致" }, "bindError": { "tsType": "() => void", "description": "当使用开放能力时，发生错误的回调" }, "bindLaunchApp": { "tsType": "() => void", "description": "打开 APP 成功的回调" }, "bindOpenSetting": { "tsType": "() => void", "description": "在打开授权设置页后回调" }, "bindAddFriend": { "tsType": "() => void", "description": "添加好友的回调" }, "bindAddGroupApp": { "tsType": "() => void", "description": "添加群应用的回调。errCode 错误码：41004（当前用户非管理员或群主，无权操作），41005（超过可添加群应用的群数量）" }, "bindContact": { "tsType": "() => void", "description": "打开客服会话的回调。" } }, "additionalProperties": false } }, { "key": "camera", "value": { "title": "camera", "type": "object", "properties": { "mode": { "type": "string", "description": "有效值为 normal, scanCode", "defaultValue": "normal" }, "device-position": { "type": "string", "description": "前置或后置，值为front, back", "defaultValue": "back" }, "flash": { "type": "string", "description": "闪光灯，值为auto, on, off", "defaultValue": "auto" }, "bindStop": { "tsType": "() => void", "description": "摄像头在非正常终止时触发，如退出后台等情况" }, "bindError": { "tsType": "() => void", "description": "用户不允许使用摄像头时触发" }, "bindScanCode": { "tsType": "() => void", "description": "在扫码识别成功时触发，仅在 mode=\"scanCode\" 时生效" } }, "additionalProperties": false } }, { "key": "canvas", "value": { "title": "canvas", "type": "object", "properties": { "canvas-id": { "type": "string", "description": "canvas 组件的唯一标识符" }, "disable-scroll": { "type": "boolean", "description": "当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新", "defaultValue": false }, "bindTouchStart": { "tsType": "() => void", "description": "手指触摸动作开始" }, "bindTouchMove": { "tsType": "() => void", "description": "手指触摸后移动" }, "bindTouchEnd": { "tsType": "() => void", "description": "手指触摸动作结束" }, "bindTouchCancel": { "tsType": "() => void", "description": "手指触摸动作被打断，如来电提醒，弹窗" }, "bindLongTap": { "tsType": "() => void", "description": "手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动" }, "bindError": { "tsType": "() => void", "description": "当发生错误时触发 error 事件，detail = {errMsg: 'something wrong'}" } }, "additionalProperties": false } }, { "key": "checkbox-group", "value": { "title": "checkbox-group", "type": "object", "properties": { "bindChange": { "tsType": "() => void", "description": "中选中项发生改变时触发 change 事件，detail = {value:[选中的checkbox的value的数组]}" } }, "additionalProperties": false } }, { "key": "checkbox", "value": { "title": "checkbox", "type": "object", "properties": { "value": { "type": "string", "description": "标识，选中时触发的 change 事件，并携带 的 value" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "checked": { "type": "boolean", "description": "当前是否选中，可用来设置默认选中", "defaultValue": false }, "color": { "type": "string", "description": "checkbox的颜色，同css的color" }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" } }, "additionalProperties": false } }, { "key": "cover-image", "value": { "title": "cover-image", "type": "object", "properties": { "src": { "type": "string", "description": "图标路径，支持临时路径、网络地址、云文件ID。暂不支持base64格式。" }, "aria-role": { "type": "string", "description": "无障碍访问，（角色）标识元素的作用" }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" }, "bindLoad": { "tsType": "() => void", "description": "图片加载成功时触发" }, "bindError": { "tsType": "() => void", "description": "图片加载失败时触发" } }, "additionalProperties": false } }, { "key": "cover-view", "value": { "title": "cover-view", "type": "object", "properties": { "scroll-top": { "type": [ "number", "string" ], "description": "设置顶部滚动偏移量，仅在设置了 overflow-y: scroll 成为滚动元素后生效" }, "aria-role": { "type": "string", "description": "无障碍访问，（角色）标识元素的作用" }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" } }, "additionalProperties": false } }, { "key": "form", "value": { "title": "form", "type": "object", "properties": { "report-submit": { "type": "boolean", "description": "是否返回 formId 用于发送模板消息 。formId有很小的概率是无效的（如遇到网络失败或因违规使用被封禁接口的情况），如果无效，将返回 requestFormId:fail 开头的 formId" }, "bindSubmit": { "tsType": "() => void", "description": "携带 form 中的数据触发 submit 事件，event.detail = {value : {'name': 'value'} , formId: ''}" }, "bindReset": { "tsType": "() => void", "description": "表单重置时会触发 reset 事件" } }, "additionalProperties": false } }, { "key": "icon", "value": { "title": "icon", "type": "object", "properties": { "type": { "type": "string", "description": "icon的类型，有效值：success, success_no_circle, info, warn, waiting, cancel, download, search, clear" }, "size": { "type": [ "number", "string" ], "description": "icon的大小，单位px", "defaultValue": "23px" }, "color": { "type": "string", "description": "icon的颜色，同css的color" }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" } }, "additionalProperties": false } }, { "key": "image", "value": { "title": "image", "type": "object", "properties": { "src": { "type": "string", "description": "图片资源地址，支持云文件ID（2.2.3起）" }, "mode": { "type": "string", "description": "图片裁剪、缩放的模式", "defaultValue": "'scaleToFill'" }, "lazy-load": { "type": "boolean", "description": "图片懒加载。只针对page与scroll-view下的image有效", "defaultValue": false }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" }, "bindError": { "type": "handleEvent", "description": "当错误发生时，发布到 AppService 的事件名，事件对象event.detail = {errMsg: 'something wrong'}" }, "bindLoad": { "type": "handleEvent", "description": "当图片载入完毕时，发布到 AppService 的事件名，事件对象event.detail = {height:'图片高度px', width:'图片宽度px'}" } }, "additionalProperties": false } }, { "key": "input", "value": { "title": "input", "type": "object", "properties": { "value": { "type": "string", "description": "输入框的初始内容" }, "type": { "type": "string", "description": "input 的类型", "defaultValue": "\"text\"", "enum": [ "text", "number", "idcard", "digit" ] }, "password": { "type": "boolean", "description": "是否是密码类型", "defaultValue": false }, "placeholder": { "type": "string", "description": "输入框为空时占位符" }, "placeholder-style": { "type": "string", "description": "指定 placeholder 的样式" }, "placeholder-class": { "type": "string", "description": "指定 placeholder 的样式类", "defaultValue": "\"input-placeholder\"" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大输入长度，设置为 -1 的时候不限制最大长度", "defaultValue": 140 }, "cursor-spacing": { "type": [ "number", "string" ], "description": "指定光标与键盘的距离，单位 px（2.4.0 起支持 rpx）。取 input 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离", "defaultValue": "0" }, "auto-focus": { "type": "boolean", "description": "(即将废弃，请直接使用 focus )自动聚焦，拉起键盘", "defaultValue": false }, "focus": { "type": "boolean", "description": "获取焦点", "defaultValue": false }, "confirm-type": { "type": "string", "description": "设置键盘右下角按钮的文字，仅在 type='text'时生效", "defaultValue": "\"done\"", "enum": [ "send", "search", "next", "go", "done" ] }, "confirm-hold": { "type": "boolean", "description": "点击键盘右下角按钮时是否保持键盘不收起", "defaultValue": false }, "cursor": { "type": "number", "description": "指定 focus 时的光标位置" }, "selection-start": { "type": "number", "description": "光标起始位置，自动聚集时有效，需与 selection-end 搭配使用", "defaultValue": -1 }, "selection-end": { "type": "number", "description": "光标结束位置，自动聚集时有效，需与 selection-start 搭配使用", "defaultValue": -1 }, "adjust-position": { "type": "boolean", "description": "键盘弹起时，是否自动上推页面", "defaultValue": true }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" }, "bindInput": { "tsType": "() => void", "description": "键盘输入时触发，event.detail = {value, cursor, keyCode}，keyCode 为键值，处理函数可以直接 return 一个字符串，将替换输入框的内容。" }, "bindFocus": { "tsType": "() => void", "description": "输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度" }, "bindBlur": { "tsType": "() => void", "description": "输入框失去焦点时触发，event.detail = {value: value}" }, "bindConfirm": { "tsType": "() => void", "description": "点击完成按钮时触发，event.detail = {value: value}" }, "bindKeyboardHeightChange": { "tsType": "() => void", "description": "键盘高度发生变化的时候触发此事件，event.detail = {height: height, duration: duration}" } }, "additionalProperties": false } }, { "key": "label", "value": { "title": "label", "type": "object", "properties": { "for": { "type": "string", "description": "绑定控件的 id" } }, "additionalProperties": false } }, { "key": "live-player", "value": { "title": "live-player", "type": "object", "properties": { "src": { "type": "string", "description": "音视频地址。目前仅支持flv, rtmp格式" }, "mode": { "type": "string", "description": "模式", "defaultValue": "live" }, "autoplay": { "type": "boolean", "description": "自动播放", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音", "defaultValue": false }, "orientation": { "type": "string", "description": "画面方向", "defaultValue": "vertical" }, "object-fit": { "type": "string", "description": "填充模式，可选值有contain, fillCrop", "defaultValue": "contain" }, "min-cache": { "type": "number", "description": "最小缓冲区，单位s", "defaultValue": 1 }, "max-cache": { "type": "number", "description": "最大缓冲区，单位s", "defaultValue": 3 }, "sound-mode": { "type": "string", "description": "声音输出方式", "defaultValue": "speaker" }, "auto-pause-if-navigate": { "type": "boolean", "description": "当跳转到其它小程序页面时，是否自动暂停本页面的实时音视频播放", "defaultValue": true }, "auto-pause-if-open-native": { "type": "boolean", "description": "当跳转到其它QQ原生页面时，是否自动暂停本页面的实时音视频播放", "defaultValue": true }, "enable-metadata": { "type": "boolean", "description": "是否回调metadata", "defaultValue": false }, "bindStateChange": { "tsType": "() => void", "description": "播放状态变化事件，detail = {code}" }, "bindFullScreenChange": { "tsType": "() => void", "description": "全屏变化事件，detail = {direction, fullScreen}" }, "bindNetStatus": { "tsType": "() => void", "description": "网络状态通知，detail = {info}" }, "bindMetaDataChange": { "tsType": "() => void", "description": "metadata通知，detail = {info}" } }, "additionalProperties": false } }, { "key": "live-pusher", "value": { "title": "live-pusher", "type": "object", "properties": { "url": { "type": "string", "description": "推流地址。目前仅支持 rtmp 格式" }, "mode": { "type": "string", "description": "SD（标清）, HD（高清）, FHD（超清）, RTC（实时通话）", "defaultValue": "RTC" }, "autopush": { "type": "boolean", "description": "自动推流", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音", "defaultValue": false }, "enable-camera": { "type": "boolean", "description": "开启摄像头", "defaultValue": true }, "auto-focus": { "type": "boolean", "description": "自动聚集", "defaultValue": true }, "orientation": { "type": "string", "description": "画面方向", "defaultValue": "vertical" }, "beauty": { "type": "number", "description": "美颜，取值范围 0-9 ，0 表示关闭", "defaultValue": 0 }, "whiteness": { "type": "number", "description": "美白，取值范围 0-9 ，0 表示关闭", "defaultValue": 0 }, "aspect": { "type": "string", "description": "宽高比，可选值有 3:4, 9:16", "defaultValue": "9:16" }, "min-bitrate": { "type": "number", "description": "最小码率", "defaultValue": 200 }, "max-bitrate": { "type": "number", "description": "最大码率", "defaultValue": 1000 }, "audio-quality": { "type": "string", "description": "高音质(48KHz)或低音质(16KHz)，值为high, low", "defaultValue": "high" }, "waiting-image": { "type": "string", "description": "进入后台时推流的等待画面" }, "waiting-image-hash": { "type": "string", "description": "等待画面资源的MD5值" }, "zoom": { "type": "boolean", "description": "调整焦距", "defaultValue": false }, "device-position": { "type": "string", "description": "前置或后置，值为front, back", "defaultValue": "front" }, "background-mute": { "type": "boolean", "description": "进入后台时是否静音", "defaultValue": false }, "mirror": { "type": "boolean", "description": "设置推流画面是否镜像，产生的效果在 live-player 反应到", "defaultValue": false }, "audio-reverb-type": { "type": "number", "description": "混响模式(0～6)：\"关闭混响\", \"KTV\", \"小房间\", \"大会堂\", \"低沉\", \"洪亮\", \"磁性\"", "defaultValue": 0 }, "bindStateChange": { "tsType": "() => void", "description": "状态变化事件，detail = {code}" }, "bindNetStatus": { "tsType": "() => void", "description": "网络状态通知，detail = {info}" }, "bindError": { "tsType": "() => void", "description": "渲染错误事件，detail = {errMsg, errCode}" }, "bindBgmStart": { "tsType": "() => void", "description": "背景音开始播放时触发" }, "bindBgmProgress": { "tsType": "() => void", "description": "背景音进度变化时触发，detail = {progress, duration}" }, "bindBgmComplete": { "tsType": "() => void", "description": "背景音播放完成时触发" } }, "additionalProperties": false } }, { "key": "map", "value": { "title": "map", "type": "object", "properties": { "longitude": { "type": "number", "description": "中心经度" }, "latitude": { "type": "number", "description": "中心纬度" }, "scale": { "type": "number", "description": "缩放级别，取值范围为3～20", "defaultValue": 16 }, "markers": { "type": "array.", "description": "标记点" }, "polyline": { "type": "array.", "description": "路线" }, "circles": { "type": "array.", "description": "圆" }, "include-points": { "type": "array.", "description": "缩放视野以包含所有给定的坐标点" }, "show-location": { "type": "boolean", "description": "显示带有方向的当前定位点", "defaultValue": false }, "polygons": { "type": "array.", "description": "多边形" }, "subkey": { "type": "string", "description": "个性化地图使用的key" }, "layer-style": { "type": "number", "description": "个性化地图配置的style，不支持动态修改", "defaultValue": 1 }, "rotate": { "type": "number", "description": "旋转角度，范围0～360，地图正北与设备y轴\b的夹角角度", "defaultValue": 0 }, "skew": { "type": "number", "description": "倾斜角度，范围0～40，关于z轴的倾角", "defaultValue": 0 }, "enable-3D": { "type": "boolean", "description": "展示3D楼块（工具暂不支持）", "defaultValue": false }, "show-compass": { "type": "boolean", "description": "显示指南针", "defaultValue": false }, "show-scale": { "type": "boolean", "description": "显示比例尺（工具暂不支持）", "defaultValue": false }, "enable-overlooking": { "type": "boolean", "description": "开启俯视", "defaultValue": false }, "enable-zoom": { "type": "boolean", "description": "是否支持缩放", "defaultValue": false }, "enable-scroll": { "type": "boolean", "description": "是否支持拖动", "defaultValue": false }, "enable-rotate": { "type": "boolean", "description": "是否支持旋转", "defaultValue": false }, "enable-satellite": { "type": "boolean", "description": "是否开启卫星图", "defaultValue": false }, "enable-traffic": { "type": "boolean", "description": "是否开启实时路况", "defaultValue": false }, "setting": { "type": "object", "description": "配置项" }, "bindTap": { "tsType": "() => void", "description": "点击地图时触发，返回经纬度信息" }, "bindMarkerTap": { "tsType": "() => void", "description": "点击标记点时触发 e.detail = {markerId}" }, "bindUpdated": { "tsType": "() => void", "description": "在地图渲染更新完成时触发" }, "bindRegionChange": { "tsType": "() => void", "description": "视野发生变化时触发 \b会触发两次，返回的type值分别为begin/end。" }, "bindPoiTap": { "tsType": "() => void", "description": "点击地图poi点时触发 e.detail = {name, longitude, latitude}" } }, "additionalProperties": false, "required": [ "longitude", "latitude" ] } }, { "key": "movable-area", "value": { "title": "movable-area", "type": "object", "properties": { "scale-area": { "type": "boolean", "description": "当里面的movable-view设置为支持双指缩放时，设置此值可将缩放手势生效区域修改为整个movable-area", "defaultValue": false } }, "additionalProperties": false } }, { "key": "movable-view", "value": { "title": "movable-view", "type": "object", "properties": { "direction": { "type": "string", "description": "movable-view的移动方向，属性值有all、vertical、horizontal、none", "defaultValue": "none" }, "inertia": { "type": "boolean", "description": "movable-view是否带有惯性", "defaultValue": false }, "out-of-bounds": { "type": "boolean", "description": "超过可移动区域后，movable-view是否还可以移动", "defaultValue": false }, "x": { "type": [ "number", "string" ], "description": "定义x轴方向的偏移，如果x的值不在可移动范围内，会自动移动到可移动范围；改变x的值会触发动画" }, "y": { "type": [ "number", "string" ], "description": "定义y轴方向的偏移，如果y的值不在可移动范围内，会自动移动到可移动范围；改变y的值会触发动画" }, "damping": { "type": "number", "description": "阻尼系数，用于控制x或y改变时的动画和过界回弹的动画，值越大移动越快", "defaultValue": 20 }, "friction": { "type": "number", "description": "摩擦系数，用于控制惯性滑动的动画，值越大摩擦力越大，滑动越快停止；必须大于0，否则会被设置成默认值", "defaultValue": 2 }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "scale": { "type": "boolean", "description": "是否支持双指缩放，默认缩放手势生效区域是在movable-view内", "defaultValue": false }, "scale-min": { "type": "number", "description": "定义缩放倍数最小值", "defaultValue": 0.5 }, "scale-max": { "type": "number", "description": "定义缩放倍数最大值", "defaultValue": 10 }, "scale-value": { "type": "number", "description": "定义缩放倍数，取值范围为 0.5 - 10", "defaultValue": 1 }, "animation": { "type": "boolean", "description": "是否使用动画", "defaultValue": true }, "bindChange": { "tsType": "() => void", "description": "拖动过程中触发的事件，event.detail = {x: x, y: y, source: source}，其中source表示产生移动的原因，值可为touch（拖动）、touch-out-of-bounds（超出移动范围）、out-of-bounds（超出移动范围后的回弹）、friction（惯性）和空字符串（setData）" }, "bindScale": { "tsType": "() => void", "description": "缩放过程中触发的事件，event.detail = {x: x, y: y, scale: scale}" } }, "additionalProperties": false } }, { "key": "navigator", "value": { "title": "navigator", "type": "object", "properties": { "target": { "type": "string", "description": "在哪个目标上发生跳转，默认当前小程序，可选值self/miniProgram", "defaultValue": "self" }, "url": { "type": "string", "description": "当前小程序内的跳转链接" }, "open-type": { "type": "string", "description": "跳转方式", "defaultValue": "navigate", "enum": [ "navigate", "redirect", "switchTab", "reLaunch", "navigateBack", "exit" ] }, "delta": { "type": "number", "description": "当 open-type 为 'navigateBack' 时有效，表示回退的层数" }, "app-id": { "type": "string", "description": "当target=\"miniProgram\"时有效，要打开的小程序 appId" }, "path": { "type": "string", "description": "当target=\"miniProgram\"时有效，打开的页面路径，如果为空则打开首页" }, "extra-data": { "type": "object", "description": "当target=\"miniProgram\"时有效，需要传递给目标小程序的数据，目标小程序可在 App.onLaunch()，App.onShow() 中获取到这份数据。详情" }, "version": { "type": "version", "description": "当target=\"miniProgram\"时有效，要打开的小程序版本，有效值 develop（开发版），trial（体验版），release（正式版），仅在当前小程序为开发版或体验版时此参数有效；如果当前小程序是正式版，则打开的小程序必定是正式版。", "defaultValue": "release" }, "hover-class": { "type": "string", "description": "指定点击时的样式类，当hover-class=\"none\"时，没有点击态效果", "defaultValue": "navigator-hover" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒", "defaultValue": 50 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒", "defaultValue": 600 }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" }, "bindSuccess": { "type": "string", "description": "当target=\"miniProgram\"时有效，跳转小程序成功" }, "bindFail": { "type": "string", "description": "当target=\"miniProgram\"时有效，跳转小程序失败" }, "bindComplete": { "type": "string", "description": "当target=\"miniProgram\"时有效，跳转小程序完成" } }, "additionalProperties": false } }, { "key": "open-data", "value": { "title": "open-data", "type": "object", "properties": { "type": { "type": "string", "description": "开放数据类型", "enum": [ "userNickName", "userAvatarUrl", "userGender", "userCity", "userProvince", "userCountry", "userLanguage", "userCloudStorage", "friendCloudStorage", "groupCloudStorage" ] }, "lang": { "type": "string", "description": "当 type=\"user*\" 时生效，以哪种语言展示 userInfo，有效值有：en, zh_CN, zh_TW", "defaultValue": "en" }, "share-ticket": { "type": "string", "description": "当 type=groupCloudStorage 时有效，群分享对应的 shareTicket", "defaultValue": "en" }, "key-list": { "type": "string", "description": "当 type=*CloudStorage 时有效，指定要拉取的 key 列表", "defaultValue": "en" }, "component-data": { "type": "string", "description": "当 type=*CloudStorage 时有效，从主域透传给开放数据域的数据，会自动注入到自定义开放数据域组件的 properties 中", "defaultValue": "en" }, "generic:simple-component": { "type": "string", "description": "当 type=*CloudStorage 时有效,指定使用哪个自定义开放数据域组件来渲染开放数据,具体说明见下方", "defaultValue": "en" }, "bindError": { "type": "string", "description": "当 type=*CloudStorage 时有效,开放数据请求或定向分享失败时触发，event.detail = {errMsg: \"getGroupCloudStorage:fail no data\"}", "defaultValue": "en" } }, "additionalProperties": false } }, { "key": "picker-view", "value": { "title": "picker-view", "type": "object", "properties": { "value": { "type": "numberArray", "description": "数组中的数字依次表示 picker-view 内的 picker-view-column 选择的第几项（下标从 0 开始），数字大于 picker-view-column 可选项长度时，选择最后一项。" }, "indicator-style": { "type": "string", "description": "设置选择器中间选中框的样式" }, "indicator-class": { "type": "string", "description": "设置选择器中间选中框的类名" }, "mask-style": { "type": "string", "description": "设置蒙层的样式" }, "mask-class": { "type": "string", "description": "设置蒙层的类名" }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" }, "bindChange": { "tsType": "() => void", "description": "当滚动选择，value 改变时触发 change 事件，event.detail = {value: value}；value为数组，表示 picker-view 内的 picker-view-column 当前选择的是第几项（下标从 0 开始）" }, "bindPickStart": { "tsType": "() => void", "description": "当滚动选择开始时候触发事件" }, "bindPickEnd": { "tsType": "() => void", "description": "当滚动选择结束时候触发事件" } }, "additionalProperties": false } }, { "key": "picker", "value": { "title": "picker", "type": "object", "properties": { "range": { "type": [ "any[]", "Record" ], "description": "mode为 selector 或 multiSelector 时，range 有效", "defaultValue": "[]" }, "range-key": { "type": "string", "description": "当 range 是一个 Object Array 时，通过 range-key 来指定 Object 中 key 的值作为选择器显示内容" }, "value": { "type": "number", "description": "value 的值表示选择了 range 中的第几个（下标从 0 开始）", "defaultValue": 0 }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "bindChange": { "tsType": "() => void", "description": "value 改变时触发 change 事件，event.detail = {value: value}" }, "bindCancel": { "tsType": "() => void", "description": "取消选择或点遮罩层收起 picker 时触发" } }, "additionalProperties": false } }, { "key": "progress", "value": { "title": "progress", "type": "object", "properties": { "percent": { "type": "float", "description": "百分比0~100", "defaultValue": "无" }, "show-info": { "type": "boolean", "description": "在进度条右侧显示百分比", "defaultValue": false }, "border-radius": { "type": [ "number", "string" ], "description": "圆角大小，单位px", "defaultValue": "0" }, "font-size": { "type": [ "number", "string" ], "description": "右侧百分比字体大小，单位px", "defaultValue": "16" }, "stroke-width": { "type": [ "number", "string" ], "description": "进度条线的宽度，单位px", "defaultValue": "6" }, "color": { "type": "string", "description": "进度条颜色 （请使用 activeColor）", "defaultValue": "#09BB07" }, "activeColor": { "type": "string", "description": "已选择的进度条的颜色" }, "backgroundColor": { "type": "string", "description": "未选择的进度条的颜色" }, "active": { "type": "boolean", "description": "进度条从左往右的动画", "defaultValue": false }, "active-mode": { "type": "string", "description": "backwards: 动画从头播；forwards：动画从上次结束点接着播", "defaultValue": "backwards" }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" }, "bindActiveEnd": { "tsType": "() => void", "description": "动画完成事件" } }, "additionalProperties": false } }, { "key": "radio-group", "value": { "title": "radio-group", "type": "object", "properties": { "bindChange": { "tsType": "() => void", "description": " 中的选中项发生变化时触发 change 事件，event.detail = {value: 选中项radio的value}" } }, "additionalProperties": false } }, { "key": "radio", "value": { "title": "radio", "type": "object", "properties": { "value": { "type": "string", "description": " 标识。当该 选中时， 的 change 事件会携带的value" }, "checked": { "type": "boolean", "description": "当前是否选中", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "color": { "type": "string", "description": "radio的颜色，同css的color" }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" } }, "additionalProperties": false } }, { "key": "rich-text", "value": { "title": "rich-text", "type": "object", "properties": { "nodes": { "type": [ "any[]", "string" ], "description": "节点列表 / HTML String", "defaultValue": "[]" }, "space": { "type": "string", "description": "显示连续空格", "enum": [ "ensp", "emsp", "nbsp" ] } }, "additionalProperties": false } }, { "key": "scroll-view", "value": { "title": "scroll-view", "type": "object", "properties": { "scroll-x": { "type": "boolean", "description": "允许横向滚动", "defaultValue": false }, "scroll-y": { "type": "boolean", "description": "允许纵向滚动", "defaultValue": false }, "upper-threshold": { "type": [ "number", "string" ], "description": "距顶部/左边多远时（单位px），触发 scrolltoupper 事件", "defaultValue": "50" }, "lower-threshold": { "type": [ "number", "string" ], "description": "距底部/右边多远时（单位px），触发 scrolltolower 事件", "defaultValue": "50" }, "scroll-top": { "type": [ "number", "string" ], "description": "设置竖向滚动条位置（单位px）" }, "scroll-left": { "type": [ "number", "string" ], "description": "设置横向滚动条位置（单位px）" }, "scroll-into-view": { "type": "string", "description": "值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素" }, "scroll-with-animation": { "type": "boolean", "description": "在设置滚动条位置时使用动画过渡", "defaultValue": false }, "enable-back-to-top": { "type": "boolean", "description": "iOS点击顶部状态栏、安卓双击标题栏时，滚动条返回顶部，只支持竖向", "defaultValue": false }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" }, "bindScrollToUpper": { "tsType": "() => void", "description": "滚动到顶部/左边，会触发 scrolltoupper 事件" }, "bindScrollToLower": { "tsType": "() => void", "description": "滚动到底部/右边，会触发 scrolltolower 事件" }, "bindScroll": { "tsType": "() => void", "description": "滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY}" } }, "additionalProperties": false } }, { "key": "slider", "value": { "title": "slider", "type": "object", "properties": { "min": { "type": "number", "description": "最小值", "defaultValue": 0 }, "max": { "type": "number", "description": "最大值", "defaultValue": 100 }, "step": { "type": "number", "description": "步长，取值必须大于 0，并且可被(max - min)整除", "defaultValue": 1 }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "value": { "type": "number", "description": "当前取值", "defaultValue": 0 }, "color": { "type": "string", "description": "背景条的颜色（请使用 backgroundColor）", "defaultValue": "#e9e9e9" }, "selected-color": { "type": "string", "description": "已选择的颜色（请使用 activeColor）", "defaultValue": "#1aad19" }, "activeColor": { "type": "string", "description": "已选择的颜色", "defaultValue": "#1aad19" }, "backgroundColor": { "type": "string", "description": "背景条的颜色", "defaultValue": "#e9e9e9" }, "block-size": { "type": "number", "description": "滑块的大小，取值范围为 12 - 28", "defaultValue": 28 }, "block-color": { "type": "string", "description": "滑块的颜色", "defaultValue": "#ffffff" }, "show-value": { "type": "boolean", "description": "是否显示当前 value", "defaultValue": false }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" }, "bindChange": { "tsType": "() => void", "description": "完成一次拖动后触发的事件，event.detail = {value: value}" }, "bindChanging": { "tsType": "() => void", "description": "拖动过程中触发的事件，event.detail = {value: value}" } }, "additionalProperties": false } }, { "key": "swiper", "value": { "title": "swiper", "type": "object", "properties": { "indicator-dots": { "type": "boolean", "description": "是否显示面板指示点", "defaultValue": false }, "indicator-color": { "type": "string", "description": "指示点颜色", "defaultValue": "rgba(0, 0, 0, .3)" }, "indicator-active-color": { "type": "string", "description": "当前选中的指示点颜色", "defaultValue": "#000000" }, "autoplay": { "type": "boolean", "description": "是否自动切换", "defaultValue": false }, "current": { "type": "number", "description": "当前所在滑块的 index", "defaultValue": 0 }, "current-item-id": { "type": "string", "description": "当前所在滑块的 item-id ，不能与 current 被同时指定" }, "interval": { "type": "number", "description": "自动切换时间间隔", "defaultValue": 5000 }, "duration": { "type": "number", "description": "滑动动画时长", "defaultValue": 500 }, "circular": { "type": "boolean", "description": "是否采用衔接滑动", "defaultValue": false }, "vertical": { "type": "boolean", "description": "滑动方向是否为纵向", "defaultValue": false }, "previous-margin": { "type": "string", "description": "前边距，可用于露出前一项的一小部分，接受 px 和 rpx 值", "defaultValue": "\"0px\"" }, "next-margin": { "type": "string", "description": "后边距，可用于露出后一项的一小部分，接受 px 和 rpx 值", "defaultValue": "\"0px\"" }, "display-multiple-items": { "type": "number", "description": "同时显示的滑块数量", "defaultValue": 1 }, "skip-hidden-item-layout": { "type": "boolean", "description": "是否跳过未显示的滑块布局，设为 true 可优化复杂情况下的滑动性能，但会丢失隐藏状态滑块的布局信息", "defaultValue": false }, "bindChange": { "tsType": "() => void", "description": "current 改变时会触发 change 事件，event.detail = {current: current, source: source}" }, "bindTransition": { "tsType": "() => void", "description": "swiper-item 的位置发生改变时会触发 transition 事件，event.detail = {dx: dx, dy: dy}" }, "bindAnimationFinish": { "tsType": "() => void", "description": "动画结束时会触发 animationfinish 事件，event.detail 同上" } }, "additionalProperties": false } }, { "key": "switch", "value": { "title": "switch", "type": "object", "properties": { "checked": { "type": "boolean", "description": "是否选中", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "type": { "type": "string", "description": "样式，有效值：switch, checkbox", "defaultValue": "switch" }, "color": { "type": "string", "description": "switch 的颜色，同 css 的 color" }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" }, "bindChange": { "tsType": "() => void", "description": "checked 改变时触发 change 事件，event.detail={ value:checked}" } }, "additionalProperties": false } }, { "key": "text", "value": { "title": "text", "type": "object", "properties": { "selectable": { "type": "boolean", "description": "文本是否可选", "defaultValue": false }, "space": { "type": "string", "description": "显示连续空格", "enum": [ "ensp", "emsp", "nbsp" ] }, "decode": { "type": "boolean", "description": "是否解码", "defaultValue": false } }, "additionalProperties": false } }, { "key": "textarea", "value": { "title": "textarea", "type": "object", "properties": { "value": { "type": "string", "description": "输入框的内容" }, "placeholder": { "type": "string", "description": "输入框为空时占位符" }, "placeholder-style": { "type": "string", "description": "指定 placeholder 的样式，目前仅支持color,font-size和font-weight" }, "placeholder-class": { "type": "string", "description": "指定 placeholder 的样式类", "defaultValue": "textarea-placeholder" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大输入长度，设置为 -1 的时候不限制最大长度", "defaultValue": 140 }, "auto-focus": { "type": "boolean", "description": "自动聚焦，拉起键盘。", "defaultValue": false }, "focus": { "type": "boolean", "description": "获取焦点", "defaultValue": false }, "auto-height": { "type": "boolean", "description": "是否自动增高，设置auto-height时，style.height不生效", "defaultValue": false }, "fixed": { "type": "boolean", "description": "如果 textarea 是在一个 position:fixed 的区域，需要显示指定属性 fixed 为 true", "defaultValue": false }, "cursor-spacing": { "type": [ "number", "string" ], "description": "指定光标与键盘的距离，单位px。取 textarea 距离底部的距离和 cursor-spacing 指定的距离的最小值作为光标与键盘的距离", "defaultValue": "0" }, "cursor": { "type": "number", "description": "指定focus时的光标位置" }, "show-confirm-bar": { "type": "boolean", "description": "是否显示键盘上方带有”完成“按钮那一栏", "defaultValue": true }, "selection-start": { "type": "number", "description": "光标起始位置，自动聚集时有效，需与selection-end搭配使用", "defaultValue": -1 }, "selection-end": { "type": "number", "description": "光标结束位置，自动聚集时有效，需与selection-start搭配使用", "defaultValue": -1 }, "adjust-position": { "type": "boolean", "description": "键盘弹起时，是否自动上推页面", "defaultValue": true }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" }, "bindFocus": { "tsType": "() => void", "description": "输入框聚焦时触发，event.detail = { value, height }，height 为键盘高度" }, "bindBlur": { "tsType": "() => void", "description": "输入框失去焦点时触发，event.detail = {value, cursor}" }, "bindLineChange": { "tsType": "() => void", "description": "输入框行数变化时调用，event.detail = {height: 0, heightRpx: 0, lineCount: 0}" }, "bindInput": { "tsType": "() => void", "description": "当键盘输入时，触发 input 事件，event.detail = {value, cursor, keyCode}，keyCode 为键值，目前工具还不支持返回keyCode参数。bindinput 处理函数的返回值并不会反映到 textarea 上" }, "bindConfirm": { "tsType": "() => void", "description": "点击完成时， 触发 confirm 事件，event.detail = {value: value}" } }, "additionalProperties": false } }, { "key": "video", "value": { "title": "video", "type": "object", "properties": { "src": { "type": "string", "description": "要播放视频的资源地址，支持云文件ID" }, "duration": { "type": "number", "description": "指定视频时长" }, "controls": { "type": "boolean", "description": "是否显示默认播放控件（播放/暂停按钮、播放进度、时间）", "defaultValue": true }, "danmu-list": { "type": "objectArray", "description": "弹幕列表" }, "danmu-btn": { "type": "boolean", "description": "是否显示弹幕按钮，只在初始化时有效，不能动态变更", "defaultValue": false }, "enable-danmu": { "type": "boolean", "description": "是否展示弹幕，只在初始化时有效，不能动态变更", "defaultValue": false }, "autoplay": { "type": "boolean", "description": "是否自动播放", "defaultValue": false }, "loop": { "type": "boolean", "description": "是否循环播放", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音播放", "defaultValue": false }, "initial-time": { "type": "number", "description": "指定视频初始播放位置" }, "page-gesture": { "type": "boolean", "description": "在非全屏模式下，是否开启亮度与音量调节手势", "defaultValue": false }, "direction": { "type": "number", "description": "设置全屏时视频的方向，不指定则根据宽高比自动判断。有效值为 0（正常竖向）, 90（屏幕逆时针90度）, -90（屏幕顺时针90度）" }, "show-progress": { "type": "boolean", "description": "若不设置，宽度大于240时才会显示", "defaultValue": true }, "show-fullscreen-btn": { "type": "boolean", "description": "是否显示全屏按钮", "defaultValue": true }, "show-play-btn": { "type": "boolean", "description": "是否显示视频底部控制栏的播放按钮", "defaultValue": true }, "show-center-play-btn": { "type": "boolean", "description": "是否显示视频中间的播放按钮", "defaultValue": true }, "enable-progress-gesture": { "type": "boolean", "description": "是否开启控制进度的手势", "defaultValue": true }, "object-fit": { "type": "string", "description": "当视频大小与 video 容器大小不一致时，视频的表现形式。contain：包含，fill：填充，cover：覆盖", "defaultValue": "contain" }, "poster": { "type": "string", "description": "视频封面的图片网络资源地址或云文件ID。若 controls 属性值为 false 则设置 poster 无效" }, "show-mute-btn": { "type": "boolean", "description": "是否显示静音按钮", "defaultValue": false }, "title": { "type": "string", "description": "视频的标题，全屏时在顶部展示" }, "play-btn-position": { "type": "string", "description": "播放按钮的位置，有效值为：bottom（controls bar 上）、center（视频中间）", "defaultValue": "bottom" }, "enable-play-gesture": { "type": "boolean", "description": "是否开启播放手势，即双击切换播放/暂停", "defaultValue": false }, "auto-pause-if-navigate": { "type": "boolean", "description": "当跳转到其它小程序页面时，是否自动暂停本页面的视频", "defaultValue": true }, "auto-pause-if-open-native": { "type": "boolean", "description": "当跳转到其它QQ原生页面时，是否自动暂停本页面的视频", "defaultValue": true }, "bindPlay": { "tsType": "() => void", "description": "当开始/继续播放时触发play事件" }, "bindPause": { "tsType": "() => void", "description": "当暂停播放时触发 pause 事件" }, "bindEnded": { "tsType": "() => void", "description": "当播放到末尾时触发 ended 事件" }, "bindTimeUpdate": { "tsType": "() => void", "description": "播放进度变化时触发，event.detail = {currentTime, duration} 。触发频率 250ms 一次" }, "bindFullScreenChange": { "tsType": "() => void", "description": "视频进入和退出全屏时触发，event.detail = {fullScreen, direction}，direction 有效值为 vertical 或 horizontal" }, "bindWaiting": { "tsType": "() => void", "description": "视频出现缓冲时触发" }, "bindError": { "tsType": "() => void", "description": "视频播放出错时触发" }, "bindProgress": { "tsType": "() => void", "description": "加载进度变化时触发，只支持一段加载。event.detail = {buffered}，百分比" } }, "additionalProperties": false } }, { "key": "view", "value": { "title": "view", "type": "object", "properties": { "hover-class": { "type": "string", "description": "指定按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果", "defaultValue": "none" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒", "defaultValue": 50 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒", "defaultValue": 400 }, "aria-role": { "type": "string", "description": "无障碍访问，（角色）标识元素的作用" }, "aria-label": { "type": "string", "description": "无障碍访问，（属性）元素的额外描述" } }, "additionalProperties": false } }, { "key": "web-view", "value": { "title": "web-view", "type": "object", "properties": { "src": { "type": "string", "description": "webview 指向网页的链接。网页需登录QQ 小程序管理后台配置业务域名。" }, "bindMessage": { "tsType": "() => void", "description": "网页向小程序 postMessage 时，会在特定时机（小程序后退、组件销毁、分享）触发并收到消息。e.detail = { data }，data 是多次 postMessage 的参数组成的数组" }, "bindLoad": { "tsType": "() => void", "description": "网页加载成功时候触发此事件。e.detail = { src }" }, "bindError": { "tsType": "() => void", "description": "网页加载失败的时候触发此事件。e.detail = { src }" } }, "additionalProperties": false } } ] }, { "key": "tt", "value": [ { "key": "ad", "value": { "title": "ad", "type": "object", "properties": { "unit-id": { "type": "string", "description": "广告位 id，必填。需要预先在「小程序管理后台 > 流量主模块」配置生成。" }, "ad-intervals": { "type": "number", "description": "广告自动刷新的间隔时间，只对 banner 型广告生效。单位为秒，参数值必须大于等于 30（该参数不传入时 banner 广告不会自动刷新）" }, "fixed": { "type": "boolean", "description": "广告是否在屏幕中固定展示" }, "type": { "type": "string", "description": "广告的类型，详见 type 的合法值", "defaultValue": "\"banner\"", "enum": [ "banner", "video", "large", "lImg", "rImg" ] }, "scale": { "type": "number", "description": "广告的缩放比例，100 为标准尺寸", "defaultValue": "100" }, "bindLoad": { "tsType": "() => void", "description": "广告加载成功的回调方法" }, "bindError": { "tsType": "() => void", "description": "广告加载失败的回调方法，具体的错误信息可以参考广告错误码说明" }, "bindClose": { "tsType": "() => void", "description": "广告关闭的回调方法" } }, "additionalProperties": false, "required": [ "unit-id" ] } }, { "key": "aweme-data", "value": { "title": "aweme-data", "type": "object", "properties": { "aweme-id": { "type": "string", "description": "用户的抖音号，可以进入抖音 App 用户个人主页查看" }, "type": { "type": "\"avatar\"|\"nickname\"", "description": "类型，可以选择头像或昵称", "defaultValue": "\"avatar\"", "enum": [ "avatar", "nickname" ] }, "disable-default": { "type": "boolean", "description": "是否禁用头像点击的默认行为。\n如果为false，点击头像时，如果用户处于直播状态下会跳转到直播间，非直播状态下跳转到个人主页。\n如果为 true，点击头像将不会有任何的跳转行为。", "defaultValue": false }, "default-avatar": { "type": "string", "description": "获取信息失败时显示的默认头像 url" }, "default-text": { "type": "string", "description": "获取信息失败时显示的默认昵称文本" }, "bindError": { "tsType": "() => void", "description": "当错误发生时触发" } }, "additionalProperties": false, "required": [ "aweme-id" ] } }, { "key": "button", "value": { "title": "button", "type": "object", "properties": { "size": { "type": "string", "description": "按钮的大小，详情见 size 的合法值", "defaultValue": "default", "enum": [ "default", "mini" ] }, "type": { "type": "string", "description": "按钮的样式类型，详情见 type 的合法值", "defaultValue": "default", "enum": [ "primary", "default" ] }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "loading": { "type": "boolean", "description": "是否带 loading 图标", "defaultValue": false }, "form-type": { "type": "string", "description": "用于嵌在 form 组件中，控制 submit/reset，详情见 form-type 的合法值", "enum": [ "submit", "reset" ] }, "open-type": { "type": "string", "description": "用于调用开放能力, 详情见 open-type 的合法值", "enum": [ "share", "getPhoneNumber", "contact", "im", "openSetting" ] }, "hover-class": { "type": "string", "description": "点击状态的样式类", "defaultValue": "button-hover" }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒", "defaultValue": 20 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒", "defaultValue": 70 }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态", "defaultValue": false }, "bindGetPhoneNumber": { "tsType": "() => void", "description": "获取用户手机号回调，只在 open-type=\"getPhoneNumber\" 时有效" }, "bindOpenSetting": { "tsType": "() => void", "description": "在打开授权设置页后回调。只在open-type=\"openSetting\"时有效" } }, "additionalProperties": false } }, { "key": "camera", "value": { "title": "camera", "type": "object", "properties": { "mode": { "type": "string", "description": "模式，不支持动态修改，详情见 mode 的合法值。", "defaultValue": "normal", "enum": [ "normal", "scanCode" ] }, "resolution": { "type": "string", "description": "分辨率，不支持动态修改，详情见 resolution 的合法值。", "defaultValue": "medium", "enum": [ "low", "medium", "high" ] }, "device-position": { "type": "string", "description": "摄像头朝向，详情见 device-position 的合法值。", "defaultValue": "back", "enum": [ "front", "back" ] }, "flash": { "type": "string", "description": "闪光灯，详情见 flash 的合法值。", "defaultValue": "off", "enum": [ "off", "torch" ] }, "frame-size": { "type": "string", "description": "指定期望的相机帧数据尺寸，详情见 frame-size 的合法值。", "defaultValue": "medium", "enum": [ "small", "medium", "large" ] }, "bindInitDone": { "tsType": "() => void", "description": "相机初始化完成时触发，e.detail = {maxZoom}。" }, "bindError": { "tsType": "() => void", "description": "用户不允许使用摄像头或相机异常时触发。" }, "bindStop": { "tsType": "() => void", "description": "摄像头在非正常终止时触发，如退出后台/跳转页面/电话中断等情况。" }, "bindScanCode": { "tsType": "() => void", "description": "在扫码识别成功时触发，仅在 mode=\"scanCode\" 时生效。" } }, "additionalProperties": false } }, { "key": "canvas", "value": { "title": "canvas", "type": "object", "properties": { "canvas-id": { "type": "string", "description": "[v1]canvas 组件的标识" }, "type": { "type": "string", "description": "[v2]指定 canvas 类型，有效值为 \"2d\" 和 \"webgl\"" }, "bindTouchStart": { "tsType": "() => void", "description": "[v2]手指触摸动作开始" }, "bindTouchMove": { "tsType": "() => void", "description": "[v2]手指触摸后移动" }, "bindTouchEnd": { "tsType": "() => void", "description": "[v2]手指触摸动作结束" }, "bindTouchCancel": { "tsType": "() => void", "description": "[v2]手指触摸动作被打断" } }, "additionalProperties": false, "required": [ "canvas-id", "type" ] } }, { "key": "checkbox-group", "value": { "title": "checkbox-group", "type": "object", "properties": { "name": { "type": "string", "description": "用于 form 组件，在表单提交事件中作为提交数据的 key 值。\n\n\n" }, "bindChange": { "tsType": "() => void", "description": "checkbox-group 中选中项发生改变时触发 change 事件。" } }, "additionalProperties": false } }, { "key": "checkbox", "value": { "title": "checkbox", "type": "object", "properties": { "value": { "type": "string", "description": "checkbox 标识，选中时触发 checkbox-group 的 change 事件，并携带 checkbox 的 value。" }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false }, "checked": { "type": "boolean", "description": "当前是否选中，可用来设置默认选中。", "defaultValue": false }, "color": { "type": "string", "description": "checkbox 的颜色，同 CSS 的 color。" } }, "additionalProperties": false } }, { "key": "form", "value": { "title": "form", "type": "object", "properties": { "conversion-target": { "type": "number", "description": "用于分发目的。取值：0 或 1，其中 0 表示默认，1 表示留资目标，需要和留资分发配置一起使用，详情见留资分发配置", "defaultValue": 0 }, "clue-component-id": { "type": "string", "description": "用于分发目的。开发者在【小程序开发者后台 -> 进入目标小程序 -> 运营 -> 流量配置 -> 抖音 -> 留资分发配置】复制创建的配置 ID，需要和留资分发配置一起使用，详情见留资分发配置\n", "defaultValue": "\"\"" }, "bindSubmit": { "tsType": "() => void", "description": "携带 form 中的数据触发 submit 事件，event.detail = {value : {'name': 'value'} , ...}。" }, "bindReset": { "tsType": "() => void", "description": "表单重置时会触发 reset 事件。" } }, "additionalProperties": false } }, { "key": "icon", "value": { "title": "icon", "type": "object", "properties": { "type": { "type": "string", "description": "icon 的类型", "enum": [ "success", "success_no_circle", "info", "warn", "waiting", "clear", "cancel", "download", "search" ] }, "size": { "type": "number", "description": "icon 的大小，单位 px", "defaultValue": 24 }, "color": { "type": "string", "description": "icon 的颜色" } }, "additionalProperties": false, "required": [ "type" ] } }, { "key": "image", "value": { "title": "image", "type": "object", "properties": { "src": { "type": "string", "description": "图片资源地址。" }, "mode": { "type": "string", "description": "图片剪裁方式，详情见 mode 的合法值。", "defaultValue": "scaleToFill", "enum": [ "scaleToFill", "aspectFit", "aspectFill", "widthFix", "heightFix", "top", "bottom", "center", "left", "right", "top left", "top right", "bottom left", "bottom right" ] }, "lazy-load": { "type": "boolean", "description": "图片懒加载，在即将进入一定范围（上下左右三屏）时才开始加载。", "defaultValue": false }, "bindError": { "tsType": "() => void", "description": "当错误发生时触发。" }, "bindLoad": { "tsType": "() => void", "description": "当图片载入完毕时触发。" } }, "additionalProperties": false } }, { "key": "input", "value": { "title": "input", "type": "object", "properties": { "value": { "type": "string", "description": "输入框的初始值。" }, "type": { "type": "string", "description": "input 的类型，详情见 type 的合法值。", "defaultValue": "text", "enum": [ "text", "number", "digit" ] }, "password": { "type": "boolean", "description": "是否是密码类型。", "defaultValue": false }, "placeholder": { "type": "string", "description": "输入框为空时占位符。" }, "placeholder-style": { "type": "string", "description": "指定 placeholder 的样式，只支持 font-size、font-weight、color 三个 CSS 特性。" }, "placeholder-class": { "type": "string", "description": "指定 placeholder 的样式类。" }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大输入长度。", "defaultValue": 140 }, "cursor-spacing": { "type": "number", "description": "指定软键盘弹出时，与光标的距离是多少，单位是 px。", "defaultValue": 0 }, "focus": { "type": "boolean", "description": "获取焦点，详情见 Bug & Tip。", "defaultValue": false }, "cursor": { "type": "number", "description": "指定 focus 时的光标位置，详情见光标位置说明。", "defaultValue": -1 }, "selection-start": { "type": "number", "description": "指定 focus 时选中片段的起始位置，详情见光标位置说明。", "defaultValue": -1 }, "selection-end": { "type": "number", "description": "指定 focus 时选中片段的结束位置，详情见光标位置说明。", "defaultValue": -1 }, "adjust-position": { "type": "boolean", "description": "键盘弹起时，是否自动上推页面。", "defaultValue": true }, "confirm-type": { "type": "string", "description": "设置键盘右下角按钮的文字，仅在 type='text' 时生效，详情见 confirm-type 的合法值。", "defaultValue": "done", "enum": [ "send", "search", "next", "go", "done" ] }, "confirm-hold": { "type": "boolean", "description": "点击键盘右下角按钮时是否保持键盘不收起。", "defaultValue": false }, "hold-keyboard": { "type": "boolean", "description": "focus 时，点击页面的时候不收起键盘。", "defaultValue": false }, "clue-type": { "type": "number", "description": "用于分发目的。取值：0 和 1，其中 0 表示默认，1 表示手机号，需要和留资分发配置一起使用，详情见留资分发配置。", "defaultValue": 0 }, "bindInput": { "tsType": "() => void", "description": "键盘输入时触发，处理函数可以直接 return 一个字符串，将替换输入框的内容，详情见 bindinput 说明。" }, "bindFocus": { "tsType": "() => void", "description": "输入框聚焦时触发，详情见 bindfocus 说明。" }, "bindBlur": { "tsType": "() => void", "description": "输入框失去焦点时触发，详情见 bindblur 说明。" }, "bindConfirm": { "tsType": "() => void", "description": "用户点击键盘的完成按钮时触发，详情见 bindconfirm 说明。" }, "bindKeyboardHeightChange": { "tsType": "() => void", "description": "键盘高度发生变化的时候触发此事件，详情见 bindkeyboardheightchange 说明。" } }, "additionalProperties": false } }, { "key": "label", "value": { "title": "label", "type": "object", "properties": { "for": { "type": "string", "description": "绑定控件的 id" } }, "additionalProperties": false } }, { "key": "live-player", "value": { "title": "live-player", "type": "object", "properties": { "src": { "type": "string", "description": "视频地址。目前支持 flv、rtmp 和 hls，支持跨域。" }, "autoplay": { "type": "boolean", "description": "是否自动播放", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音", "defaultValue": false }, "orientation": { "type": "string", "description": "画面朝向，vertical 为竖直，horizontal 为水平，详情见 orientation 的合法值。", "defaultValue": "vertical", "enum": [ "vertical", "horizontal" ] }, "object-fit": { "type": "string", "description": "填充模式，可选值有 contain，fillCrop，详情见 object-fit 的合法值。", "defaultValue": "contain", "enum": [ "contain", "fillCrop" ] }, "signature": { "type": "signature", "description": "设置署名水印" }, "bindStateChange": { "tsType": "() => void", "description": "播放状态变化事件，detail = {code}。" }, "bindFullScreenChange": { "tsType": "() => void", "description": "全屏变化事件，detail = {direction, fullScreen}。" }, "bindError": { "tsType": "() => void", "description": "播放错误事件" } }, "additionalProperties": false, "required": [ "src" ] } }, { "key": "map", "value": { "title": "map", "type": "object", "properties": { "longitude": { "type": "number", "description": "中心经度" }, "latitude": { "type": "number", "description": "中心纬度" }, "scale": { "type": "number", "description": "缩放级别，取值范围为 3-19", "defaultValue": "16" }, "markers": { "type": "marker[]", "description": "标记点" }, "circles": { "type": "circle[]", "description": "圆" }, "show-location": { "type": "boolean", "description": "是否显示当前位置", "defaultValue": false }, "polyline": { "type": "polyline[]", "description": "路线数组" }, "include-points": { "type": "lngLat[]", "description": "缩放视野以包含所有给定的坐标点；示例：[{latitude: 0, longitude: 0}]" }, "rotate": { "type": "number", "description": "顺时针旋转角度，范围 0 ~ 360，旋转原点为地图容器中心点", "defaultValue": "0" }, "skew": { "type": "number", "description": "倾斜角度，范围 0 ~ 40 , 关于 z 轴的倾角", "defaultValue": "0" }, "polygons": { "type": "polygon[]", "description": "多边形" }, "show-compass": { "type": "boolean", "description": "显示指南针", "defaultValue": false }, "enable-overlooking": { "type": "boolean", "description": "开启俯视手势支持，双指上下滑调整俯仰角", "defaultValue": false }, "enable-rotate": { "type": "boolean", "description": "开启旋转手势支持，双指旋转调整旋转角度", "defaultValue": false }, "min-scale": { "type": "number", "description": "最小缩放级别，取值范围为 3 - max-scale", "defaultValue": "3" }, "max-scale": { "type": "number", "description": "最大缩放级别，取值范围为 min-scale - 19", "defaultValue": "19" }, "enable-3D": { "type": "boolean", "description": "是否展示 3D 楼块，该属性 IOS 不支持", "defaultValue": false }, "show-scale": { "type": "boolean", "description": "是否显示比例尺", "defaultValue": false }, "enable-zoom": { "type": "boolean", "description": "是否支持缩放", "defaultValue": true }, "enable-scroll": { "type": "boolean", "description": "是否支持拖动", "defaultValue": true }, "enable-satellite": { "type": "boolean", "description": "是否开启卫星图", "defaultValue": false }, "enable-traffic": { "type": "boolean", "description": "是否开启实时路况，在该属性为 true 时，enable- building 和 enable-3D 无效", "defaultValue": false }, "enable-poi": { "type": "boolean", "description": "是否显示地名", "defaultValue": true }, "enable-building": { "type": "boolean", "description": "是否展示建筑物", "defaultValue": true }, "bindTap": { "tsType": "() => void", "description": "点击地图时触发，e.detail = { latitude, longitude}" }, "bindMarkerTap": { "tsType": "() => void", "description": "点击标记点时触发，e.detail = {markerId, latitude, longitude}" }, "bindCallOutTap": { "tsType": "() => void", "description": "点击标记点对应的气泡时触发, e.detail = {markerId}" }, "bindRegionChange": { "tsType": "() => void", "description": "视野发生变化时触发" }, "bindLabelTap": { "tsType": "() => void", "description": "点击 label 时触发，e.detail = {markerId}" }, "bindUpdated": { "tsType": "() => void", "description": "在地图渲染更新完成时触发" }, "bindAnchorPointTap": { "tsType": "() => void", "description": "点击定位标时触发，e.detail = {longitude, latitude}" } }, "additionalProperties": false, "required": [ "longitude", "latitude" ] } }, { "key": "movable-area", "value": { "title": "movable-area", "type": "object", "properties": { "scale-area": { "type": "boolean", "description": "当里面的 movable-view 设置为支持双指缩放时，设置此值可将缩放手势生效区域修改为整个 movable-area。", "defaultValue": false } }, "additionalProperties": false } }, { "key": "movable-view", "value": { "title": "movable-view", "type": "object", "properties": { "direction": { "type": "string", "description": "movable-view 的移动方向，属性值有 all、vertical、horizontal、none。", "defaultValue": "none" }, "inertia": { "type": "boolean", "description": "movable-view 是否带有惯性。", "defaultValue": false }, "out-of-bounds": { "type": "boolean", "description": "超过可移动区域后，movable-view 是否还可以移动。", "defaultValue": false }, "x": { "type": "number|String", "description": "定义 x 轴方向的偏移，如果 x 的值不在可移动范围内，会自动移动到可移动范围；改变 x 的值会触发动画。" }, "y": { "type": "number|String", "description": "定义 y 轴方向的偏移，如果 y 的值不在可移动范围内，会自动移动到可移动范围；改变 y 的值会触发动画。" }, "damping": { "type": "number", "description": "阻尼系数，用于控制 x 或 y 改变时的动画和过界回弹的动画，值越大移动越快。", "defaultValue": 20 }, "friction": { "type": "number", "description": "摩擦系数，用于控制惯性滑动的动画，值越大摩擦力越大，滑动越快停止；必须大于 0，否则会被设置成默认值。", "defaultValue": 2 }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false }, "scale": { "type": "boolean", "description": "是否支持双指缩放，默认缩放手势生效区域是在 movable-view 内。", "defaultValue": false }, "scale-min": { "type": "number", "description": "定义缩放倍数最小值。", "defaultValue": 0.5 }, "scale-max": { "type": "number", "description": "定义缩放倍数最大值。", "defaultValue": 10 }, "scale-value": { "type": "number", "description": "定义缩放倍数，取值范围为 0.5 ~ 10。", "defaultValue": 1 }, "animation": { "type": "boolean", "description": "是否使用动画。", "defaultValue": true }, "bindChange": { "tsType": "() => void", "description": "拖动过程中触发的事件。" }, "bindScale": { "tsType": "() => void", "description": "缩放过程中触发的事件。" }, "bindHTouchMove": { "tsType": "() => void", "description": "初次手指触摸后移动为横向的移动时触发。" }, "bindVTouchMove": { "tsType": "() => void", "description": "初次手指触摸后移动为纵向的移动时触发。" } }, "additionalProperties": false } }, { "key": "navigator", "value": { "title": "navigator", "type": "object", "properties": { "url": { "type": "string", "description": "跳转地址。" }, "delta": { "type": "number", "description": "当 open-type 为 'navigateBack' 时有效，表示回退的层数。", "defaultValue": 1 }, "open-type": { "type": "string", "description": "跳转方式，详情见 open-type 的合法值。", "defaultValue": "navigate", "enum": [ "navigate", "redirect", "switchTab", "navigateBack", "reLaunch" ] }, "hover-class": { "type": "string", "description": "指定点击时的样式类，当 hover-class=\"none\" 时，没有点击态效果类。", "defaultValue": "navigator-hover" }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒。", "defaultValue": 50 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒。", "defaultValue": 400 }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态。", "defaultValue": false } }, "additionalProperties": false, "required": [ "url" ] } }, { "key": "open-data", "value": { "title": "open-data", "type": "object", "properties": { "type": { "type": "string", "description": "开放数据类型", "enum": [ "userNickName", "userAvatarUrl", "userGender", "userCity", "userProvince", "userCountry" ] }, "default-text": { "type": "string", "description": "文本数据为空时的默认内容" }, "default-avatar": { "type": "string", "description": "用户头像为空时的默认图片，支持相对路径和网络图片路径" }, "use-empty-value": { "type": "string", "description": "当数据为空且未设置默认值时，是否显示官方默认值", "defaultValue": false }, "bindError": { "tsType": "() => void", "description": "出现错误时触发" } }, "additionalProperties": false, "required": [ "type" ] } }, { "key": "picker-view", "value": { "title": "picker-view", "type": "object", "properties": { "value": { "type": "number[]", "description": "设置选择器中被选中的元素，value[i] 表示 picker-view 内的第 i 个 picker-view-column 选中第 value[i] 项元素（下标从 0 开始）。如果 value[i] 大于 picker-view-colum 可选项长度时，选择最后一项。" }, "indicator-style": { "type": "string", "description": "设置选择器中选中框的样式。" }, "indicator-class": { "type": "string", "description": "设置选择器中间选中框的类名。" }, "mask-style": { "type": "string", "description": "设置蒙层的样式。" }, "mask-class": { "type": "string", "description": "设置蒙层的类名。" }, "immediate-change": { "type": "boolean", "description": "设置是否在手指松开时立即触发 change 事件。若将 immediate-change 设置为 false，则会在滚动动画结束时触发 change 事件。", "defaultValue": false }, "bindChange": { "tsType": "() => void", "description": "滚动选择时触发 change 事件回调。" }, "bindPickStart": { "tsType": "() => void", "description": "当滚动选择开始时触发 pickstart 事件回调。" }, "bindPickEnd": { "tsType": "() => void", "description": "当滚动动画结束时触发 pickend 事件回调（在 change 事件回调之后触发）。" } }, "additionalProperties": false, "required": [ "value" ] } }, { "key": "picker", "value": { "title": "picker", "type": "object", "properties": { "mode": { "type": "string", "description": "选择器类型，详见 mode 的合法值。", "defaultValue": "selector", "enum": [ "selector", "multiSelector", "time", "date", "region" ] }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "bindCancel": { "tsType": "() => void", "description": "取消选择收起 picker 时触发" } }, "additionalProperties": false } }, { "key": "progress", "value": { "title": "progress", "type": "object", "properties": { "percent": { "type": "number", "description": "进度", "defaultValue": 0 }, "stroke-width": { "type": "number", "description": "进度条的垂直宽度", "defaultValue": 6 }, "active-color": { "type": "string", "description": "进度条颜色", "defaultValue": "#F85959" }, "background-color": { "type": "string", "description": "未达到进度的颜色", "defaultValue": "#EBEBEB" }, "active": { "type": "boolean", "description": "进度条动画", "defaultValue": false }, "active-mode": { "type": "string", "description": "backwards：动画从头播\nforwards：动画从上次结束点接着播", "defaultValue": "backwards" }, "duration": { "type": "number", "description": "进度增加1%所需毫秒数，仅在 active 为 true 时生效", "defaultValue": 30 }, "bindActiveEnd": { "tsType": "() => void", "description": "动画完成后执行的事件，仅在 active 为 true 时执行" } }, "additionalProperties": false } }, { "key": "radio-group", "value": { "title": "radio-group", "type": "object", "properties": { "name": { "type": "string", "description": "用于 form 组件，在表单提交事件中作为提交数据的 key 值。\n\n\n" }, "bindChange": { "tsType": "() => void", "description": "radio-group 中的选中项发生变化时触发 change 事件。" } }, "additionalProperties": false } }, { "key": "radio", "value": { "title": "radio", "type": "object", "properties": { "value": { "type": "string", "description": "radio 标识。当该 radio 选中时，radio-group 的 change 事件会携带 radio 的 value。" }, "checked": { "type": "boolean", "description": "当前是否选中。", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用。", "defaultValue": false }, "color": { "type": "string", "description": "radio 的颜色，同 CSS 的 color 。", "defaultValue": "#F85959" } }, "additionalProperties": false } }, { "key": "rich-text", "value": { "title": "rich-text", "type": "object", "properties": { "nodes": { "type": "(Node|Text)[]|String", "description": "节点列表 / HTML String", "defaultValue": "[ ]" }, "space": { "type": "string", "description": "显示连续空格。\n\n有效值：\n\nensp：中文字符空格一半大小。\nemsp：中文字符空格大小。\nnbsp：根据字体设置的空格大小。" } }, "additionalProperties": false } }, { "key": "scroll-view", "value": { "title": "scroll-view", "type": "object", "properties": { "scroll-x": { "type": "boolean", "description": "允许横向滚动。", "defaultValue": false }, "scroll-y": { "type": "boolean", "description": "允许竖向滚动。", "defaultValue": false }, "scroll-with-animation": { "type": "boolean", "description": "在设置滚动条位置时使用动画过渡。", "defaultValue": false }, "upper-threshold": { "type": "number", "description": "距顶部/左边多远时（单位 px），触发 scrolltoupper 事件。", "defaultValue": 50 }, "lower-threshold": { "type": "number", "description": "距底部/右边多远时（单位 px），触发 scrolltolower 事件。", "defaultValue": 50 }, "scroll-top": { "type": "number", "description": "设置内容垂直滚动的像素数。", "defaultValue": 0 }, "scroll-left": { "type": "number", "description": "设置内容水平滚动的像素数。", "defaultValue": 0 }, "scroll-into-view": { "type": "string", "description": "值应为某子元素 id（id 不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素。" }, "bindScroll": { "tsType": "() => void", "description": "滚动时触发。" }, "bindScrollToUpper": { "tsType": "() => void", "description": "滚动到顶部/左边。" }, "bindScrollToLower": { "tsType": "() => void", "description": "滚动到底部/右边。" } }, "additionalProperties": false } }, { "key": "slider", "value": { "title": "slider", "type": "object", "properties": { "min": { "type": "number", "description": "最小值", "defaultValue": 0 }, "max": { "type": "number", "description": "最大值", "defaultValue": 100 }, "step": { "type": "number", "description": "步长，取值必须大于 0，并且可被（max-min）整除。", "defaultValue": 1 }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "value": { "type": "number", "description": "当前取值", "defaultValue": 0 }, "color": { "type": "string", "description": "背景条的颜色（请使用 background-color）", "defaultValue": "#e8e8e8" }, "selected-color": { "type": "string", "description": "已选择的颜色（请使用 active-color）", "defaultValue": "#f85959" }, "active-color": { "type": "string", "description": "已选择的颜色", "defaultValue": "#f85959" }, "background-color": { "type": "string", "description": "背景条的颜色", "defaultValue": "#e8e8e8" }, "block-size": { "type": "number", "description": "滑块的大小，取值范围为 12 ~ 28。", "defaultValue": 28 }, "block-color": { "type": "string", "description": "滑块的颜色", "defaultValue": "#ffffff" }, "show-value": { "type": "boolean", "description": "是否显示当前 value", "defaultValue": false }, "bindChange": { "tsType": "() => void", "description": "完成一次拖动后触发的事件，event.detail = {value: value}。" }, "bindChanging": { "tsType": "() => void", "description": "拖动过程中触发的事件，event.detail = {value: value}。" } }, "additionalProperties": false } }, { "key": "swiper-item", "value": { "title": "swiper-item", "type": "object", "properties": { "item-id": { "type": "string", "description": "该 swiper-item 的标识符" } }, "additionalProperties": false } }, { "key": "swiper", "value": { "title": "swiper", "type": "object", "properties": { "indicator-dots": { "type": "boolean", "description": "是否显示面板指示点。", "defaultValue": false }, "indicator-color": { "type": "string", "description": "指示点颜色。", "defaultValue": "rgba(0, 0, 0, .3)" }, "indicator-active-color": { "type": "string", "description": "当前选中的指示点颜色。", "defaultValue": "rgba(0, 0, 0, 0)" }, "autoplay": { "type": "boolean", "description": "是否自动切换。", "defaultValue": false }, "current": { "type": "number", "description": "当前选中滑块的索引。", "defaultValue": 0 }, "current-item-id": { "type": "string", "description": "当前选中滑块的组件 id，不能与 current 属性同时指定。" }, "interval": { "type": "number", "description": "自动切换时间间隔（ms）。", "defaultValue": 5000 }, "previous-margin": { "type": "string", "description": "前边距，可以用露出前一项的一小部分，支持 px 和 rpx，默认单位是 px。" }, "next-margin": { "type": "string", "description": "后边距，可用于露出后一项的一小部分，支持 px 和 rpx，默认单位是 px。" }, "display-multiple-items": { "type": "number", "description": "同时显示的滑块数量。", "defaultValue": 1 }, "duration": { "type": "number", "description": "滑动动画时长（ms）。", "defaultValue": 500 }, "circular": { "type": "boolean", "description": "是否循环播放（首尾衔接）。", "defaultValue": false }, "vertical": { "type": "boolean", "description": "滑块放置方向是否为竖直。", "defaultValue": false }, "easing-function": { "type": "string", "description": "指定 swiper 切换缓动动画类型，详情见 easing-function 的合法值。", "defaultValue": "\"default\"", "enum": [ "default", "linear", "easeInCubic", "easeOutCubic", "easeInOutCubic" ] }, "bindChange": { "tsType": "() => void", "description": "current 改变时触发。" }, "bindAnimationFinish": { "tsType": "() => void", "description": "动画结束时会触发 animationfinish 事件。" }, "bindTransition": { "tsType": "() => void", "description": "swiper-item 产生位移时触发 transition 事件。" } }, "additionalProperties": false } }, { "key": "switch", "value": { "title": "switch", "type": "object", "properties": { "checked": { "type": "boolean", "description": "是否选中", "defaultValue": false }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "type": { "type": "string", "description": "样式，详见 type 的合法值。", "defaultValue": "switch", "enum": [ "switch", "checkbox" ] }, "color": { "type": "string", "description": "switch 的颜色，同 CSS 的 color。", "defaultValue": "#f85959" }, "bindChange": { "tsType": "() => void", "description": "checked 改变时触发该事件，event.detail={value:checked}。" } }, "additionalProperties": false } }, { "key": "text", "value": { "title": "text", "type": "object", "properties": { "selectable": { "type": "boolean", "description": "是否可以选中文字。", "defaultValue": false }, "space": { "type": "string", "description": "是否显示连续的空格，可以取值ensp emsp nbsp，详见 space 的合法值。", "enum": [ "ensp", "emsp", "nbsp" ] }, "decode": { "type": "boolean", "description": "是否转义。", "defaultValue": false } }, "additionalProperties": false } }, { "key": "textarea", "value": { "title": "textarea", "type": "object", "properties": { "value": { "type": "string", "description": "输入框的内容" }, "placeholder": { "type": "string", "description": "输入框为空时占位符" }, "placeholder-style": { "type": "string", "description": "指定 placeholder 的样式，只支持 font-size、font-weight、color 三个 CSS 特性。" }, "placeholder-class": { "type": "string", "description": "指定 placeholder 的样式类" }, "disabled": { "type": "boolean", "description": "是否禁用", "defaultValue": false }, "maxlength": { "type": "number", "description": "最大输入长度，设置为 -1 的时候不限制最大长度。", "defaultValue": 140 }, "focus": { "type": "boolean", "description": "是否获得焦点，详情见 Bug & Tip。", "defaultValue": false }, "auto-height": { "type": "boolean", "description": "是否自动增高，设置 auto-height 时，设置 height 样式不生效。", "defaultValue": false }, "cursor-spacing": { "type": "number", "description": "指定软键盘弹出时，与光标的距离是多少，单位是 px。", "defaultValue": 0 }, "cursor": { "type": "number", "description": "指定 focus 时的光标位置，详情见光标位置说明。", "defaultValue": -1 }, "selection-start": { "type": "number", "description": "指定 focus 时选中片段的起始位置，详情见光标位置说明。", "defaultValue": -1 }, "selection-end": { "type": "number", "description": "指定 focus 时选中片段的结束位置，详情见光标位置说明，", "defaultValue": -1 }, "adjust-position": { "type": "boolean", "description": "键盘弹起时，是否自动上推页面。", "defaultValue": true }, "hold-keyboard": { "type": "boolean", "description": "focus 时，点击页面的时候不收起键盘。", "defaultValue": false }, "disable-default-padding": { "type": "boolean", "description": "是否去掉 iOS 下的默认内边距。", "defaultValue": true }, "confirm-type": { "type": "string", "description": "设置键盘右下角按钮的文字，详情见 confirm-type 的合法值。", "defaultValue": "return", "enum": [ "send", "search", "next", "go", "done", "return" ] }, "confirm-hold": { "type": "boolean", "description": "点击键盘右下角按钮时是否保持键盘不收起。", "defaultValue": false }, "show-confirm-bar": { "type": "boolean", "description": "是否显示键盘上方带有”完成“按钮那一栏。", "defaultValue": true }, "bindInput": { "tsType": "() => void", "description": "键盘输入时触发，详情见 bindinput 说明。" }, "bindFocus": { "tsType": "() => void", "description": "输入框聚焦时触发，详情见 bindfocus 说明。" }, "bindBlur": { "tsType": "() => void", "description": "输入框失去焦点时触发，详情见 bindblur 说明。" }, "bindConfirm": { "tsType": "() => void", "description": "用户点击键盘的完成按钮时触发，详情见 bindconfirm 说明。" }, "bindLineChange": { "tsType": "() => void", "description": "输入框行数变化时触发，详情见 bindlinechange 说明。" }, "bindKeyboardHeightChange": { "tsType": "() => void", "description": "键盘高度发生变化的时候触发此事件，详情见 bindkeyboardheightchange 说明。" } }, "additionalProperties": false } }, { "key": "video", "value": { "title": "video", "type": "object", "properties": { "src": { "type": "string", "description": "要播放的视频资源地址。需要保证 src 和 definition 中有一个为必填，若同时设置了 src 和 definition，definition 优先级高于 src。" }, "autoplay": { "type": "boolean", "description": "是否自动播放。", "defaultValue": false }, "poster": { "type": "string", "description": "视频封面的图片网络资源地址。" }, "loop": { "type": "boolean", "description": "是否循环播放。", "defaultValue": false }, "show-fullscreen-btn": { "type": "boolean", "description": "是否显示全屏按钮。", "defaultValue": true }, "show-play-btn": { "type": "boolean", "description": "是否显示播放、暂停、重播按钮，不包括视频封面的播放按钮。", "defaultValue": true }, "controls": { "type": "boolean", "description": "是否显示全部播放控件。", "defaultValue": true }, "object-fit": { "type": "string", "description": "当视频大小与 video 容器大小不一致时，视频的表现形式。\n\ncontain（包含）\nfill（填充）\ncover（覆盖）", "defaultValue": "contain", "enum": [ "contain", "fill", "cover" ] }, "play-btn-position": { "type": "string", "description": "播放按钮的位置。\n\ncenter（视频中间）\nbottom（控制条上）", "defaultValue": "center", "enum": [ "center", "bottom" ] }, "pre-roll-unit-id": { "type": "string", "description": "前贴广告的 unit id，仅头条支持" }, "post-roll-unit-id": { "type": "string", "description": "后贴广告的 unit id，仅头条支持" }, "vslide-gesture": { "type": "boolean", "description": "在非全屏模式下，是否开启亮度与音量调节手势，开启后表现详见手势响应-亮度与音量。", "defaultValue": false }, "vslide-gesture-in-fullscreen": { "type": "boolean", "description": "在全屏模式下，是否开启亮度与音量调节手势，开启后表现详见手势响应-亮度与音量。", "defaultValue": true }, "enable-progress-gesture": { "type": "boolean", "description": "是否开启控制进度的手势，开启后表现详见手势响应-播放进度。", "defaultValue": false }, "enable-play-gesture": { "type": "boolean", "description": "是否开启播放手势，即双击切换播放/暂停。", "defaultValue": false }, "muted": { "type": "boolean", "description": "是否静音播放。", "defaultValue": false }, "show-mute-btn": { "type": "boolean", "description": "是否显示静音控件，仅在全屏时显示。", "defaultValue": false }, "show-playback-rate-btn": { "type": "boolean", "description": "是否显示倍速控件，仅在全屏时显示。点击倍速控件后可选择倍速，可选值： 0.75/1.0/1.25/1.5/2。", "defaultValue": false }, "direction": { "type": "number", "description": "设置全屏时视频的方向，详见 direction 的合法值。", "defaultValue": -90, "enum": [ "0", "90", "-90" ] }, "enable-play-in-background": { "type": "boolean", "description": "video 播放时宿主退出后台后开启小窗播放，iOS 14 及以上版本支持。开启时首次退出后台后给予弹窗提示用户授权，授权完成后可以到小程序「设置」中重设。支持场景见后台小窗播放。", "defaultValue": false }, "signature": { "type": "signature", "description": "设置署名水印，属性说明详见 Signature 类型说明。" }, "initial-time": { "type": "number", "description": "指定视频的初始播放位置。", "defaultValue": 0 }, "show-screen-lock-button": { "type": "boolean", "description": "是否展示锁屏按钮，仅在全屏时展示，锁屏后会锁定播控/手势的操作。", "defaultValue": false }, "definition": { "type": "definition", "description": "清晰度，设置清晰度列表和默认播放的清晰度。切换清晰度按钮仅在全屏时展示，属性说明详见 Definition 类型说明。需要保证 src 和 definition 中有一个为必填，若同时设置了 src 和 definition，definition 优先级高于 src。" }, "bindPlay": { "tsType": "() => void", "description": "当开始播放时触发 play 事件。" }, "bindPause": { "tsType": "() => void", "description": "当暂停播放时触发 pause 事件。" }, "bindEnded": { "tsType": "() => void", "description": "当播放到末尾时触发 ended 事件。" }, "bindError": { "tsType": "() => void", "description": "视频播放出错时触发 error 事件。" }, "bindTimeUpdate": { "tsType": "() => void", "description": "播放进度变化时触发，返回当前播放时间点及视频总时长，单位：秒(s)。event.detail = { currentTime, duration }。" }, "bindProgress": { "tsType": "() => void", "description": "视频缓冲进度更新时触发，event.detail = { buffered }。其中 buffered 是百分比，取值是 [0, 100] 中的整数，如 buffered 为 50 表示当前视频缓冲了 50%。" }, "bindFullScreenChange": { "tsType": "() => void", "description": "视频进入和退出全屏时触发。" }, "bindWaiting": { "tsType": "() => void", "description": "视频出现缓冲时触发。" }, "bindAdStart": { "tsType": "() => void", "description": "贴片广告开始播放时触发，event.detail = { adType: 'preRollAd' | 'postRollAd' }。" }, "bindAdEnded": { "tsType": "() => void", "description": "贴片广告播放结束时触发，event.detail = { adType: 'preRollAd' | 'postRollAd' }。" }, "bindAdLoad": { "tsType": "() => void", "description": "贴片广告加载成功时触发，event.detail = { adType: 'preRollAd' | 'postRollAd' }。" }, "bindAdClose": { "tsType": "() => void", "description": "贴片广告非自然结束时触发，如：用户关闭广告或广告播放过程中 video 组件被销毁，event.detail = { adType: 'preRollAd' | 'postRollAd' }。" }, "bindAdError": { "tsType": "() => void", "description": "贴片广告加载失败时触发，event.detail = { adType: 'preRollAd' | 'postRollAd' }。" }, "bindLoadedMetaData": { "tsType": "() => void", "description": "视频元数据加载完成时触发。event.detail = {width, height, duration}。" }, "bindSeekComplete": { "tsType": "() => void", "description": "seek 完成时触发。返回 seek 完成后的播放时间点，单位：秒(s)。event.detail={position}。" }, "bindPlayBackRateChange": { "tsType": "() => void", "description": "视频倍速改变完成时触发。返回改变后的倍速值。event.detail={playbackRate}。" }, "bindMuteChange": { "tsType": "() => void", "description": "静音状态改变完成时触发。返回当前是否静音。event.detail={isMuted}。" }, "bindControlTap": { "tsType": "() => void", "description": "点击控件时触发。返回当前点击的控件类型。event.detail={controlType}，取值见表 controlType 的合法值。" }, "bindEnterBackground": { "tsType": "() => void", "description": "进入小窗播放时触发。" }, "bindCloseBackground": { "tsType": "() => void", "description": "关闭小窗播放时触发。" }, "bindLeaveBackground": { "tsType": "() => void", "description": "离开小窗进入 app 事件时触发。" } }, "additionalProperties": false } }, { "key": "view", "value": { "title": "view", "type": "object", "properties": { "hover-class": { "type": "string", "description": "指定按下去的样式类。当 hover-class=\"none\" 时，没有点击态效果。", "defaultValue": "none" }, "hover-stop-propagation": { "type": "boolean", "description": "指定是否阻止本节点的祖先节点出现点击态。", "defaultValue": false }, "hover-start-time": { "type": "number", "description": "按住后多久出现点击态，单位毫秒。", "defaultValue": 50 }, "hover-stay-time": { "type": "number", "description": "手指松开后点击态保留时间，单位毫秒。", "defaultValue": 400 } }, "additionalProperties": false } }, { "key": "web-view", "value": { "title": "web-view", "type": "object", "properties": { "src": { "type": "string", "description": "组件指向网页的链接。网页链接需登录字节小程序开发者平台配置业务域名。只支持 https 和 wss 协议。" }, "progressbar-color": { "type": "string", "description": "webview 的进度条颜色", "defaultValue": "#51a0d8" }, "type": { "type": "string", "description": "若使用web-view组件引入第三方客服，必须填写type=\"im\"", "defaultValue": "default" }, "bindMessage": { "tsType": "() => void", "description": "当网页通过 tt.miniProgram.postMessage 向小程序 postMessage 时，bindmessage 绑定的方法会在小程序的特定时机（小程序后退、组件销毁、分享）触发并收到消息。" }, "bindLoad": { "tsType": "() => void", "description": "当网页加载完成时触发的消息" }, "bindError": { "tsType": "() => void", "description": "当网页加载失败时触发的消息" } }, "additionalProperties": false, "required": [ "src" ] } } ] } ]