ScrollView

可滚动视图区域。使用竖向滚动时，需要给scroll-view一个固定高度，通过 WXSS 设置 height。组件属性的长度单位默认为 px

Tips: H5 中 ScrollView 组件是通过一个高度（或宽度）固定的容器内部滚动来实现的，因此务必正确的设置容器的高度。例如: 如果 ScrollView 的高度将 body 撑开，就会同时存在两个滚动条（body 下的滚动条，以及 ScrollView 的滚动条）。 微信小程序 中 ScrollView 组件如果设置 scrollX 横向滚动时，并且子元素为多个时（单个子元素时设置固定宽度则可以正常横向滚动），需要通过 WXSS 设置 white-space: nowrap 来保证元素不换行，并对 ScrollView 内部元素设置 display: inline-block 来使其能够横向滚动。

参考文档

类型

ComponentType<ScrollViewProps>

示例代码

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',
      'background-color': 'rgb(26, 173, 25)'
    }
    const vStyleB = {
       height: '150px',
      'background-color': 'rgb(39,130,215)'
    }
    const vStyleC = {
      height: '150px',
      'background-color': '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>
    )
  }
}

ScrollViewProps

参数	类型	默认值	必填	说明
scrollX	boolean	fasle	否	允许横向滚动
scrollY	boolean	fasle	否	允许纵向滚动
upperThreshold	number	50	否	距顶部/左边多远时（单位px），触发 scrolltoupper 事件
lowerThreshold	number	50	否	距底部/右边多远时（单位px），触发 scrolltolower 事件
scrollTop	number		否	设置竖向滚动条位置
scrollLeft	number		否	设置横向滚动条位置
scrollIntoView	string		否	值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素
scrollWithAnimation	boolean	fasle	否	在设置滚动条位置时使用动画过渡
enableBackToTop	boolean	fasle	否	iOS 点击顶部状态栏、安卓双击标题栏时，滚动条返回顶部，只支持竖向
enableFlex	boolean	fasle	否	启用 flexbox 布局。开启后，当前节点声明了 display: flex 就会成为 flex container，并作用于其孩子节点。
scrollAnchoring	boolean	fasle	否	开启 scroll anchoring 特性，即控制滚动位置不随内容变化而抖动，仅在 iOS 下生效，安卓下可参考 CSS overflow-anchor 属性。
refresherEnabled	boolean	fasle	否	开启自定义下拉刷新
refresherThreshold	number	45	否	设置自定义下拉刷新阈值
refresherDefaultStyle	string	'black'	否	设置自定义下拉刷新默认样式，支持设置 black | white | none， none 表示不使用默认样式
refresherBackground	string	'#FFF'	否	设置自定义下拉刷新区域背景颜色
refresherTriggered	boolean	fasle	否	设置当前下拉刷新状态，true 表示下拉刷新已经被触发，false 表示下拉刷新未被触发
onScrollToUpper	(event: BaseEventOrigFunction<any>) => any		否	滚动到顶部/左边，会触发 scrolltoupper 事件
onScrollToLower	(event: BaseEventOrigFunction<any>) => any		否	滚动到底部/右边，会触发 scrolltolower 事件
onScroll	(event: BaseEventOrigFunction<onScrollDetail>) => any		否	滚动时触发 event.detail = { scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY}
onRefresherPulling	(event: BaseEventOrigFunction<any>) => any		否	自定义下拉刷新控件被下拉
onRefresherRefresh	(event: BaseEventOrigFunction<any>) => any		否	自定义下拉刷新被触发
onRefresherRestore	(event: BaseEventOrigFunction<any>) => any		否	自定义下拉刷新被复位
onRefresherAbort	(event: BaseEventOrigFunction<any>) => any		否	自定义下拉刷新被中止

API 支持度

API	微信小程序	百度小程序	支付宝小程序	抖音小程序	H5	React Native
ScrollViewProps.scrollX	✔️	✔️	✔️	✔️	✔️	✔️(二选一)
ScrollViewProps.scrollY	✔️	✔️	✔️	✔️	✔️	✔️(二选一)
ScrollViewProps.upperThreshold	✔️	✔️	✔️	✔️	✔️	✔️
ScrollViewProps.lowerThreshold	✔️	✔️	✔️	✔️	✔️	✔️
ScrollViewProps.scrollTop	✔️	✔️	✔️	✔️	✔️	✔️
ScrollViewProps.scrollLeft	✔️	✔️	✔️	✔️	✔️	✔️
ScrollViewProps.scrollIntoView	✔️	✔️	✔️	✔️	✔️
ScrollViewProps.scrollWithAnimation	✔️	✔️	✔️	✔️	✔️	✔️
ScrollViewProps.enableBackToTop	✔️		✔️			✔️
ScrollViewProps.enableFlex	✔️
ScrollViewProps.scrollAnchoring	✔️
ScrollViewProps.refresherEnabled	✔️
ScrollViewProps.refresherThreshold	✔️
ScrollViewProps.refresherDefaultStyle	✔️
ScrollViewProps.refresherBackground	✔️
ScrollViewProps.refresherTriggered	✔️
ScrollViewProps.onScrollToUpper	✔️	✔️	✔️	✔️	✔️	✔️
ScrollViewProps.onScrollToLower	✔️	✔️	✔️	✔️	✔️	✔️
ScrollViewProps.onScroll	✔️	✔️	✔️	✔️	✔️	✔️
ScrollViewProps.onRefresherPulling	✔️
ScrollViewProps.onRefresherRefresh	✔️
ScrollViewProps.onRefresherRestore	✔️
ScrollViewProps.onRefresherAbort	✔️

onScrollDetail

参数	类型	说明
scrollLeft	number	横向滚动条位置
scrollTop	number	竖向滚动条位置
scrollHeight	number	滚动条高度
scrollWidth	number	滚动条宽度
deltaX	number
deltaY	number