@tarojs/components
Version:
487 lines (486 loc) • 16.5 kB
TypeScript
import { ComponentType } from 'react'
import { BaseEventOrigFunction, CommonEventFunction, StandardProps } from './common'
interface ScrollViewProps extends StandardProps {
/** 允许横向滚动
* @default false
* @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid
* @rn 二选一
*/
scrollX?: boolean
/** 允许纵向滚动
* @default false
* @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid
* @rn 二选一
*/
scrollY?: boolean
/** 距顶部/左边多远时（单位px），触发 scrolltoupper 事件
* @default 50
* @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid
*/
upperThreshold?: number
/** 距底部/右边多远时（单位px），触发 scrolltolower 事件
* @default 50
* @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid
*/
lowerThreshold?: number
/** 设置竖向滚动条位置
* @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid
*/
scrollTop?: number
/** 设置横向滚动条位置
* @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid
*/
scrollLeft?: number
/** 值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素
* @supported weapp, alipay, swan, tt, qq, jd, h5, harmony_hybrid
*/
scrollIntoView?: string
/** 在设置滚动条位置时使用动画过渡
* @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid
* @default false
*/
scrollWithAnimation?: boolean
/** iOS 点击顶部状态栏、安卓双击标题栏时，滚动条返回顶部，只支持竖向
* @supported weapp, alipay, swan, qq, jd, rn
* @default false
*/
enableBackToTop?: boolean
/** 启用 flexbox 布局。开启后，当前节点声明了 `display: flex` 就会成为 flex container，并作用于其孩子节点。
* @supported weapp, jd
* @default false
*/
enableFlex?: boolean
/** 开启 scroll anchoring 特性，即控制滚动位置不随内容变化而抖动，仅在 iOS 下生效，安卓下可参考 CSS `overflow-anchor` 属性。
* @supported weapp
* @default false
*/
scrollAnchoring?: boolean
/** 开启自定义下拉刷新
* @supported weapp
* @default false
*/
refresherEnabled?: boolean
/** 设置自定义下拉刷新阈值
* @supported weapp
* @default 45
*/
refresherThreshold?: number
/** 设置自定义下拉刷新默认样式，支持设置 `black | white | none`， none 表示不使用默认样式
* @supported weapp
* @default 'black'
*/
refresherDefaultStyle?: string
/** 设置自定义下拉刷新区域背景颜色
* @supported weapp
* @default '#FFF'
*/
refresherBackground?: string
/** 设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发
* @supported weapp
* @default false
*/
refresherTriggered?: boolean
/** 启用 scroll-view 增强特性
* @supported weapp, swan
* @default false
*/
enhanced?: boolean
/** 使 scroll-view 下的 position sticky 特性生效，否则滚动一屏后 sticky 元素会被隐藏
* @supported weapp
* @default false
*/
usingSticky?: boolean
/** iOS 下 scroll-view 边界弹性控制 (同时开启 enhanced 属性后生效)
* @supported weapp, swan
* @default true
*/
bounces?: boolean
/** 滚动条显隐控制 (同时开启 enhanced 属性后生效)
* @supported weapp, harmony
* @default true
*/
showScrollbar?: boolean
/** 分页滑动效果 (同时开启 enhanced 属性后生效)
* @supported weapp
* @default false
*/
pagingEnabled?: boolean
/** boolean false 滑动减速速率控制 (同时开启 enhanced 属性后生效)
* @supported weapp
* @default false
*/
fastDeceleration?: boolean
/** 当 scroll-with-animation设置为 true 时，可以设置 scroll-animation-duration 来控制动画的执行时间，单位 ms。
* @supported alipay
*/
scrollAnimationDuration?: string
/** 纵向滚动时，当滚动到顶部或底部时，强制禁止触发页面滚动，仍然只触发 scroll-view 自身的滚动。
* @supported alipay
* @default false
*/
trapScroll?: string
/** 发生滚动前，对滚动方向进行判断，当方向是顶部/左边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到顶部/左边，禁止滚动。
* @supported alipay
*/
disableLowerScroll?: string
/** 发生滚动前，对滚动方向进行判断，当方向是底部/右边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到底部/右边，禁止滚动。
* @supported alipay
*/
disableUpperScroll?: string
/** 无障碍访问，（属性）元素的额外描述
* @supported qq
*/
ariaLabel?: string
/** 开启 passive 特性，能优化一定的滚动性能
* @supported weapp
* @default false
*/
enablePassive?: boolean
/** 渲染模式
* list - 列表模式。只会渲染在屏节点，会根据直接子节点是否在屏来按需渲染，若只有一个直接子节点则性能会退化
* custom - 自定义模式。只会渲染在屏节点，子节点可以是 sticky-section list-view grid-view 等组件
* nested - 嵌套模式。用于处理父子 scroll-view 间的嵌套滚动，子节点可以是 nested-scroll-header nested-scroll-body 组件或自定义 refresher
* @supported weapp, harmony
* @default 'list'
*/
type?: 'list' | 'custom' | 'nested'
/** 是否反向滚动。一般初始滚动位置是在顶部，反向滚动则是在底部。
* @supported weapp
* @default false
*/
reverse?: boolean
/** 是否对溢出进行裁剪，默认开启
* @supported weapp
* @default true
*/
clip?: boolean
/** 指定视口外渲染区域的距离，默认情况下视口外节点不渲染。指定 cache-extent 可优化滚动体验和加载速度，但会提高内存占用且影响首屏速度，可按需启用。
* @supported weapp
*/
cacheExtent?: number
/** 指定 scroll-view 触发滚动的最小拖动距离。仅在 scroll-view 和其他组件存在手势冲突时使用，可通过调整该属性使得滚动更加灵敏。
* @supported weapp
* @default 18
*/
minDragDistance?: number
/** 长度为 4 的数组，按 top、right、bottom、left 顺序指定内边距
* @supported weapp
* @default [0,0,0,0]
*/
padding?: [number, number, number, number]
/** 只 scroll-into-view 到 cacheExtent 以内的目标节点，性能更佳
* @supported weapp
* @default false
*/
scrollIntoViewWithinExtent?: boolean
/** 指定 scroll-into-view 目标节点在视口内的位置。
* start - 目标节点显示在视口开始处
* center - 目标节点显示在视口中间
* end - 目标节点显示在视口结束处
* nearest - 目标节点在就近的视口边缘显示，若节点已在视口内则不触发滚动
* @supported weapp, h5, harmony_hybrid
* @default 'start'
*/
scrollIntoViewAlignment?: 'start' | 'center' | 'end' | 'nearest'
/** 开启下拉二级能力
* @supported weapp
* @default false
*/
refresherTwoLevelEnabled?: boolean
/** 设置打开/关闭二级
* @supported weapp
* @default false
*/
refresherTwoLevelTriggered?: boolean
/** 下拉二级阈值
* @supported weapp
* @default 150
*/
refresherTwoLevelThreshold?: number
/** 滑动返回时关闭二级的阈值
* @supported weapp
* @default 80
*/
refresherTwoLevelCloseThreshold?: number
/** 处于二级状态时是否可滑动
* @supported weapp
* @default false
*/
refresherTwoLevelScrollEnabled?: boolean
/** 惯性滚动是否触发下拉刷新
* @supported weapp
* @default false
*/
refresherBallisticRefreshEnabled?: boolean
/** 即将打开二级时否定住
* @supported weapp
* @default false
*/
refresherTwoLevelPinned?: boolean
/** 滚动到顶部/左边，会触发 scrolltoupper 事件
* @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid
*/
onScrollToUpper?: CommonEventFunction
/** 滚动到底部/右边，会触发 scrolltolower 事件
* @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony_hybrid
*/
onScrollToLower?: CommonEventFunction
/** 滚动时触发
* @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid
*/
onScroll?: BaseEventOrigFunction<ScrollViewProps.onScrollDetail>
/** 滚动开始事件
* @supported weapp
*/
onScrollStart?: BaseEventOrigFunction<ScrollViewProps.onScrollDetail>
/** 滚动结束事件
* @supported weapp
*/
onScrollEnd?: BaseEventOrigFunction<ScrollViewProps.onScrollDetail>
/** 自定义下拉刷新控件被下拉
* @supported weapp
*/
onRefresherPulling?: CommonEventFunction
/** 自定义下拉刷新被触发
* @supported weapp
*/
onRefresherRefresh?: CommonEventFunction
/** 自定义下拉刷新被复位
* @supported weapp
*/
onRefresherRestore?: CommonEventFunction
/** 自定义下拉刷新被中止
* @supported weapp
*/
onRefresherAbort?: CommonEventFunction
/** 自定义下拉刷新即将触发刷新（拖动超过 refresher-threshold 时）的事件
* @supported weapp
*/
onRefresherWillRefresh?: CommonEventFunction
/** 下拉刷新状态回调
* @supported weapp
*/
onRefresherStatusChange?: CommonEventFunction<ScrollViewProps.RefresherStatusChange>
/** 滑动开始事件 (同时开启 enhanced 属性后生效)
* @supported weapp
*/
onDragStart?: CommonEventFunction<ScrollViewProps.onDragDetail>
/** 滑动事件 (同时开启 enhanced 属性后生效)
* @supported weapp
*/
onDragging?: CommonEventFunction<ScrollViewProps.onDragDetail>
/** 滑动结束事件 (同时开启 enhanced 属性后生效)
* @supported weapp
*/
onDragEnd?: CommonEventFunction<ScrollViewProps.onDragDetail>
/** 触摸动作开始。
* @supported alipay
*/
onTouchStart?: CommonEventFunction
/** 触摸后移动。
* @supported alipay
*/
onTouchMove?: CommonEventFunction
/** 触摸动作结束。
* @supported alipay
*/
onTouchEnd?: CommonEventFunction
/** 触摸动作被打断，如来电提醒、弹窗。
* @supported alipay
*/
onTouchCancel?: CommonEventFunction
}
declare namespace ScrollViewProps {
interface onScrollDetail {
/** 横向滚动条位置 */
scrollLeft: number
/** 竖向滚动条位置 */
scrollTop: number
/** 滚动条高度 */
scrollHeight: number
/** 滚动条宽度 */
scrollWidth: number
deltaX: number
deltaY: number
isDrag?: boolean
}
interface onDragDetail {
/** 横向滚动条位置 */
scrollLeft: number
/** 竖向滚动条位置 */
scrollTop: number
/** 滚动速度 */
velocity: number
}
interface RefresherStatusChange {
status: RefreshStatus
dy: number
}
const enum RefreshStatus {
// 空闲
Idle,
// 超过下拉刷新阈值，同 bind:refresherwillRefresh 触发时机
CanRefresh,
// 下拉刷新，同 bind:refresherrefresh 触发时机
Refreshing,
// 下拉刷新完成，同 bind:refresherrestore 触发时机
Completed,
// 下拉刷新失败
Failed,
// 超过下拉二级阈值
CanTwoLevel,
// 开始打开二级
TwoLevelOpening,
// 打开二级
TwoLeveling,
// 开始关闭二级
TwoLevelClosing,
}
}
/** 可滚动视图区域。使用竖向滚动时，需要给scroll-view一个固定高度，通过 WXSS 设置 height。组件属性的长度单位默认为 px
*
* Tips:
* H5 中 ScrollView 组件是通过一个高度（或宽度）固定的容器内部滚动来实现的，因此务必正确的设置容器的高度。例如: 如果 ScrollView 的高度将 body 撑开，就会同时存在两个滚动条（body 下的滚动条，以及 ScrollView 的滚动条）。
* 微信小程序 中 ScrollView 组件如果设置 scrollX 横向滚动时，并且子元素为多个时（单个子元素时设置固定宽度则可以正常横向滚动），需要通过 WXSS 设置 `white-space: nowrap` 来保证元素不换行，并对 ScrollView 内部元素设置 `display: inline-block` 来使其能够横向滚动。
* @classification viewContainer
* @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony, harmony_hybrid
* @example_react
* ```tsx
* export default class PageView extends Component {
* constructor() {
* super(...arguments)
* }
*
* onScrollToUpper() {}
*
* // or 使用箭头函数
* // onScrollToUpper = () => {}
*
* onScroll(e){
* console.log(e.detail)
* }
*
* render() {
* const scrollStyle = {
* height: '150px'
* }
* const scrollTop = 0
* const Threshold = 20
* const vStyleA = {
* height: '150px',
* 'backgroundColor': 'rgb(26, 173, 25)'
* }
* const vStyleB = {
* height: '150px',
* 'backgroundColor': 'rgb(39,130,215)'
* }
* const vStyleC = {
* height: '150px',
* 'backgroundColor': 'rgb(241,241,241)',
* color: '#333'
* }
* return (
* <ScrollView
* className='scrollview'
* scrollY
* scrollWithAnimation
* scrollTop={scrollTop}
* style={scrollStyle}
* lowerThreshold={Threshold}
* upperThreshold={Threshold}
* onScrollToUpper={this.onScrollToUpper.bind(this)} // 使用箭头函数的时候 可以这样写 `onScrollToUpper={this.onScrollToUpper}`
* onScroll={this.onScroll}
* >
* <View style={vStyleA}>A</View>
* <View style={vStyleB}>B</View>
* <View style={vStyleC}>C</View>
* </ScrollView>
* )
* }
* }
* ```
* @example_vue
* ```html
* <template>
* <view class="container">
* <view class="page-body">
* <view class="page-section">
* <view class="page-section-title">
* <text>Vertical Scroll - 纵向滚动</text>
* </view>
* <view class="page-section-spacing">
* <scroll-view :scroll-y="true" style="height: 300rpx;" `@scrolltoupper="upper" `@scrolltolower="lower" `@scroll="scroll" :scroll-into-view="toView" :scroll-top="scrollTop">
* <view id="demo1" class="scroll-view-item demo-text-1">1</view>
* <view id="demo2" class="scroll-view-item demo-text-2">2</view>
* <view id="demo3" class="scroll-view-item demo-text-3">3</view>
* </scroll-view>
* </view>
* </view>
* <view class="page-section">
* <view class="page-section-title">
* <text>Horizontal Scroll - 横向滚动</text>
* </view>
* <view class="page-section-spacing">
* <scroll-view class="scroll-view_H" :scroll-x="true" `@scroll="scroll" style="width: 100%">
* <view id="demo21" class="scroll-view-item_H demo-text-1">a</view>
* <view id="demo22" class="scroll-view-item_H demo-text-2">b</view>
* <view id="demo23" class="scroll-view-item_H demo-text-3">c</view>
* </scroll-view>
* </view>
* </view>
* </view>
* </view>
* </template>
*
* <script>
* const order = ['demo1', 'demo2', 'demo3']
* export default {
* name: 'Index',
* data() {
* return {
* scrollTop: 0,
* toView: 'demo2'
* }
* },
*
* methods: {
* upper(e) {
* console.log('upper:', e)
* },
*
* lower(e) {
* console.log('lower:', e)
* },
*
* scroll(e) {
* console.log('scroll:', e)
* }
* }
* }
* </script>
*
* <style>
* .page-section-spacing{
* margin-top: 60rpx;
* }
* .scroll-view_H{
* white-space: nowrap;
* }
* .scroll-view-item{
* height: 300rpx;
* }
* .scroll-view-item_H{
* display: inline-block;
* width: 100%;
* height: 300rpx;
* }
*
* .demo-text-1 { background: #ccc; }
* .demo-text-2 { background: #999; }
* .demo-text-3 { background: #666; }
* </style>
* ```
* @see https://developers.weixin.qq.com/miniprogram/dev/component/scroll-view.html
*/
declare const ScrollView: ComponentType<ScrollViewProps>
export { ScrollView, ScrollViewProps }