页签进行内容视图切换的容器组件

2024-01-22 17:58 更新

通过页签进行内容视图切换的容器组件,每个页签对应一个内容视图。

说明

该组件从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

子组件

仅可包含子组件TabContent

接口

Tabs(value?: {barPosition?: BarPosition, index?: number, controller?: TabsController})

参数:

参数名

参数类型

必填

参数描述

barPosition

BarPosition

设置Tabs的页签位置。

默认值:BarPosition.Start

index

number

设置当前显示页签的索引。

默认值:0

说明:

设置为小于0的值时按默认值显示。

可选值为[0, TabContent子节点数量-1]。

设置不同值时,默认生效切换动效,可以设置animationDuration为0关闭动画。

controller

TabsController

设置Tabs控制器。

BarPosition枚举说明

名称

描述

Start

vertical属性方法设置为true时,页签位于容器左侧;vertical属性方法设置为false时,页签位于容器顶部。

End

vertical属性方法设置为true时,页签位于容器右侧;vertical属性方法设置为false时,页签位于容器底部。

属性

除支持通用属性外,还支持以下属性:

名称

参数类型

描述

vertical

boolean

设置为false是为横向Tabs,设置为true时为纵向Tabs。

默认值:false

scrollable

boolean

设置为true时可以通过滑动页面进行页面切换,为false时不可滑动切换页面。

默认值:true

barMode

BarMode

TabBar布局模式,具体描述见BarMode枚举说明。

默认值:BarMode.Fixed

barWidth

number | Length8+

TabBar的宽度值。

默认值:

未设置带样式的TabBar且vertical属性为false时,默认值为Tabs的宽度。

未设置带样式的TabBar且vertical属性为true时,默认值为56vp。

设置SubTabbarStyle样式且vertical属性为false时,默认值为Tabs的宽度。

设置SubTabbarStyle样式且vertical属性为true时,默认值为56vp。

设置BottomTabbarStyle样式且vertical属性为true时,默认值为96vp。

设置BottomTabbarStyle样式且vertical属性为false时,默认值为Tabs的宽度。

说明:

设置为小于0或大于Tabs宽度值时,按默认值显示。

barHeight

number | Length8+

TabBar的高度值。

默认值:

未设置带样式的TabBar且vertical属性为false时,默认值为56vp。

未设置带样式的TabBar且vertical属性为true时,默认值为Tabs的高度。

设置SubTabbarStyle样式且vertical属性为false时,默认值为56vp。

设置SubTabbarStyle样式且vertical属性为true时,默认值为Tabs的高度。

设置BottomTabbarStyle样式且vertical属性为true时,默认值为Tabs的高度。

设置BottomTabbarStyle样式且vertical属性为false时,默认值为56vp。

说明:

设置为小于0或大于Tabs高度值时,按默认值显示。

animationDuration

number

点击TabBar页签切换TabContent的动画时长。不设置时,点击TabBar页签切换TabContent无动画。

默认值:300

说明:

该参数不支持百分比设置;设置为小于0时,按默认值300ms显示。

BarMode枚举说明

名称

描述

Scrollable

每一个TabBar均使用实际布局宽度,超过总长度(横向Tabs的barWidth,纵向Tabs的barHeight)后可滑动。

Fixed

所有TabBar平均分配barWidth宽度(纵向时平均分配barHeight高度)。

事件

除支持通用事件外,还支持以下事件:

名称

功能描述

onChange(event: (index: number) => void)

Tab页签切换后触发的事件。

- index:当前显示的index索引,索引从0开始计算。

触发该事件的条件:

1、TabContent支持滑动时,组件触发滑动时触发。

2、通过控制器API接口调用。

3、通过状态变量构造的属性值进行修改。

4、通过页签处点击触发。

TabsController

Tabs组件的控制器,用于控制Tabs组件进行页签切换。不支持一个TabsController控制多个Tabs组件。

导入对象

  1. controller: TabsController = new TabsController()

changeIndex

changeIndex(value: number): void

控制Tabs切换到指定页签。

参数:

参数名

参数类型

必填

参数描述

value

number

页签在Tabs里的索引值,索引值从0开始。

说明:

设置小于0或大于最大数量的值时,该事件失效。

示例

  1. // xxx.ets
  2. @Entry
  3. @Component
  4. struct TabsExample {
  5. @State fontColor: string = '#182431'
  6. @State selectedFontColor: string = '#007DFF'
  7. @State currentIndex: number = 0
  8. private controller: TabsController = new TabsController()
  9. @Builder TabBuilder(index: number, name: string) {
  10. Column() {
  11. Text(name)
  12. .fontColor(this.currentIndex === index ? this.selectedFontColor : this.fontColor)
  13. .fontSize(16)
  14. .fontWeight(this.currentIndex === index ? 500 : 400)
  15. .lineHeight(22)
  16. .margin({ top: 17, bottom: 7 })
  17. Divider()
  18. .strokeWidth(2)
  19. .color('#007DFF')
  20. .opacity(this.currentIndex === index ? 1 : 0)
  21. }.width('100%')
  22. }
  23. build() {
  24. Column() {
  25. Tabs({ barPosition: BarPosition.Start, controller: this.controller }) {
  26. TabContent() {
  27. Column().width('100%').height('100%').backgroundColor('#00CB87')
  28. }.tabBar(this.TabBuilder(0, 'green'))
  29. TabContent() {
  30. Column().width('100%').height('100%').backgroundColor('#007DFF')
  31. }.tabBar(this.TabBuilder(1, 'blue'))
  32. TabContent() {
  33. Column().width('100%').height('100%').backgroundColor('#FFBF00')
  34. }.tabBar(this.TabBuilder(2, 'yellow'))
  35. TabContent() {
  36. Column().width('100%').height('100%').backgroundColor('#E67C92')
  37. }.tabBar(this.TabBuilder(3, 'pink'))
  38. }
  39. .vertical(false)
  40. .barMode(BarMode.Fixed)
  41. .barWidth(360)
  42. .barHeight(56)
  43. .animationDuration(400)
  44. .onChange((index: number) => {
  45. this.currentIndex = index
  46. })
  47. .width(360)
  48. .height(296)
  49. .margin({ top: 52 })
  50. .backgroundColor('#F1F3F5')
  51. }.width('100%')
  52. }
  53. }

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号