主题
Tabs 继承自：LayoutControl, AdaptiveControl, Control, BaseControl
用于在频繁访问且相互独立的内容类别之间导航。Tabs 允许在两个或多个内容视图之间切换，并依靠文本标题来区分不同的内容区块。
示例：
python
ft.Tabs(
length=2,
expand=True,
content=ft.Column(
expand=True,
controls=[
ft.TabBar(
tabs=[
ft.Tab(label="Overview"),
ft.Tab(label="Settings", icon=ft.Icons.SETTINGS),
]
),
ft.TabBarView(
expand=True,
controls=[
ft.Container(
alignment=ft.Alignment.CENTER,
content=ft.Text("Overview content"),
),
ft.Container(
alignment=ft.Alignment.CENTER,
content=ft.Text("Settings content"),
),
],
),
],
),
)示例
python
import flet as ft
def main(page: ft.Page):
page.add(
ft.SafeArea(
expand=True,
content=ft.Tabs(
selected_index=1,
length=3,
expand=True,
content=ft.Column(
expand=True,
controls=[
ft.TabBar(
tabs=[
ft.Tab(label="Tab 1", icon=ft.Icons.SETTINGS_PHONE),
ft.Tab(label="Tab 2", icon=ft.Icons.SETTINGS),
ft.Tab(
label=ft.CircleAvatar(
foreground_image_src="https://avatars.githubusercontent.com/u/102273996?s=200&v=4",
),
),
]
),
ft.TabBarView(
expand=True,
controls=[
ft.Container(
alignment=ft.Alignment.CENTER,
content=ft.Text("This is Tab 1"),
),
ft.Container(
alignment=ft.Alignment.CENTER,
content=ft.Text("This is Tab 2"),
),
ft.Container(
alignment=ft.Alignment.CENTER,
content=ft.Text("This is Tab 3"),
),
],
),
],
),
),
)
)
if __name__ == "__main__":
ft.run(main)
python
import flet as ft
def main(page: ft.Page):
page.add(
ft.SafeArea(
expand=True,
content=ft.Tabs(
length=2,
selected_index=1,
expand=True,
content=ft.Column(
expand=True,
controls=[
ft.TabBar(
tabs=[
ft.Tab(label=ft.Text("Main Tab 1")),
ft.Tab(label=ft.Text("Main Tab 2")),
],
),
ft.TabBarView(
expand=True,
controls=[
ft.Text("Main Tab 1 content"),
ft.Tabs(
length=2,
expand=True,
content=ft.Column(
expand=True,
controls=[
ft.TabBar(
secondary=True,
tabs=[
ft.Tab(label=ft.Text("SubTab 1")),
ft.Tab(label=ft.Text("SubTab 2")),
],
),
ft.TabBarView(
expand=True,
controls=[
ft.Text("Nested Tab 1 content"),
ft.Text("Nested Tab 2 content"),
],
),
],
),
),
],
),
],
),
),
)
)
if __name__ == "__main__":
ft.run(main)python
import flet as ft
@ft.control
class MyContainer(ft.Container):
text: str = ""
height: int = 100
alignment: ft.Alignment = ft.Alignment.CENTER
def init(self):
self.bgcolor = ft.Colors.random()
self.content = ft.Text(self.text)
def main(page: ft.Page):
def handle_new_tab(e: ft.Event[ft.CupertinoFilledButton]):
tab_count = len(tab_bar.tabs) + 1
tab_bar.tabs.append(ft.Tab(label=ft.Text(f"Tab {tab_count}")))
tab_view.controls.append(MyContainer(text=f"Tab {tab_count} content"))
tabs.length = len(tab_bar.tabs)
tabs = ft.Tabs(
length=2,
expand=True,
content=ft.Column(
expand=True,
controls=[
tab_bar := ft.TabBar(
tab_alignment=ft.TabAlignment.CENTER,
tabs=[
ft.Tab(label=ft.Text("Tab 1")),
ft.Tab(label=ft.Text("Tab 2")),
],
),
ft.Row(
alignment=ft.MainAxisAlignment.CENTER,
controls=[
ft.CupertinoFilledButton(
content="Add New Tab",
icon=ft.Icons.ADD,
on_click=handle_new_tab,
),
],
),
tab_view := ft.TabBarView(
expand=True,
controls=[
MyContainer(text="Tab 1 content"),
MyContainer(text="Tab 2 content"),
],
),
],
),
)
page.add(
ft.SafeArea(
expand=True,
content=tabs,
)
)
if __name__ == "__main__":
ft.run(main)python
import flet as ft
def main(page: ft.Page):
page.add(
ft.SafeArea(
expand=True,
content=ft.Tabs(
length=2,
expand=True,
content=ft.Column(
expand=True,
controls=[
ft.TabBar(
tab_alignment=ft.TabAlignment.START,
indicator_animation=ft.TabIndicatorAnimation.ELASTIC,
indicator_size=ft.TabBarIndicatorSize.LABEL,
indicator=ft.UnderlineTabIndicator(
border_side=ft.BorderSide(5, color=ft.Colors.RED),
border_radius=ft.BorderRadius.all(1),
insets=ft.Padding.only(bottom=5),
),
tabs=[
ft.Tab(label=ft.Text("Home")),
ft.Tab(label=ft.Text("My Account")),
],
),
ft.TabBarView(
expand=True,
controls=[
ft.Text("Home Tab Content"),
ft.Text("Profile Tab Content"),
],
),
],
),
),
)
)
if __name__ == "__main__":
ft.run(main)python
import random
import flet as ft
def main(page: ft.Page):
async def handle_move_to_random(e: ft.Event[ft.FloatingActionButton]):
# random index, excluding the current one
i = random.choice([i for i in range(tabs.length) if i != tabs.selected_index])
await tabs.move_to(
index=i,
animation_curve=ft.AnimationCurve.FAST_OUT_SLOWIN,
animation_duration=ft.Duration(seconds=3),
)
page.floating_action_button = ft.FloatingActionButton(
icon=ft.Icons.MOVE_UP,
content="Move to a random tab",
on_click=handle_move_to_random,
)
tabs = ft.Tabs(
length=6,
selected_index=5,
expand=True,
content=ft.Column(
expand=True,
controls=[
ft.TabBar(
tab_alignment=ft.TabAlignment.CENTER,
tabs=[
ft.Tab(label=ft.Text("Tab 1")),
ft.Tab(label=ft.Text("Tab 2")),
ft.Tab(label=ft.Text("Tab 3")),
ft.Tab(label=ft.Text("Tab 4")),
ft.Tab(label=ft.Text("Tab 5")),
ft.Tab(label=ft.Text("Tab 6")),
],
),
ft.TabBarView(
expand=True,
controls=[
ft.Container(
alignment=ft.Alignment.CENTER,
content=ft.Text("Tab 1 content"),
),
ft.Container(
alignment=ft.Alignment.CENTER,
content=ft.Text("Tab 2 content"),
),
ft.Container(
alignment=ft.Alignment.CENTER,
content=ft.Text("Tab 3 content"),
),
ft.Container(
alignment=ft.Alignment.CENTER,
content=ft.Text("Tab 4 content"),
),
ft.Container(
alignment=ft.Alignment.CENTER,
content=ft.Text("Tab 5 content"),
),
ft.Container(
alignment=ft.Alignment.CENTER,
content=ft.Text("Tab 6 content"),
),
],
),
],
),
)
page.add(ft.SafeArea(expand=True, content=tabs))
if __name__ == "__main__":
ft.run(main)属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
content | Control | 必填 | 要显示的内容。 |
length | Annotated[int, V.ge(0)] | 必填 | 标签页的总数。 通常大于 1。 注意： 必须与 tabs 和 controls 两者的长度一致。增删标签页时不要忘记更新它。 抛出异常： ValueError：如果它不大于或等于 0。 |
selected_index | int | 0 | 当前选中标签页的索引。 支持 Python 风格的负索引，其中 -1 表示最后一个标签页，-2 表示倒数第二个，依此类推。 注意： - 必须位于范围 [-length, length - 1] 内。 - 更改此属性的值会在内部以 animation_duration 和 EASE 动画曲线触发 move_to。若要为这一次特定更改指定不同的动画曲线或时长，请直接使用 move_to。 抛出异常： IndexError：如果它不在范围 [-length, length - 1] 内。 |
animation_duration | DurationValue | Duration(milliseconds=100() | 标签页动画的时长。例如选中标签页发生变化时播放的动画。 |
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_change | Optional[ControlEventHandler['Tabs']] | None | 当 selected_index 变化时调用。 事件处理器参数的 data 属性包含所选标签页的索引。 |
on_size_change | Optional[EventHandler[LayoutSizeChangeEvent['LayoutControl']]] | None | 当此控件的尺寸发生变化时调用。 size_change_interval 定义此事件的调用频率。 |
on_animation_end | Optional[ControlEventHandler['LayoutControl']] | None | 动画完成时调用。 可用于串联多个动画。 事件处理器参数的 data 属性包含动画名称。 更多信息见此处。 |
方法
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
before_update | — | — | — |
move_to | — | — | 选中给定 index 处的标签页。 此外，它还会触发 on_change 事件并更新 selected_index。 注意： 如果 index 为负数，则按 Python 风格的负索引解释（例如 -1 指最后一个标签页）。如果解析后的索引已经是当前选中的标签页，则方法立即返回，不做任何操作。 参数： index：要选中的标签页索引。必须位于范围 [-length, length - 1] 内。 animation_curve：用于动画的曲线。 animation_duration：动画的时长。如果为 None（默认值），则使用 animation_duration。 抛出异常： IndexError：如果 index 超出范围 [-length, length - 1]。 |
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 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。 |
