From d8cf7fd4bf485c8843fcbcd92de7cc70f0368085 Mon Sep 17 00:00:00 2001 From: qiang Date: Fri, 22 Oct 2021 20:28:15 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E9=A3=9E=E4=B9=A6?= =?UTF-8?q?=E5=B0=8F=E7=A8=8B=E5=BA=8F=E7=BB=84=E4=BB=B6=E5=85=BC=E5=AE=B9?= =?UTF-8?q?=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/component/ad.md | 4 ++-- docs/component/button.md | 4 ++-- docs/component/canvas.md | 6 +++--- docs/component/live-player.md | 6 +++--- docs/component/native-component.md | 4 ++-- docs/component/navigator.md | 2 +- docs/component/picker-view.md | 4 ++-- docs/component/swiper.md | 10 +++++----- docs/component/switch.md | 2 +- docs/component/textarea.md | 2 +- docs/component/video.md | 18 +++++++++--------- docs/component/web-view.md | 4 ++-- 12 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/component/ad.md b/docs/component/ad.md index 8e66dfef9..210173c12 100644 --- a/docs/component/ad.md +++ b/docs/component/ad.md @@ -17,7 +17,7 @@ banner或信息流广告展现场景非常灵活，常见的展现场景为： **平台差异说明** -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快应用|360小程序|快手小程序| +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序|QQ小程序|快应用|360小程序|快手小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |√（2.5.2+）|x|√|x|√|√|√|x|x|√| @@ -48,7 +48,7 @@ banner或信息流广告展现场景非常灵活，常见的展现场景为： |ad-top|Number||type为feeds时广告上边距（px），必须大于0|QQ小程序| |ad-width|Number||type为feeds时广告宽度（px），默认100%，最大值为屏幕宽度，最小值为265|QQ小程序| |ad-height|Number||type为feeds时广告高度（px），最小85，最大160|QQ小程序| -|type|String|feed||QQ小程序、百度小程序、字节跳动小程序、飞书小程序、快手小程序| +|type|String|feed||QQ小程序、百度小程序、字节跳动小程序、快手小程序| |@load|EventHandle||广告加载成功的回调|| |@error|EventHandle||广告加载失败的回调，event.detail = {errCode: }|| |@close|EventHandle||广告关闭的回调|| diff --git a/docs/component/button.md b/docs/component/button.md index 0a4e72436..baabbedfa 100644 --- a/docs/component/button.md +++ b/docs/component/button.md @@ -44,7 +44,7 @@ |值|说明| |:-|:-| -|primary|微信小程序、360小程序为绿色，App、H5、百度小程序、支付宝小程序、快应用为蓝色，字节跳动小程序为红色，QQ小程序为浅蓝色。如想在多端统一颜色，请改用default，然后自行写样式| +|primary|微信小程序、360小程序为绿色，App、H5、百度小程序、支付宝小程序、飞书小程序、快应用为蓝色，字节跳动小程序为红色，QQ小程序为浅蓝色。如想在多端统一颜色，请改用default，然后自行写样式| |default|白色| |warn|红色| @@ -63,7 +63,7 @@ |share|触发用户转发|微信小程序、百度小程序、支付宝小程序、字节跳动小程序、飞书小程序、QQ小程序、快手小程序 | |getUserInfo|获取用户信息，可以从@getuserinfo回调中获取到用户信息|微信小程序、百度小程序、QQ小程序、快手小程序 | |contact | 打开客服会话，如果用户在会话中点击消息卡片后返回应用，可以从 @contact 回调中获得具体信息 |微信小程序、百度小程序| -|getPhoneNumber | 获取用户手机号，可以从@getphonenumber回调中获取到用户信息|微信小程序、百度小程序、字节跳动小程序、飞书小程序、支付宝小程序、快手小程序。App平台另见[一键登陆](https://uniapp.dcloud.net.cn/univerify) | +|getPhoneNumber | 获取用户手机号，可以从@getphonenumber回调中获取到用户信息|微信小程序、百度小程序、字节跳动小程序、支付宝小程序、快手小程序。App平台另见[一键登陆](https://uniapp.dcloud.net.cn/univerify) | |launchApp | 小程序中打开APP，可以通过app-parameter属性设定向APP传的参数|[微信小程序](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html)、[QQ小程序](https://q.qq.com/wiki/develop/miniprogram/frame/open_ability/open_app.html)| |openSetting | 打开授权设置页 |微信小程序、百度小程序| |getAuthorize | 支持小程序授权 | 支付宝小程序 | diff --git a/docs/component/canvas.md b/docs/component/canvas.md index 00bb09341..cec1fb5f1 100644 --- a/docs/component/canvas.md +++ b/docs/component/canvas.md @@ -8,13 +8,13 @@ |:-|:-|:-|:-|:-| |type|String||指定 canvas 类型，支持 2d (2.9.0) 和 webgl|微信小程序 2.7.0+ 字节小程序1.78.0+| |canvas-id|String||canvas 组件的唯一标识符|| -|disable-scroll|Boolean|false|当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新|字节跳动小程序不支持| +|disable-scroll|Boolean|false|当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新|字节跳动小程序与飞书小程序不支持| |@touchstart|EventHandle||手指触摸动作开始|字节小程序1.78.0+| |@touchmove|EventHandle||手指触摸后移动|字节小程序1.78.0+| |@touchend|EventHandle||手指触摸动作结束|字节小程序1.78.0+| |@touchcancel|EventHandle||手指触摸动作被打断，如来电提醒，弹窗|字节小程序1.78.0+| -|@longtap|EventHandle||手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动|字节跳动小程序不支持| -|@error|EventHandle||当发生错误时触发 error 事件，detail = {errMsg: 'something wrong'}|字节跳动小程序不支持| +|@longtap|EventHandle||手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动|字节跳动小程序与飞书小程序不支持| +|@error|EventHandle||当发生错误时触发 error 事件，detail = {errMsg: 'something wrong'}|字节跳动小程序与飞书小程序不支持| **注意事项：** diff --git a/docs/component/live-player.md b/docs/component/live-player.md index 1e943ec14..fac01502b 100644 --- a/docs/component/live-player.md +++ b/docs/component/live-player.md @@ -6,9 +6,9 @@ **平台差异说明** -|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快应用|360小程序| -|:-: |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| -|x(见下)|x |√ |x |√ |√(基础库版本>=1.52.0) |√ |x |x | +|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序|飞书小程序|QQ小程序|快应用|360小程序| +|:-: |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| +|x(见下)|x |√ |x |√ |√(基础库版本>=1.52.0)|x |√ |x |x | - App的实时音视频播放，不是使用 live-player，而是直接使用 video 组件。 - H5 下可用 video 播放符合 HTML5 规范的流媒体，rtmp 等非 HTML5 标准的流媒体格式，仅在部分支持 flash 的国内手机浏览器上可播放。在 pc 浏览器上，需要安装 flash 插件才能播放 rtmp 等格式。 diff --git a/docs/component/native-component.md b/docs/component/native-component.md index 75d36b5c1..d776e09f4 100644 --- a/docs/component/native-component.md +++ b/docs/component/native-component.md @@ -16,12 +16,12 @@ H5、App的nvue页面，不存在混合渲染的情况，它们或者全部是 * [camera](/component/camera)（仅微信小程序、百度小程序支持） * [canvas](/component/canvas)（仅在微信小程序、百度小程序表现为原生组件） * [input](/component/input)（仅在微信小程序、支付宝小程序、字节跳动小程序、飞书小程序、QQ小程序中且input置焦时表现为原生组件，其中支付宝小程序的input仅为text且置焦时才表现为原生组件） -* [textarea](/component/textarea)（仅在微信小程序、百度小程序、字节跳动小程序表现为原生组件） +* [textarea](/component/textarea)（仅在微信小程序、百度小程序、字节跳动小程序、飞书小程序表现为原生组件） * [live-player](/component/live-player)（仅微信小程序、百度小程序支持，App端直接使用video组件可同时实现拉流） * [live-pusher](/component/live-pusher)（仅微信小程序、百度小程序、app-nvue支持，app-vue使用plus.video.LivePusher可实现推流） * [cover-view](/component/cover-view) * [cover-image](/component/cover-view?id=cover-image) -* [ad](/component/ad) (仅app、微信小程序、百度小程序、字节跳动小程序、飞书小程序、QQ小程序支持) +* [ad](/component/ad) (仅app、微信小程序、百度小程序、字节跳动小程序、QQ小程序支持) #### 混合渲染模式下原生组件的使用限制 diff --git a/docs/component/navigator.md b/docs/component/navigator.md index 7cac93ab4..56a05e3e3 100644 --- a/docs/component/navigator.md +++ b/docs/component/navigator.md @@ -28,7 +28,7 @@ |navigate|对应 uni.navigateTo 的功能|| |redirect|对应 uni.redirectTo 的功能|| |switchTab|对应 uni.switchTab 的功能|| -|reLaunch|对应 uni.reLaunch 的功能|字节跳动小程序不支持| +|reLaunch|对应 uni.reLaunch 的功能|字节跳动小程序与飞书小程序不支持| |navigateBack|对应 uni.navigateBack 的功能|| |exit|退出小程序，target="miniProgram"时生效|微信2.1.0+、百度2.5.2+、QQ1.4.7+| diff --git a/docs/component/picker-view.md b/docs/component/picker-view.md index 38033282e..67f7a6367 100644 --- a/docs/component/picker-view.md +++ b/docs/component/picker-view.md @@ -10,9 +10,9 @@ |:-|:-|:-|:-| |value|Array＜Number＞|数组中的数字依次表示 picker-view 内的 picker-view-column 选择的第几项（下标从 0 开始），数字大于 picker-view-column 可选项长度时，选择最后一项。|| |indicator-style|String|设置选择器中间选中框的样式|| -|indicator-class|String|设置选择器中间选中框的类名，注意页面或组件的style中写了scoped时，需要在类名前写/deep/|app-nvue和字节跳动小程序不支持| +|indicator-class|String|设置选择器中间选中框的类名，注意页面或组件的style中写了scoped时，需要在类名前写/deep/|app-nvue与字节跳动小程序与飞书小程序不支持| |mask-style|String|设置蒙层的样式|| -|mask-class|String|设置蒙层的类名|app-nvue和字节跳动小程序不支持| +|mask-class|String|设置蒙层的类名|app-nvue与字节跳动小程序与飞书小程序不支持| |@change|EventHandle|当滚动选择，value 改变时触发 change 事件，event.detail = {value: value}；value为数组，表示 picker-view 内的 picker-view-column 当前选择的是第几项（下标从 0 开始）| | |@pickstart|eventhandle|当滚动选择开始时候触发事件|微信小程序2.3.1、快手小程序| |@pickend|eventhandle|当滚动选择结束时候触发事件|微信小程序2.3.1、快手小程序| diff --git a/docs/component/swiper.md b/docs/component/swiper.md index 1e6d74346..38bd86d0c 100644 --- a/docs/component/swiper.md +++ b/docs/component/swiper.md @@ -22,18 +22,18 @@ |duration|Number|500|滑动动画时长|app-nvue不支持| |circular|Boolean|false|是否采用衔接滑动，即播放到末尾后重新回到开头|| |vertical|Boolean|false|滑动方向是否为纵向|| -|previous-margin|String|0px|前边距，可用于露出前一项的一小部分，接受 px 和 rpx 值|app-nvue、字节跳动小程序不支持| -|next-margin|String|0px|后边距，可用于露出后一项的一小部分，接受 px 和 rpx 值|app-nvue、字节跳动小程序不支持| +|previous-margin|String|0px|前边距，可用于露出前一项的一小部分，接受 px 和 rpx 值|app-nvue、字节跳动小程序、飞书小程序不支持| +|next-margin|String|0px|后边距，可用于露出后一项的一小部分，接受 px 和 rpx 值|app-nvue、字节跳动小程序、飞书小程序不支持| |acceleration|Boolean|false|当开启时，会根据滑动速度，连续滑动多屏|支付宝小程序| |disable-programmatic-animation|Boolean|false|是否禁用代码变动触发 swiper 切换时使用动画。|支付宝小程序| |display-multiple-items|Number|1|同时显示的滑块数量|app-nvue、支付宝小程序不支持| |skip-hidden-item-layout|Boolean|false|是否跳过未显示的滑块布局，设为 true 可优化复杂情况下的滑动性能，但会丢失隐藏状态滑块的布局信息|App、微信小程序| -|disable-touch|Boolean|false|是否禁止用户 touch 操作|App 2.5.5+、H5 2.5.5+、支付宝小程序、字节跳动小程序（只在初始化时有效，不能动态变更）| -|touchable|Boolean|true|是否监听用户的触摸事件，只在初始化时有效，不能动态变更|字节跳动小程序（uni-app 2.5.5+ 推荐统一使用 disable-touch）| +|disable-touch|Boolean|false|是否禁止用户 touch 操作|App 2.5.5+、H5 2.5.5+、支付宝小程序、字节跳动小程序与飞书小程序（只在初始化时有效，不能动态变更）| +|touchable|Boolean|true|是否监听用户的触摸事件，只在初始化时有效，不能动态变更|字节跳动小程序与飞书小程序（uni-app 2.5.5+ 推荐统一使用 disable-touch）| |easing-function|String|default|指定 swiper 切换缓动动画类型，有效值：default、linear、easeInCubic、easeOutCubic、easeInOutCubic|微信小程序、快手小程序| |@change|EventHandle||current 改变时会触发 change 事件，event.detail = {current: current, source: source}|| |@transition|EventHandle||swiper-item 的位置发生改变时会触发 transition 事件，event.detail = {dx: dx, dy: dy}，支付宝小程序暂不支持dx, dy|App、H5、微信小程序、支付宝小程序、字节跳动小程序、飞书小程序、QQ小程序、快手小程序| -|@animationfinish|EventHandle||动画结束时会触发 animationfinish 事件，event.detail = {current: current, source: source}|字节跳动小程序不支持| +|@animationfinish|EventHandle||动画结束时会触发 animationfinish 事件，event.detail = {current: current, source: source}|字节跳动小程序与飞书小程序不支持| change 事件返回 detail 中包含一个 source 字段，表示导致变更的原因，可能值如下： diff --git a/docs/component/switch.md b/docs/component/switch.md index 2184e2e77..7196ce75d 100644 --- a/docs/component/switch.md +++ b/docs/component/switch.md @@ -7,7 +7,7 @@ |属性名|类型|默认值|说明|平台差异说明| |:-|:-|:-|:-|:-|:-| |checked|Boolean|false|是否选中|| -|disabled|Boolean|false|是否禁用|字节跳动小程序不支持| +|disabled|Boolean|false|是否禁用|字节跳动小程序与飞书小程序不支持| |type|String|switch|样式，有效值：switch, checkbox|| |@change|EventHandle||checked 改变时触发 change 事件，event.detail={ value:checked}|| |color|Color||switch 的颜色，同 css 的 color| | diff --git a/docs/component/textarea.md b/docs/component/textarea.md index 87b262fe3..5edca3cc8 100644 --- a/docs/component/textarea.md +++ b/docs/component/textarea.md @@ -82,7 +82,7 @@ export default { - textarea 的 blur 事件会晚于页面上的 tap 事件，如果需要在 button 的点击事件获取 textarea，可以使用 form 的 @submit。 - 如果遇到 value 属性设置不生效的问题参考：[组件属性设置不生效解决办法](/vue-api?id=_4-组件属性设置不生效解决办法) -- 微信小程序、百度小程序、字节跳动小程序中，textarea是原生组件，层级高于前端组件，请勿在 scroll-view、swiper、picker-view、movable-view 中使用 textarea 组件。覆盖textarea需要使用cover-view。[详见](/component/native-component) +- 微信小程序、百度小程序、字节跳动小程序、飞书小程序中，textarea是原生组件，层级高于前端组件，请勿在 scroll-view、swiper、picker-view、movable-view 中使用 textarea 组件。覆盖textarea需要使用cover-view。[详见](/component/native-component) - 小程序端 css 动画对 textarea 组件无效。 - H5 平台只能在用户交互时修改 focus 生效。 - 如果遇到 focus 属性设置不生效的问题参考：[组件属性设置不生效解决办法](/vue-api?id=_4-组件属性设置不生效解决办法) diff --git a/docs/component/video.md b/docs/component/video.md index 06890564c..d9319807b 100644 --- a/docs/component/video.md +++ b/docs/component/video.md @@ -8,15 +8,15 @@ |src|String||要播放视频的资源地址|| |autoplay|Boolean|false|是否自动播放|| |loop|Boolean|false|是否循环播放|| -|muted|Boolean|false|是否静音播放|字节跳动小程序不支持| -|initial-time|Number||指定视频初始播放位置，单位为秒（s）。|字节跳动小程序不支持| +|muted|Boolean|false|是否静音播放|字节跳动小程序与飞书小程序不支持| +|initial-time|Number||指定视频初始播放位置，单位为秒（s）。|字节跳动小程序与飞书小程序不支持| |duration|Number||指定视频时长，单位为秒（s）。|字节跳动小程序、飞书小程序、快手小程序不支持| |controls|Boolean|true|是否显示默认播放控件（播放/暂停按钮、播放进度、时间）|快手小程序不支持| |danmu-list|Object Array||弹幕列表|字节跳动小程序、飞书小程序、快手小程序不支持| |danmu-btn|Boolean|false|是否显示弹幕按钮，只在初始化时有效，不能动态变更|字节跳动小程序、飞书小程序、快手小程序不支持| |enable-danmu|Boolean|false|是否展示弹幕，只在初始化时有效，不能动态变更|字节跳动小程序、飞书小程序、快手小程序不支持| |page-gesture|Boolean|false|在非全屏模式下，是否开启亮度与音量调节手势|微信小程序、H5| -|direction|Number||设置全屏时视频的方向，不指定则根据宽高比自动判断。有效值为 0（正常竖向）, 90（屏幕逆时针90度）, -90（屏幕顺时针90度）|H5和字节跳动小程序、快手小程序不支持| +|direction|Number||设置全屏时视频的方向，不指定则根据宽高比自动判断。有效值为 0（正常竖向）, 90（屏幕逆时针90度）, -90（屏幕顺时针90度）|H5、字节跳动小程序、飞书小程序、快手小程序不支持| |show-progress|Boolean|true|若不设置，宽度大于240时才会显示|字节跳动小程序、飞书小程序、快手小程序不支持| |show-fullscreen-btn|Boolean|true|是否显示全屏按钮|| |show-play-btn|Boolean|true|是否显示视频底部控制栏的播放按钮|| @@ -39,13 +39,13 @@ |http-cache|Boolean|true|是否对 http、https 视频源开启本地缓存。缓存策略:开启了此开关的视频源，在视频播放时会在本地保存缓存文件，如果本地缓存池已超过100M，在进行缓存前会清空之前的缓存（不适用于m3u8等流媒体协议）|App-Android 3.1.0+| |play-strategy|Number|0| 播放策略，0：普通模式，适合绝大部分视频播放场景；1：平滑播放模式（降级），增加缓冲区大小，采用open sl解码音频，避免音视频脱轨的问题，可能会降低首屏展现速度、视频帧率，出现开屏音频延迟等。 适用于高码率视频的极端场景；3： M3U8优化模式，增加缓冲区大小，提升视频加载速度和流畅度，可能会降低首屏展现速度。 适用于M3U8在线播放的场景 |App-Android 3.1.0+| |header|Object||HTTP 请求 Header|App 3.1.19+| -|@play|EventHandle||当开始/继续播放时触发play事件|字节跳动小程序不支持| -|@pause|EventHandle||当暂停播放时触发 pause 事件|字节跳动小程序不支持| -|@ended|EventHandle||当播放到末尾时触发 ended 事件|字节跳动小程序不支持| -|@timeupdate|EventHandle||播放进度变化时触发，event.detail = {currentTime, duration} 。触发频率 250ms 一次|字节跳动小程序不支持| -|@fullscreenchange|EventHandle||当视频进入和退出全屏时触发，event.detail = {fullScreen, direction}，direction取为 vertical 或 horizontal|字节跳动小程序不支持| +|@play|EventHandle||当开始/继续播放时触发play事件|字节跳动小程序与飞书小程序不支持| +|@pause|EventHandle||当暂停播放时触发 pause 事件|字节跳动小程序与飞书小程序不支持| +|@ended|EventHandle||当播放到末尾时触发 ended 事件|字节跳动小程序与飞书小程序不支持| +|@timeupdate|EventHandle||播放进度变化时触发，event.detail = {currentTime, duration} 。触发频率 250ms 一次|字节跳动小程序与飞书小程序不支持| +|@fullscreenchange|EventHandle||当视频进入和退出全屏时触发，event.detail = {fullScreen, direction}，direction取为 vertical 或 horizontal|字节跳动小程序与飞书小程序不支持| |@waiting|EventHandle||视频出现缓冲时触发|字节跳动小程序、飞书小程序、快手小程序不支持| -|@error|EventHandle||视频播放出错时触发|字节跳动小程序不支持| +|@error|EventHandle||视频播放出错时触发|字节跳动小程序与飞书小程序不支持| |@progress|EventHandle||加载进度变化时触发，只支持一段加载。event.detail = {buffered}，百分比|微信小程序、H5| |@loadedmetadata|EventHandle||视频元数据加载完成时触发。event.detail = {width, height, duration}|微信小程序、H5| |@fullscreenclick|EventHandle||视频播放全屏播放时点击事件。event.detail = { screenX:"Number类型，点击点相对于屏幕左侧边缘的 X 轴坐标", screenY:"Number类型，点击点相对于屏幕顶部边缘的 Y 轴坐标", screenWidth:"Number类型，屏幕总宽度", screenHeight:"Number类型，屏幕总高度"}|App 2.6.3+| diff --git a/docs/component/web-view.md b/docs/component/web-view.md index 21f954906..3ac1430cb 100644 --- a/docs/component/web-view.md +++ b/docs/component/web-view.md @@ -111,8 +111,8 @@ |uni.reLaunch|[reLaunch](/api/router?id=relaunch)|| |uni.switchTab|[switchTab](/api/router?id=switchtab)|| |uni.navigateBack|[navigateBack](/api/router?id=navigateback)|| -|uni.postMessage|向应用发送消息|字节跳动小程序不支持、H5 暂不支持（可以直接使用 [window.postMessage](https://developer.mozilla.org/zh-CN/docs/Web/API/Window/postMessage)）| -|uni.getEnv|获取当前环境|字节跳动小程序不支持| +|uni.postMessage|向应用发送消息|字节跳动小程序与飞书小程序不支持、H5 暂不支持（可以直接使用 [window.postMessage](https://developer.mozilla.org/zh-CN/docs/Web/API/Window/postMessage)）| +|uni.getEnv|获取当前环境|字节跳动小程序与飞书小程序不支持| ##### uni.postMessage(OBJECT) 网页向应用发送消息，在 `` 的 `message` 事件回调 `event.detail.data` 中接收消息。 -- GitLab