TabGroup
用于通过 lynx-ui 构建标签导航的可组合 Tab 原语。此软件包提供 `TabsRoot`、`TabsBar`、`TabsItem`、`TabsIndicator`,以及可选的可滑动 `TabsPanel`。Info
你可以查看源码来了解它的运行原理,也欢迎大家提 PR 来丰富其能力。
基础用法
基于数据渲染自定义标签项、同步内容、选中状态和指示器。
示例
面板
将标签栏与可滑动的数据驱动内容面板连接起来。
命令式选择
通过 ref 以平滑或立即移动的方式选中标签。
结构
组件 API
TabsRoot
Properties
childreniOSAndroidHarmony
子节点
debugLogiOSAndroidHarmony
显示调试日志。当您发现错误时,请打开此选项。
enableRTLiOSAndroidHarmony
开启 RTL 布局。
indicatorAnimationiOSAndroidHarmony
切换标签时指示器的动画配置。
initialSelectIndexiOSAndroid
指定初始显示的索引。请使用
selectTab 进行其他更新。selectBehavioriOSAndroid
控制选中标签时标签栏的滚动方式与指示器的移动方式。
'smooth' 表示动画过渡,'instant' 表示直接跳转。Events
onClickItemiOSAndroid
点击回调
onTabChangediOSAndroid
标签页更改回调
TabsBar
Properties
androidTouchSlopAndroid
Android 触摸识别模式,当处于支持 'paging' 模式的元件中时,需要开启 'paging' 模式。
bounceableiOSAndroid
启用弹性效果
bounceableOptionsiOSAndroid
弹性效果的参数
childreniOSAndroidHarmony
子节点
classNameiOSAndroidHarmony
类名
dataiOSAndroidHarmony
Tabs 的数据。
debugLogiOSAndroidHarmony
显示回弹交互的调试日志。
enableNewArchiOSAndroidHarmony
启用原生
<scroll-view> 新架构。启用后,bounceableOptions 会在 Android、iOS 和 Harmony 上使用原生回弹。Lynx SDK 4.3 及以上版本默认为 true,更早版本默认为 false。enableRTLiOSAndroidHarmony
是否在 RTL 模式下镜像水平回弹方向。
enableScrolliOSAndroidHarmony
启用滚动。
enableScrollMonitoriOSAndroidHarmony
启用滚动监控。
estimatedItemStyleiOSAndroid
需要设置 items 的预计高度和宽度。
experimentalNestedScrollBackwardHarmony
适配 Harmony 的嵌套滚动行为。'selfOnly' 表示只自身滚动,不与父组件联动。'selfFirst' 表示自身先滚动,自身滚动到边界以后父组件滚动。'parentFirst' 表示父组件先滚动,父组件滚动到边界以后自身滚动。'parallel' 表示自身和父组件同时滚动。
experimentalNestedScrollForwardHarmony
适配 Harmony 的嵌套滚动行为。'selfOnly' 表示只自身滚动,不与父组件联动。'selfFirst' 表示自身先滚动,自身滚动到边界以后父组件滚动。'parentFirst' 表示父组件先滚动,父组件滚动到边界以后自身滚动。'parallel' 表示自身和父组件同时滚动。
exposureBottomiOSAndroid
曝光屏幕下方边距
exposureIDiOSAndroidHarmony
用于全局曝光的 exposure-id
exposureLeftiOSAndroid
曝光屏幕左侧边距
exposureRightiOSAndroid
曝光屏幕右侧边距
exposureSceneiOSAndroidHarmony
用于全局曝光的 exposure-scene
exposureTopiOSAndroid
曝光屏幕上方边距
firstScreenItemCountiOSAndroid
懒加载时预计的第一页项数。剩余的子元素会基于曝光状态完成渲染。当此预估较小时,可能会导致第一屏出现空白现象。
getTabKeyiOSAndroidHarmony
返回每个 Tab 的稳定唯一键。省略时使用索引;当标签可能插入、删除或重排时请提供此函数。
iOSBouncesiOSAndroid
开启iOS上的回弹效果。如果想在安卓上使用,请参考bounceableOption。如果设置了bounceableOption,iOSBounces属性将失效。
lazyiOSAndroid
启用懒渲染。只有当用户滚动到可见区域时,才会渲染 items,从而减少初始加载时间和内存使用。
lazyOptionsiOSAndroid
启用懒渲染。只有当用户滚动到可见区域时,才会渲染 items,从而减少初始加载时间和内存使用。
main-thread:gestureiOSAndroid
如果想使用 gesture API,请传入该属性。
onUIAppeariOSAndroidHarmony
UI 的曝光事件。
onUIDisappeariOSAndroidHarmony
UI 的消失事件。
renderTabItemiOSAndroidHarmony
渲染每个 Tab 项。TabsItem 会自动从 TabsBar 读取其键。
sceneiOSAndroid
用于标记懒加载的曝光时机。请确保页面中唯一。
scrollMonitorTagiOSAndroidHarmony
滚动监控的标签。
scrollPropagationBehavioriOSAndroid
控制滚动事件是否向父级容器传递。'preventPropagate' 在 iOS 上暂时需与 temporaryBlockScrollClass 和 temporaryBlockScrollTag 配合使用。
Currently, this property has limitations because its full functionality depends on a higher native SDK version: on iOS,
propagate only works if both the parent and this component are set to propagate and useRefactorList={true} does not support 'propagate'. On Android, preventPropagate only functions when the parent is x-swiper or x-viewpager-ng.scrollviewIdiOSAndroid
滚动视图的id。
stickyiOSAndroid
粘性元素,设计用于
Tabs。styleiOSAndroidHarmony
样式
tabsItemWrapperClassiOSAndroid
应用于 scroll-view 内子视图的内部容器的类名。
temporaryBlockScrollClassiOS
当 scrollPropagationBehavior 设为 'preventPropagate' 时,被阻止滚动的容器的具体类名。'preventPropagate' 需与 temporaryBlockScrollClass 和 temporaryBlockScrollTag 配合使用。
This is a temporary props and will be deprecated on new Lynx SDK version.
temporaryBlockScrollTagiOS
用于指定当 scrollPropagationBehavior 设为 'preventPropagate' 时被阻止滚动的原生容器标签(对应 UIView 的 Tag 属性)。该值需由原生容器提供方指定,且 'preventPropagate' 必须与 temporaryBlockScrollClass 和 temporaryBlockScrollTag 配合使用。
This is a temporary props and will be deprecated on new Lynx SDK version.
temporaryNestedScrollAndroid
仅 Android 生效的临时开关,用于控制嵌套滚动冲突;映射到原生属性 'enable-nested-scroll'。Android上默认开启。
testingiOSAndroid
测试模式
Events
catchLongPressiOSAndroidHarmony
与 onLongPress 相同,但会阻止事件冒泡。
catchTouchCanceliOSAndroidHarmony
与 onTouchCancel 相同,但会阻止事件冒泡。
catchTouchEndiOSAndroidHarmony
与 onTouchEnd 相同,但会阻止事件冒泡。
catchTouchMoveiOSAndroidHarmony
与 onTouchMove 相同,但会阻止事件冒泡。
catchTouchStartiOSAndroidHarmony
与 onTouchStart 相同,但会阻止事件冒泡。
onContentSizeChangeiOSAndroid
滚动内容变化时触发。
onLayoutChangeiOSAndroidHarmony
当 UI 视口大小改变时发送。
onLongPressiOSAndroidHarmony
当触摸点在 UI 上按住一段时间后发送。
onScrolliOSAndroid
滚动时触发。
onScrollEndiOSAndroid
滚动停止时触发。
onScrollToLoweriOSAndroid
滚动到底部时触发。
onScrollToUpperiOSAndroid
滚动到顶部时触发。
onTapiOSAndroidHarmony
当触摸点在 UI 上轻触时发送。
onTouchCanceliOSAndroidHarmony
当触摸事件在完成前被中断或取消时发送。
onTouchEndiOSAndroidHarmony
当触摸点从 UI 上移除时发送。
onTouchMoveiOSAndroidHarmony
当触摸点在 UI 上移动时发送。
onTouchStartiOSAndroidHarmony
当触摸点放置在 UI 上时发送。
onWheel
当 scroll-view 触发滚轮事件时发送。
TabsItem
childreniOSAndroidHarmony
标签项的内容。
classNameiOSAndroidHarmony
类名
styleiOSAndroidHarmony
样式
tabKeyiOSAndroidHarmony
renderTabItem 渲染的 Tab 项会自动从 TabsBar 获取此键。手动渲染时需提供与数据对应的键。
TabsPanel
bouncesiOSAndroid
在支持的平台启用原生回弹效果。
childreniOSAndroid
渲染页面内容。此函数有意不传入选中状态,因此原生滑动无需让 React 重新渲染页面内容。
classNameiOSAndroidHarmony
类名
dataiOSAndroid
页面数据。ViewPager 为每条数据创建一个直接的原生 viewpager-item 子节点。
enableScrolliOSAndroid
启用水平滑动手势。
getItemKeyiOSAndroid
返回条目的稳定唯一键。不传时使用条目索引;当条目可能插入、删除或重排时请提供此函数。
getItemPropsiOSAndroid
单个自动生成条目的原生属性。类名与 itemClassName 合并;样式覆盖 itemStyle 的同名属性。条目的 key、ref 和 children 由 ViewPager 管理。
idiOSAndroid
应用于原生 ViewPager 根节点的标识符。
itemClassNameiOSAndroid
应用于每个自动生成的 viewpager-item 的类名。
itemStyleiOSAndroid
应用于每个自动生成的 viewpager-item 的样式。
lazyOptionsiOSAndroid
基于曝光的懒渲染。初始页面立即渲染,其他页面在占位节点进入配置的曝光区域时渲染;已渲染页面保持挂载。不传时渲染全部页面。
main-thread:onOffsetChangeiOSAndroid
主线程滚动进度回调,需使用主线程函数。
main-thread:onPageChangeiOSAndroid
主线程页面切换完成回调,需使用主线程函数。
main-thread:onPageWillChangeiOSAndroid
主线程页面即将切换回调,需使用主线程函数。
onOffsetChangeiOSAndroid
原生滚动进度事件,从 event.detail 读取数据。
onPageChangeiOSAndroid
原生页面切换完成事件,从 event.detail.index 读取选中索引。
onPageWillChangeiOSAndroid
原生页面切换完成前事件,从 event.detail 读取数据。
styleiOSAndroidHarmony
样式
viewpagerPropsiOSAndroid
组件未管理的原生分页器属性。
TabsIndicator
childreniOSAndroidHarmony
子节点
classNameiOSAndroidHarmony
类名
indicatorPropsiOSAndroidHarmony
TabsIndicator 的原始属性。
styleiOSAndroidHarmony
样式
TabsRootRef
selectTab
辅助类型
TabsIndicatorAnimation
TabsIndicatorAnimation
TabsIndicatorAnimationSpring
damping
指示器动画的弹簧阻尼。
mass
指示器动画的弹簧质量。
stiffness
指示器动画的弹簧刚度。
type
使用弹簧过渡驱动指示器动画。
velocity
弹簧动画的初始速度。
TabsIndicatorAnimationTween
duration
补间动画时长,单位为毫秒。
ease
补间动画的缓动函数。
type
使用补间过渡驱动指示器动画。