mand-mobile/components/scroll-view
xuxiaoyan cc954a3e3b example: update demo height 2018-09-13 11:19:46 +08:00
..
demo example: update demo height 2018-09-13 11:19:46 +08:00
test feature(scroll-view):complete scroll-view readme & test 2018-07-12 17:44:42 +08:00
README.en-US.md feat(scroll-view): add header/footer slot[#188] 2018-08-28 11:23:44 +08:00
README.md feat(scroll-view): add header/footer slot[#188] 2018-08-28 11:23:44 +08:00
index.vue feat(scroll-view): add header/footer slot[#188] 2018-08-28 11:23:44 +08:00
more.vue feature(scroll-view):complete scroll-view readme & test 2018-07-12 17:44:42 +08:00
refresh.vue feature(scroll-view):complete scroll-view readme & test 2018-07-12 17:44:42 +08:00

README.en-US.md

title preview
ScrollView https://didi.github.io/mand-mobile/examples/#/scroll-view

Used to simulate native scrolling areas and support pull-down refresh and load more 1.5.0+

Import

import { ScrollView, ScrollViewRefresh, ScrollViewMore } from 'mand-mobile'

Vue.component(ScrollView.name, ScrollView)

Instruction

ScrollViewRefresh is a pull-down refresh component built into the component library for visual display only. It needs to be used in the slot refresh. The pull-down refresh component can also be customized.

ScrollViewMore load-more component built into the component library for visual display only. It needs to be used in slot more. The load-more component can also be customized.

Code Examples

API

ScrollView Props

Props Description Type Default Note
scrolling-x horizontal scrolling Boolean true -
scrolling-y vertical scrolling Boolean true -
bouncing - Boolean true -
autoReflow 1.5.3+ automatically reset scroller size when content changes Boolean false manually call reflowScroller when set to false
endReachedThreshold threshold for emitting endReached. Number 0 unit px

ScrollViewRefresh Props

Props Description Type Default Note
scroll-top distance from top Number 0 unit px
is-refresh-active release refreshable state Boolean false -
is-refreshing refreshing state Boolean false -
refresh-text - String 下拉刷新 -
refresh-active-text release refreshable text String 释放刷新 -
refreshing-text refreshing text String 刷新中... -

ScrollViewMore Props

Props Description Type Default Note
is-finished all loaded Boolean false -
loading-text loading text String 更多加载中... -
finished-text loaded text String 全部已加载 -

ScrollView Slots

default

Scrolling area content slot. When the content changes, you need to call reflowScroller to reset the scroll area. Refer to reflowScroller

refresh

Pull-down refresh component slot, you can use slot-scoped to get the relevant scrolling status as follows (the scrolling state can also be dynamically set by event when the slot-scoped is not compatible)

<md-scroll-view-refresh
  slot="refresh"
  slot-scope="{ scrollTop, isRefreshActive, isRefreshing }"
  :scroll-top="scrollTop"
  :is-refreshing="isRefreshing"
  :is-refresh-active="isRefreshActive"
></md-scroll-view-refresh>
more

load-more component slot

header

header slot

footer slot

ScrollView Methods

reflowScroller()

Reset the scroll area, which needs to be called after the content in the general scroll area changes.

scrollTo(left, top, animate = false)

Scroll to the specified location

Parameters Description Type
left distance from left Number
top distance from top Number
animate using animation Boolean
triggerRefresh()
finishRefresh()
finishLoadMore()

ScrollView Events

@scroll({scrollLeft, scrollTop})

Scrolling event

Props Description Type
scrollLeft distance from left Number
scrollTop distance from top Number
@refreshActive()

Release refreshable event

@refreshing()

Refreshing event

@endReached()

Reached end event