低代码高性能原生UI框架

Appearance

本页导读

Scroll ​

组件类型：UxScrollComponentPublicInstance

扩展支持自定义下拉刷新、上拉加载自定义样式，可显示返回顶部按钮

平台兼容性 ​

UniApp X ​

AndroidiOSweb鸿蒙 Next小程序
√√√x√

UniApp Vue Nvue ​

AndroidiOSweb鸿蒙 Next小程序
xx√xx

Props ​

属性名类型默认值说明
defaultSlot默认插槽
refresherSlotrefresher插槽
loadmoreSlotloadmore插槽
backtopSlotbacktop插槽
typeString渲染模式
directionStringvertical滚动方向，可取值none、all、horizontal、vertical
associativeContainerString关联的滚动容器
enableBackToTopBooleanfalseiOS点击顶部状态栏滚动条返回顶部，只支持竖向
bouncesBooleantrue控制是否回弹效果
upperThresholdNumber50距顶部/左边多远时(单位px)，触发scrolltoupper事件
lowerThresholdNumber50距底部/右边多远时(单位px)，触发scrolltolower事件
scrollTopNumber0设置竖向滚动条位置
scrollLeftNumber0设置横向滚动条位置
scrollIntoViewString值应为某子元素id(id不能以数字开头)。设置哪个方向可滚动，则在哪个方向滚动到该元素
scrollWithAnimationBooleantrue是否在设置滚动条位置时使用滚动动画，设置false没有滚动动画
refresherEnabledBooleanfalse开启下拉刷新
refresherThresholdNumber45设置下拉刷新阈值
refresherMaxDragDistanceNumber80设置下拉最大拖拽距离(单位px)
refresherBackgroundStringtransparent设置下拉刷新区域背景颜色
refresherTriggeredBooleanfalse设置当前下拉刷新状态，true表示下拉刷新已经被触发，false表示下拉刷新未被触发
refresherStatesArray下拉刷新状态文案
loadmoreEnabledBooleanfalse开启上拉加载
loadmoreStatesArray上拉加载状态文案
showScrollbarBooleanfalse控制是否出现滚动条
customNestedScrollBooleanfalse子元素是否开启嵌套滚动将滚动事件与父元素协商处理
openStartnestedscrollBooleanfalse与子元素开启滚动协商
nestedScrollChildString嵌套滚动子元素的id属性，不支持ref，scroll-view惯性滚动时会让对应id元素视图进行滚动，子元素滚动时会触发scroll-view的nestedprescroll事件，嵌套子元素需要设置custom-nested-scroll=true
backtopBooleanfalse显示返回顶部
placeholderBooleanfalse底部导航栏高度占位
disabledBooleanfalse禁止滚动
backgroundStringtransparent背景颜色
xstyleArray自定义样式

type ​

值说明
nested嵌套模式。用于处理父子scroll-view间的嵌套滚动，子节点只能是nested-scroll-headernested-scroll-body组件或自定义refresher

direction ​

值说明
none无
all全部
horizontal水平
vertical垂直

associativeContainer ​

值说明
nested-scroll-view嵌套滚动

Events ​

事件名说明参数
refresherpulling下拉刷新控件被下拉
refresherrefresh下拉刷新被触发
refresherrestore下拉刷新被复位
refresherabort下拉刷新被中止
loadmore上拉加载触发
scrolltoupper滚动到顶部/左边，会触发scrolltoupper事件
scrolltolower滚动到底部/右边，会触发scrolltolower事件
scroll滚动时触发
scrollend滚动结束时触发
startnestedscroll子元素开始滚动时触发,returnture表示与子元素开启滚动协商默认returnfalse
nestedprescroll子元素滚动时触发
stopnestedscroll子元素滚动结束或意外终止时触发

示例代码 ​

html
<template>
	<ux-page :stack="showDoc">
		<ux-navbar :title="title" :border="false">
			<template v-slot:right>
				<!-- #ifndef MP -->
				<ux-button theme="text" icon="/static/tip.png" :icon-size="22" @click="onDoc()"></ux-button>
				<!-- #endif -->
			</template>
		</ux-navbar>
		
		<ux-scroll
			ref="uxScrollRef"
			:refresherEnabled="true" 
			:refresherTriggered="refresherTriggered" 
			:loadmoreEnabled="loadmoreEnabled" 
			:backtop="true"
			@refresherrefresh="onRefresh"
			@loadmore="onLoadmore">
			
			<ux-card direction="column" icon="flag-filled" title="Scroll列表" :bold="true">
				<ux-text text="扩展支持自定义下拉刷新、上拉加载自定义样式，可显示返回顶部按钮"></ux-text>
			</ux-card>
			
			<ux-card v-for="(item, index) in list" :key="index">
				<ux-row :flex="true">
					<ux-image :radius="5" :src="item['cover']"></ux-image>
					<ux-col :ml="10">
						<ux-text :bold="true" :size="15" :text="item['author_name']"></ux-text>
						<ux-text :text="item['title']"></ux-text>
						<ux-text :text="item['published_at']"></ux-text>
					</ux-col>
				</ux-row>
			</ux-card>
		</ux-scroll>
	</ux-page>
</template>
<template>
	<ux-page :stack="showDoc">
		<ux-navbar :title="title" :border="false">
			<template v-slot:right>
				<!-- #ifndef MP -->
				<ux-button theme="text" icon="/static/tip.png" :icon-size="22" @click="onDoc()"></ux-button>
				<!-- #endif -->
			</template>
		</ux-navbar>
		
		<ux-scroll
			ref="uxScrollRef"
			:refresherEnabled="true" 
			:refresherTriggered="refresherTriggered" 
			:loadmoreEnabled="loadmoreEnabled" 
			:backtop="true"
			@refresherrefresh="onRefresh"
			@loadmore="onLoadmore">
			
			<ux-card direction="column" icon="flag-filled" title="Scroll列表" :bold="true">
				<ux-text text="扩展支持自定义下拉刷新、上拉加载自定义样式，可显示返回顶部按钮"></ux-text>
			</ux-card>
			
			<ux-card v-for="(item, index) in list" :key="index">
				<ux-row :flex="true">
					<ux-image :radius="5" :src="item['cover']"></ux-image>
					<ux-col :ml="10">
						<ux-text :bold="true" :size="15" :text="item['author_name']"></ux-text>
						<ux-text :text="item['title']"></ux-text>
						<ux-text :text="item['published_at']"></ux-text>
					</ux-col>
				</ux-row>
			</ux-card>
		</ux-scroll>
	</ux-page>
</template>
ts
<script setup>
	
	
	import * as plus from '@/uni_modules/ux-plus'
	
	const title = ref('')
	const list = ref<UTSJSONObject[]>([] as UTSJSONObject[])
	const refresherTriggered = ref(false)
	const lastPage = ref(false)
	
	const uxScrollRef = ref<UxScrollComponentPublicInstance | null>(null)
	
	const loadmoreEnabled = computed((): boolean => {
		return list.value.length >= 10
	})
	
	function getList(refresh: boolean) {
		if(refresh) {
			lastPage.value = false
			refresherTriggered.value = true
		}
		
		if(list.value.length == 0) {
			uni.showLoading({
				title: 'loading...'
			})
		}
		
		uni.request<UTSJSONObject[]>({
			url: 'https://unidemo.dcloud.net.cn/api/news?column=title,author_name,cover,published_at',
			method:"GET",
			success: (res) => {
				if (res.statusCode == 200) {
					const result = res.data
					
					if(result != null){
						if(refresh) {
							list.value = result
						} else {
							if(list.value.length > 50) {
								lastPage.value = true
							} else {
								list.value = list.value.concat(result)
							}
						}
					}
				}
			},
			complete:() => {
				uni.hideLoading()
				
				if(refresh) {
					refresherTriggered.value = false
				}
				
				uxScrollRef.value!.loadSuccess(lastPage.value)
			}
		});
	}
	
	function onRefresh() {
		getList(true)
	}
	
	function onLoadmore() {
		getList(false)
	}
	
	const showDoc = ref(false)
	
	function onDoc() {
		plus.openWeb({
			title: '在线文档',
			url: 'https://www.uxframe.cn/component/scroll.html',
			// blur: 1,
			success: () => {
				showDoc.value = true
			},
			complete: () => {
				showDoc.value = false
			}
		})
	}
	
	onLoad((e) => {
		title.value = e['title'] ?? ''
		
		getList(false)
	})
</script>
<script setup>
	
	
	import * as plus from '@/uni_modules/ux-plus'
	
	const title = ref('')
	const list = ref<UTSJSONObject[]>([] as UTSJSONObject[])
	const refresherTriggered = ref(false)
	const lastPage = ref(false)
	
	const uxScrollRef = ref<UxScrollComponentPublicInstance | null>(null)
	
	const loadmoreEnabled = computed((): boolean => {
		return list.value.length >= 10
	})
	
	function getList(refresh: boolean) {
		if(refresh) {
			lastPage.value = false
			refresherTriggered.value = true
		}
		
		if(list.value.length == 0) {
			uni.showLoading({
				title: 'loading...'
			})
		}
		
		uni.request<UTSJSONObject[]>({
			url: 'https://unidemo.dcloud.net.cn/api/news?column=title,author_name,cover,published_at',
			method:"GET",
			success: (res) => {
				if (res.statusCode == 200) {
					const result = res.data
					
					if(result != null){
						if(refresh) {
							list.value = result
						} else {
							if(list.value.length > 50) {
								lastPage.value = true
							} else {
								list.value = list.value.concat(result)
							}
						}
					}
				}
			},
			complete:() => {
				uni.hideLoading()
				
				if(refresh) {
					refresherTriggered.value = false
				}
				
				uxScrollRef.value!.loadSuccess(lastPage.value)
			}
		});
	}
	
	function onRefresh() {
		getList(true)
	}
	
	function onLoadmore() {
		getList(false)
	}
	
	const showDoc = ref(false)
	
	function onDoc() {
		plus.openWeb({
			title: '在线文档',
			url: 'https://www.uxframe.cn/component/scroll.html',
			// blur: 1,
			success: () => {
				showDoc.value = true
			},
			complete: () => {
				showDoc.value = false
			}
		})
	}
	
	onLoad((e) => {
		title.value = e['title'] ?? ''
		
		getList(false)
	})
</script>
css
<style lang="scss">
	
</style>
<style lang="scss">
	
</style>