主题
TabBar 继承自:LayoutControl, AdaptiveControl, Control, BaseControl
用于在频繁访问且相互独立的内容类别之间导航。Tabs 允许在两个或多个内容视图之间切换,并依靠文本标题来区分不同的内容区块。
属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
tabs | list[Control] | 必填 | 控件列表。 通常是 Tab。 |
scrollable | bool | True | 此标签栏是否可水平滚动。 如果为 True,则每个标签页的宽度按其标签所需而定,整个标签栏可滚动。否则每个标签页均分可用的空间。 |
tab_alignment | Optional[TabAlignment] | None | 指定标签页在此标签栏中的水平对齐方式。 如果为 None,则使用 tab_alignment 的值。如果 tab_alignment 为 None 且 use_material3 为 True,那么当 scrollable 为 True 时使用 START_OFFSET,否则使用 FILL。 如果 tab_alignment 为 None 且 use_material3 为 False,那么当 scrollable 为 True 时使用 CENTER,否则使用 FILL。 注意: - 如果 scrollable 为 False,那么 tab_alignment 必须是 FILL 或 CENTER。 - 如果 scrollable 为 True,那么 tab_alignment 必须是 START、START_OFFSET 或 CENTER。 抛出异常: ValueError:如果它对当前的 scrollable 配置无效。 |
divider_color | Optional[ColorValue] | None | 分隔线的颜色。 |
indicator_color | Optional[ColorValue] | None | 指示器的颜色(显示在选中标签页下方的线)。 注意: 如果 indicator 或 indicator 不为 None,则此属性会被忽略。 |
indicator | Optional[UnderlineTabIndicator] | None | 定义选中标签页指示器的外观。 如果此属性或 indicator 不为 None,则忽略 indicator_color 和 indicator_thickness 属性。 指示器的大小基于标签页的边界。如果 indicator_size 为 TAB,标签页的边界就是该标签页在标签栏中所占空间的宽度。如果 indicator_size 为 LABEL,则标签页的边界仅与标签页控件本身一样宽。 |
indicator_size | Optional[TabBarIndicatorSize] | None | 定义选中标签页指示器大小的计算方式。 如果 indicator_size 为 TAB(默认值),选中标签页指示器的大小相对于标签页的整体边界计算;如果 indicator_size 为 LABEL,则相对于标签页控件的边界计算。 可通过 indicator_color、indicator_thickness 和 indicator 属性进一步微调选中标签页的位置外观。 |
indicator_animation | Optional[TabIndicatorAnimation] | None | 指定标签页指示器的动画行为。 如果为 None,则使用 indicator_animation 的值。如果它也为 None,那么当 indicator_size 为 TAB 时,标签页指示器将线性动画;当 indicator_size 为 LABEL 时,则以弹性效果动画。 |
secondary | bool | False | 是否创建次级/嵌套标签栏。 次级标签页用于在内容区域内进一步分隔相关内容并建立层级。 |
label_color | Optional[ColorValue] | None | 选中标签页标签的颜色。 |
label_padding | Optional[PaddingValue] | None | 标签页标签周围的内边距。 |
label_text_style | Optional[TextStyle] | None | 标签页标签的文本样式。 |
unselected_label_color | Optional[ColorValue] | None | 未选中标签页标签的颜色。 |
unselected_label_text_style | Optional[TextStyle] | None | 未选中标签页标签的文本样式。 |
overlay_color | Optional[ControlStateValue[ColorValue]] | None | 定义各种 ControlState 状态下的墨水响应(ink response)聚焦、悬停和溅泼颜色。 支持以下状态:ControlState.PRESSED、ControlState.HOVERED 和 ControlState.FOCUSED。 |
divider_height | Optional[Number] | None | 分隔线的高度。 如果为 None,则默认为 divider_height。如果它也为 None,将使用 1.0。 |
indicator_thickness | Number | 2.0 | 指示器的粗细。值必须大于零。 注意: 如果 indicator 或 indicator 不为 None,则此属性会被忽略。 抛出异常: ValueError:如果 indicator 为 None 且 indicator_thickness 不严格大于 0。 |
enable_feedback | Optional[bool] | None | 检测到的手势是否应提供声音和/或触觉反馈。 例如在 Android 上,将其设为 True 会产生点击声,长按会产生短促振动。 默认为 True。 |
mouse_cursor | Optional[MouseCursor] | None | 鼠标指针进入或悬停在此控件上时显示的光标。 |
padding | Optional[PaddingValue] | None | Tabs 控件周围的内边距。 |
splash_border_radius | Optional[BorderRadiusValue] | None | 定义超出标签页边界的溅泼效果的裁剪半径。 |
width | Optional[Number] | None | 控件的强制宽度(以虚拟像素为单位)。 |
height | Optional[Number] | None | 控件的强制高度(以虚拟像素为单位)。 |
left | Optional[Number] | None | 子控件左边缘相对于 Stack 左侧的内缩距离。 注意: 仅当此控件是以下之一的后代时才生效: Stack 控件、overlay 列表。 |
top | Optional[Number] | None | 子控件上边缘相对于 Stack 顶部的内缩距离。 注意: 仅当此控件是以下之一的后代时才生效: Stack 控件、overlay 列表。 |
right | Optional[Number] | None | 子控件右边缘相对于 Stack 右侧的内缩距离。 注意: 仅当此控件是以下之一的后代时才生效: Stack 控件、overlay 列表。 |
bottom | Optional[Number] | None | 子控件下边缘相对于 Stack 底部的内缩距离。 注意: 仅当此控件是以下之一的后代时才生效: Stack 控件、overlay 列表。 |
align | Optional[Alignment] | None | 控件在其父级中的对齐方式。 |
margin | Optional[MarginValue] | None | 设置控件的外边距。 |
rotate | Optional[RotateValue] | None | 围绕控件中心旋转来变换此控件。 rotate 属性的值可以是以下类型之一: * number —— 顺时针旋转的弧度值。整圈 360° 为 math.pi * 2 弧度,90° 为 pi / 2,45° 为 pi / 4,以此类推。 * Rotate —— 允许同时指定旋转 angle 和 alignment,即旋转中心的位置。 示例: python ft.Image( src="https://picsum.photos/100/100", width=100, height=100, border_radius=5, rotate=Rotate(angle=0.25 * pi, alignment=ft.Alignment.CENTER_LEFT) ) |
scale | Optional[ScaleValue] | None | 沿二维平面缩放此控件。默认缩放因子为 1.0,表示不缩放。 例如,将此属性设为 0.5 会让控件缩小一半,而设为 2.0 则会放大一倍。 通过将 Control.scale 属性设为 Scale 类的实例,可以为 x 和 y 轴指定不同的缩放倍数。可以指定 scale,或者指定 scale_x 和 scale_y,但不能同时指定全部。 示例: python ft.Image( src="https://picsum.photos/100/100", width=100, height=100, border_radius=5, scale=ft.Scale(scale_x=2, scale_y=0.5) ) |
offset | Optional[OffsetValue] | None | 在绘制控件之前应用平移变换。 平移量表示为按控件尺寸缩放的 Offset。例如,Offset(x=0.25, y=0) 会使控件沿水平方向平移其宽度的四分之一。 示例 下面的示例把容器显示在 Stack 的 0, 0 左上角,因为变换对控件应用了 -1 * 100, -1 * 100(即 offset * control's size)的水平与垂直平移: python import flet as ft def main(page: ft.Page): page.add( ft.Stack( width=1000, height=1000, controls=[ ft.Container( bgcolor=ft.Colors.RED, width=100, height=100, left=100, top=100, offset=ft.Offset(-1, -1), ) ], ) ) ft.run(main) |
flip | Optional[Flip] | None | 水平方向和/或垂直方向翻转此控件。 设为 Flip 的实例即可沿 x 轴、y 轴或两者镜像翻转。 |
transform | Optional[Transform] | None | 对此控件应用通用矩阵变换。 设为带 Matrix4 记录的 Transform 实例,用以描述任意的变换序列。 |
aspect_ratio | Optional[Number] | None | 控件的宽高比,定义为 width 与 height 的比值。 注意: 在当前实现中,如果设置了 aspect_ratio,同一控件上的 width 和 height 将在最终渲染尺寸中被忽略。 |
animate_opacity | Optional[AnimationValue] | None | 启用 opacity 属性的隐式动画。 更多信息见此处。 |
animate_size | Optional[AnimationValue] | None | 启用此控件尺寸的隐式动画。 如果设置了 width 或 height,则这些维度的变化会以动画呈现。如果两者都未设置,则对控件自然尺寸的变化进行动画。 更多信息见此处。 |
animate_position | Optional[AnimationValue] | None | 启用定位属性(left、right、top 和 bottom)的隐式动画。 更多信息见此处。 |
animate_align | Optional[AnimationValue] | None | 启用 align 属性的隐式动画。 更多信息见此处。 |
animate_margin | Optional[AnimationValue] | None | 启用 margin 属性的隐式动画。 更多信息见此处。 |
animate_rotation | Optional[AnimationValue] | None | 启用 rotate 属性的隐式动画。 更多信息见此处。 |
animate_scale | Optional[AnimationValue] | None | 启用 scale 属性的隐式动画。 更多信息见此处。 |
animate_offset | Optional[AnimationValue] | None | 启用 offset 属性的隐式动画。 更多信息见此处。 |
size_change_interval | int | 10 | on_size_change 事件的采样间隔(毫秒)。 设为 0 时,每次变化都会立即调用 on_size_change。 |
expand | Annotated[Optional[Union[bool, int]], V.instance_of((bool, int))] | None | 指定此控件是否/如何扩展以填满父布局中的可用空间。 更多信息见此处。 注意: 仅当此控件的直接父级是以下控件或其子类时才生效:Column、Row、View、Page。 抛出异常: ValueError:如果它不是 bool 或 int 类型。 |
expand_loose | bool | False | 允许控件在主轴方向有可用空间时扩展,但不要求它填满所有可用空间。 更多信息见此处。 注意: 如果 expand_loose 为 True,则仅在以下条件满足时才生效: - expand 不为 None,且 - 此控件的直接父级是以下控件或其子类之一:Column、Row、View、Page。 |
col | ResponsiveNumber | 12 | 如果此控件的父级是 ResponsiveRow,则此属性决定该控件在屏幕上跨越多少虚拟列。 可以是一个数字,也可以是一个按断点配置不同值的字典,例如 col={"sm": 6}。 值为 0 时会在该断点隐藏控件,因此它不会占用父级 ResponsiveRow 中的任何列。 此控件默认跨越 12 个虚拟列。 | 断点 | 尺寸 | |---|---| | xs | <576px | | sm | ≥576px | | md | ≥768px | | lg | ≥992px | | xl | ≥1200px | | xxl | ≥1400px | |
opacity | Annotated[Number, V.between(0.0, 1.0)] | 1.0 | 定义控件的透明度。 取值范围从 0.0(完全透明)到 1.0(完全不透明,无任何透明感)。 抛出异常: ValueError:如果它不在 0.0 到 1.0(含)之间。 |
tooltip | Optional[TooltipValue] | None | 鼠标悬停在此控件上时显示的工具提示。 |
badge | Optional[BadgeValue] | None | 显示在此控件顶部的徽章。 |
visible | bool | True | 每个控件都有 visible 属性,默认为 True —— 控件会渲染在页面上。将 visible 设为 False 会彻底阻止控件(及其所有子控件,如果有)渲染到页面画布上。隐藏的控件无法通过键盘或鼠标获得焦点或选中,也不会触发任何事件。 |
disabled | bool | False | 每个控件都有 disabled 属性,默认为 False —— 控件及其所有子控件都处于启用状态。 注意: 此属性的值会递归向下传播到所有子控件。 示例: 例如,如果你有一个包含多个输入控件的表单,可以通过禁用容器来一并禁用它们: python ft.Column( disabled = True, controls=[ ft.TextField(), ft.TextField() ] ) |
rtl | bool | False | 控件的文本方向是否为从右到左(RTL)。 |
data | Any | skip_ | 任意类型的自定义数据。 |
key | Optional['KeyValue'] | None | 用于在更新之间保持控件标识稳定的键。 |
adaptive | Optional[bool] | None | 启用平台特定渲染,或从父控件继承自适应能力。 |
只读属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
parent | Optional['BaseControl'] | — | 此控件的直接祖先(父级)。 默认为 None,只有在此控件被挂载(加入页面树)后才有值。 Page 控件(页面树的根)是个例外 —— 它的 parent 始终为 None。 |
page | 'Page' | — | 此控件所属的页面。 |
事件
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
on_click | Optional[ControlEventHandler['TabBar']] | None | 当标签页被点击时调用。 事件处理器参数的 data 属性包含被点击标签页的索引。 |
on_hover | Optional[EventHandler[TabBarHoverEvent]] | None | 当标签栏中某个标签页(来自 tabs)的悬停状态发生变化时调用。 当悬停从一个标签页直接移动到另一个时,此事件会被调用两次。第一次表示悬停离开初始标签页,第二次表示指针进入下一个标签页的悬停状态。 |
on_size_change | Optional[EventHandler[LayoutSizeChangeEvent['LayoutControl']]] | None | 当此控件的尺寸发生变化时调用。 size_change_interval 定义此事件的调用频率。 |
on_animation_end | Optional[ControlEventHandler['LayoutControl']] | None | 动画完成时调用。 可用于串联多个动画。 事件处理器参数的 data 属性包含动画名称。 更多信息见此处。 |
方法
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
before_update | — | — | — |
is_isolated | — | — | 返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外,并需要自行管理更新边界。 |
init | — | — | 在控件实例初始化之后、首次构建/更新周期之前调用。 重写此钩子以执行依赖于已初始化字段的轻量级设置。不要在此处调用 update()。 |
build | — | — | 在控件初始化期间调用一次,用于定义其子控件。在此方法中 page 属性可用。 |
before_event | — | — | 在事件处理器执行之前拦截事件。 返回 False 可取消分发。返回 True 或 None 则继续正常的事件处理。 |
did_mount | — | — | 在控件挂载到页面树之后调用。 重写此方法以启动需要已挂载页面的资源,例如订阅、定时器或服务监听器。 |
will_unmount | — | — | 在控件从页面树移除之前调用。 重写此方法以释放 did_mount() 中创建的资源,例如订阅、定时器或外部句柄。 |
get_data_channel | — | — | 解析为此 widget 在 Dart 侧分配的 [DataChannel]。模式: on_data_channel_open: Optional[ft.EventHandler[DataChannelOpenEvent]] = None def init(self): self.on_data_channel_open = self._on_open def _on_open(self, e): self._channel = self.get_data_channel(e.channel_id) 幂等 —— 底层的 Connection 会按 id 缓存 DataChannel,因此重复调用会返回同一实例。没有错误路径:该 id 始终来自框架触发的事件,所以当此方法运行时,通道在两端都已存在。 |
update | None | — | 为此控件请求一次 UI 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。 |