From 6640ce972b2fcb412373d0ceee8a9a69cd01a825 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=A2=81=E5=8F=99?= <11295993+yuanxu-9847@user.noreply.gitee.com> Date: Thu, 28 Jul 2022 04:50:44 +0000 Subject: [PATCH] update docs/component/swiper.md. --- docs/component/swiper.md | 198 +-------------------------------------- 1 file changed, 1 insertion(+), 197 deletions(-) diff --git a/docs/component/swiper.md b/docs/component/swiper.md index 8a2cdd7f9..7ddb7fbfc 100644 --- a/docs/component/swiper.md +++ b/docs/component/swiper.md @@ -1,197 +1 @@ -### swiper - -滑块视图容器。 - -一般用于左右滑动或上下滑动，比如banner轮播图。 - -注意滑动切换和滚动的区别，滑动切换是一屏一屏的切换。swiper下的每个swiper-item是一个滑动切换区域，不能停留在2个滑动区域之间。 - -**属性说明** - -|属性名|类型|默认值|说明|平台差异说明| -|:-|:-|:-|:-|:-| -|indicator-dots|Boolean|false|是否显示面板指示点|| -|indicator-color|Color|rgba(0, 0, 0, .3)|指示点颜色|| -|indicator-active-color|Color|#000000|当前选中的指示点颜色|| -|active-class|String||swiper-item 可见时的 class|支付宝小程序| -|changing-class|String||acceleration 设置为 {{true}} 时且处于滑动过程中，中间若干屏处于可见时的class|支付宝小程序| -|autoplay|Boolean|false|是否自动切换|| -|current|Number|0|当前所在滑块的 index|| -|current-item-id|String||当前所在滑块的 item-id ，不能与 current 被同时指定|支付宝小程序不支持| -|interval|Number|5000|自动切换时间间隔|| -|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、字节跳动小程序、飞书小程序不支持| -|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）| -|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}|字节跳动小程序与飞书小程序不支持| - -change 事件返回 detail 中包含一个 source 字段，表示导致变更的原因，可能值如下： - -- autoplay 自动播放导致swiper变化。 -- touch 用户划动引起swiper变化。 -- 其他原因将用空字符串表示。 - -**swiper做左右拖动的长列表的专项问题** -- swiper是单页组件，适合做banner图轮播和简单列表左右滑动。 -- 因为性能问题，用swiper做复杂长列表，需要较高的优化技巧以及接受一些限制。 -- 这是一个范例，[插件市场新闻模板示例](https://ext.dcloud.net.cn/plugin?id=103)，它在App端使用了nvue的原生渲染，实现高性能的左右拖动长列表；并支持可自定义的任何形式的下拉刷新。它在非App端使用的模式是只缓存左右一共3列的数据，dom中的数据过多时，它会自动释放。就是说App上，只要看过这一页，再进去时内容是还在的。而在非App上，只能做到缓存3页数据，其他页即便看过，再进去也会重新加载。并且非App的这种情况下，不再提供下拉刷新。虽然插件市场也有其他前端模拟的下拉刷新，但性能不佳。一般小程序的大厂案例里，提供左右拖长列表的，都是这种做法。 - -**Tips** - -- 如果 nvue 页面 ``@animationfinish`` 事件不能返回正确的数据，可同时监听 ``@change`` 事件。 -- 使用竖向滚动时，需要给 ```` 一个固定高度，通过 css 设置 height。 -- 注意：其中只可放置 ```` 组件，否则会导致未定义的行为。 -- 如果遇到current、current-item-id属性设置不生效的问题参考：[组件属性设置不生效解决办法](/tutorial/vue-api.html#componentsolutions) -- banner图的切换效果和指示器的样式，有多种风格可自定义，可在[uni-app插件市场](https://ext.dcloud.net.cn/search?q=%E8%BD%AE%E6%92%AD)搜索 -- 如需banner管理后台，参考uniCloud admin banner插件：[https://ext.dcloud.net.cn/plugin?id=4117](https://ext.dcloud.net.cn/plugin?id=4117) -- swiper在App的vue中、百度支付宝头条QQ小程序中，不支持内嵌video、map等原生组件。在微信基础库2.4.4起和App nvue2.1.5起支持内嵌原生组件。竖向的swiper内嵌视频可实现抖音、映客等视频垂直拖动切换效果。 -- 同时监听 change transition，开始滑动时触发transition, 放开手后，在ios平台触发顺序为 transition... change，Android/微信小程序/支付宝为 transition... change transition... - - -#### easing-function - -|值 | 说明| -|-- |-- | -|default |默认缓动函数 | -|linear |线性动画 | -|easeInCubic |缓入动画 | -|easeOutCubic |缓出动画 | -|easeInOutCubic | 缓入缓出动画 | - - - - -#### swiper-item -仅可放置在 ```` 组件中，宽高自动设置为100%。注意：宽高100%是相对于其父组件，不是相对于子组件，不能被子组件自动撑开。 - -|属性名|类型|默认值|说明| -|:-|:-|:-|:-| -|item-id|String||该 swiper-item 的标识符| - -**示例** [查看演示](https://hellouniapp.dcloud.net.cn/pages/component/swiper/swiper) - -以下示例代码，来自于[hello uni-app项目](https://github.com/dcloudio/hello-uniapp)，推荐使用HBuilderX，新建uni-app项目，选择hello uni-app模板，可直接体验完整示例。 - -::: preview https://hellouniapp.dcloud.net.cn/pages/component/swiper/swiper -> Template -```vue - - -``` -> Script -```vue - -``` -> Style -```vue - -``` -::: - +官方团队你们好，请问组件的示例展示能否将该组件的 _所有属性_ 全部使用一遍以验证属性的正确性，防止非用户原因的错误出现，建议能采纳的话，我们都会非常感谢 \ No newline at end of file -- Gitee