主题
ExpansionTile 继承自:LayoutControl, AdaptiveControl, Control, BaseControl
一个带有展开箭头图标的单行 ListTile,通过展开或折叠该列表项来显示或隐藏其控件。
示例:
python
ft.ExpansionTile(
width=400,
title="Account",
subtitle="Manage profile and security",
expanded=True,
controls=[
ft.ListTile(title=ft.Text("Profile")),
ft.ListTile(title=ft.Text("Security")),
],
)示例
python
import flet as ft
def main(page: ft.Page):
page.theme_mode = ft.ThemeMode.LIGHT
page.spacing = 0
page.padding = 0
def handle_tile_change(e: ft.Event[ft.ExpansionTile]):
page.show_dialog(
ft.SnackBar(
duration=1000,
content=ft.Text(
value=(
f"ExpansionTile was "
f"{'expanded' if e.data == 'true' else 'collapsed'}"
)
),
)
)
if e.control.trailing:
e.control.trailing.icon = (
ft.Icons.ARROW_DROP_DOWN
if e.control.trailing.icon == ft.Icons.ARROW_DROP_DOWN_CIRCLE
else ft.Icons.ARROW_DROP_DOWN_CIRCLE
)
e.control.trailing.update()
page.add(
ft.SafeArea(
content=ft.Column(
spacing=0,
controls=[
ft.ExpansionTile(
expanded=True,
title=ft.Text("ExpansionTile 1"),
subtitle=ft.Text("Trailing expansion arrow icon"),
affinity=ft.TileAffinity.PLATFORM,
maintain_state=True,
collapsed_text_color=ft.Colors.RED,
text_color=ft.Colors.RED,
controls=[
ft.ListTile(title=ft.Text("This is sub-tile number 1.1")),
ft.ListTile(title=ft.Text("This is sub-tile number 1.2")),
],
),
ft.ExpansionTile(
expanded=True,
title=ft.Text("ExpansionTile 2"),
subtitle=ft.Text("Custom expansion arrow icon"),
trailing=ft.Icon(ft.Icons.ARROW_DROP_DOWN),
collapsed_text_color=ft.Colors.GREEN,
text_color=ft.Colors.GREEN,
on_change=handle_tile_change,
controls=[
ft.ListTile(title=ft.Text("This is sub-tile number 2.1")),
ft.ListTile(title=ft.Text("This is sub-tile number 2.2")),
],
),
ft.ExpansionTile(
expanded=True,
title=ft.Text("ExpansionTile 3"),
subtitle=ft.Text("Leading expansion arrow icon"),
affinity=ft.TileAffinity.LEADING,
collapsed_text_color=ft.Colors.BLUE_800,
text_color=ft.Colors.BLUE_200,
controls=[
ft.ListTile(title=ft.Text("This is sub-tile number 3.1")),
ft.ListTile(title=ft.Text("This is sub-tile number 3.2")),
],
),
],
),
),
)
if __name__ == "__main__":
ft.run(main)
python
import flet as ft
def main(page: ft.Page):
page.spacing = 20
tile = ft.ExpansionTile(
title=ft.Text("I am the title of this tile.", weight=ft.FontWeight.BOLD),
subtitle=ft.Text("This is the subtitle."),
affinity=ft.TileAffinity.LEADING,
controls=[ft.Text("👻", size=80)],
expanded=True,
on_change=lambda e: print(f"Tile was {'expanded' if e.data else 'collapsed'}"),
)
def expand_tile(_: ft.Event[ft.FilledButton]):
tile.expanded = True
tile.update()
def collapse_tile(_: ft.Event[ft.OutlinedButton]):
tile.expanded = False
tile.update()
page.add(
ft.SafeArea(
content=ft.Column(
controls=[
ft.Row(
alignment=ft.MainAxisAlignment.CENTER,
controls=[
ft.FilledButton("Expand Tile", on_click=expand_tile),
ft.OutlinedButton("Collapse Tile", on_click=collapse_tile),
],
),
tile,
],
),
)
)
if __name__ == "__main__":
ft.run(main)
python
import flet as ft
def main(page: ft.Page):
page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
page.spacing = 20
tile = ft.ExpansionTile(
expanded=True,
title=ft.Text("Expand/Collapse me while being attentive to the animations!"),
controls=[
ft.ListTile(title=ft.Text("Sub-item 1")),
ft.ListTile(title=ft.Text("Sub-item 2")),
ft.ListTile(title=ft.Text("Sub-item 3")),
],
)
def switch_animation(e: ft.Event[ft.CupertinoSlidingSegmentedButton]):
if e.control.selected_index == 0:
tile.animation_style = None
elif e.control.selected_index == 1:
tile.animation_style = ft.AnimationStyle(
curve=ft.AnimationCurve.BOUNCE_OUT,
duration=ft.Duration(seconds=5),
)
else:
tile.animation_style = ft.AnimationStyle.no_animation()
tile.update()
page.add(
ft.SafeArea(
content=ft.Column(
horizontal_alignment=ft.CrossAxisAlignment.CENTER,
controls=[
ft.CupertinoSlidingSegmentedButton(
selected_index=0,
thumb_color=ft.Colors.BLUE_400,
on_change=switch_animation,
controls=[
ft.Text("Default animation"),
ft.Text("Custom animation"),
ft.Text("No animation"),
],
),
tile,
],
),
)
)
if __name__ == "__main__":
ft.run(main)
python
import flet as ft
def main(page: ft.Page):
page.spacing = 0
page.padding = 0
page.theme_mode = ft.ThemeMode.LIGHT
def handle_switch_change(e: ft.Event[ft.Switch]):
page.theme_mode = ft.ThemeMode.DARK if e.control.value else ft.ThemeMode.LIGHT
e.control.thumb_icon = (
ft.Icons.DARK_MODE
if page.theme_mode == ft.ThemeMode.DARK
else ft.Icons.LIGHT_MODE
)
page.update()
def handle_expansion_tile_change(e: ft.Event[ft.ExpansionTile]):
page.show_dialog(
ft.SnackBar(
duration=1000,
content=ft.Text(
value=(
f"ExpansionTile was "
f"{'expanded' if e.data == 'true' else 'collapsed'}"
)
),
)
)
if e.control.trailing:
e.control.trailing.icon = (
ft.Icons.ARROW_DROP_DOWN
if e.control.trailing.icon == ft.Icons.ARROW_DROP_DOWN_CIRCLE
else ft.Icons.ARROW_DROP_DOWN_CIRCLE
)
e.control.trailing.update()
switch = ft.Switch(
thumb_icon=ft.Icons.DARK_MODE,
on_change=handle_switch_change,
)
page.add(
ft.SafeArea(
content=ft.Column(
spacing=0,
controls=[
ft.ExpansionTile(
key="theme_mode_toggle_top_panel",
title=ft.Text("ExpansionTile 1"),
subtitle=ft.Text("Trailing expansion arrow icon"),
bgcolor=ft.Colors.BLUE_GREY_200,
collapsed_bgcolor=ft.Colors.BLUE_GREY_200,
affinity=ft.TileAffinity.PLATFORM,
maintain_state=True,
collapsed_text_color=ft.Colors.RED,
text_color=ft.Colors.RED,
controls=[
ft.ListTile(
title=ft.Text("This is sub-tile number 1"),
bgcolor=ft.Colors.BLUE_GREY_200,
)
],
),
ft.ExpansionTile(
title=ft.Text("ExpansionTile 2"),
subtitle=ft.Text("Custom expansion arrow icon"),
trailing=ft.Icon(ft.Icons.ARROW_DROP_DOWN),
collapsed_text_color=ft.Colors.GREEN,
text_color=ft.Colors.GREEN,
on_change=handle_expansion_tile_change,
controls=[
ft.ListTile(title=ft.Text("This is sub-tile number 2"))
],
),
ft.ExpansionTile(
title=ft.Text("ExpansionTile 3"),
subtitle=ft.Text("Leading expansion arrow icon"),
affinity=ft.TileAffinity.LEADING,
expanded=True,
collapsed_text_color=ft.Colors.BLUE_800,
text_color=ft.Colors.BLUE_200,
controls=[
ft.ListTile(title=ft.Text("This is sub-tile number 3")),
ft.ListTile(title=ft.Text("This is sub-tile number 4")),
ft.ListTile(title=ft.Text("This is sub-tile number 5")),
],
),
ft.Row(
expand=True,
alignment=ft.MainAxisAlignment.END,
controls=[
ft.Container(
padding=ft.Padding.only(bottom=50),
alignment=ft.Alignment.BOTTOM_RIGHT,
expand=True,
content=switch,
),
],
),
],
),
)
)
if __name__ == "__main__":
ft.run(main)python
import flet as ft
def main(page: ft.Page):
page.theme_mode = ft.ThemeMode.LIGHT
page.add(
ft.SafeArea(
content=ft.ExpansionTile(
title=ft.Text(
value="Expansion Tile with changing borders",
text_align=ft.TextAlign.CENTER,
),
subtitle=ft.Text(
value="Tile border changes when expanded",
text_align=ft.TextAlign.CENTER,
),
bgcolor=ft.Colors.BLUE_GREY_200,
controls_padding=ft.Padding.symmetric(horizontal=10),
collapsed_bgcolor=ft.Colors.BLUE_GREY_200,
affinity=ft.TileAffinity.PLATFORM,
maintain_state=True,
shape=ft.RoundedRectangleBorder(radius=20),
collapsed_shape=ft.StadiumBorder(side=ft.BorderSide(width=2)),
collapsed_text_color=ft.Colors.GREY_800,
text_color=ft.Colors.GREY_800,
controls=[
ft.ListTile(
title=ft.Text("A sub-tile"),
bgcolor=ft.Colors.BLUE_GREY_200,
shape=ft.RoundedRectangleBorder(radius=20),
),
ft.ListTile(
title=ft.Text("Another sub-tile"),
bgcolor=ft.Colors.BLUE_GREY_200,
shape=ft.RoundedRectangleBorder(radius=20),
),
],
),
)
)
if __name__ == "__main__":
ft.run(main)
属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
title | Annotated[StrOrControl, V.str_or_visible_control()] | 必填 | 作为此列表项主要内容显示的控件。 通常是 Text 控件。 抛出异常: ValueError:如果它既不是字符串也不是可见的 Control。 |
controls | Optional[list[Control]] | None | 当此列表项 expanded 时要显示的控件。 通常是 ListTile 控件列表。 |
subtitle | Optional[StrOrControl] | None | 显示在 title 下方的附加内容。 通常是 Text 控件。 |
leading | Optional[IconDataOrControl] | None | 显示在 title 之前的控件。 通常是 CircleAvatar 控件。 根据 affinity 的值,此控件可能会替换旋转的展开箭头图标。 |
trailing | Optional[IconDataOrControl] | None | 显示在 title 之后的控件。 通常是 Icon 控件。 根据 affinity 的值,此控件可能会替换旋转的展开箭头图标。 |
controls_padding | Optional[PaddingValue] | None | 定义 controls 周围的内边距。 如果为 None,则使用 controls_padding;如果它也为 None,则默认为 Padding.all(0)。 |
tile_padding | Optional[PaddingValue] | None | 定义该列表项的内边距。 与 content_padding 类似,此属性定义 leading、title、subtitle 和 trailing 控件的内缩。它不会为展开后的 controls 控件设置内缩。 如果为 None,则使用 tile_padding;如果它也为 None,则默认为 Padding.symmetric(horizontal=16.0)。 |
affinity | Optional[TileAffinity] | None | 通常用于强制将展开箭头图标放在列表项的 leading 或 trailing 边缘。 如果为 None,则使用 affinity;如果它也为 None,则默认为 TRAILING(展开箭头图标出现在列表项的后缘)。 |
expanded_alignment | Optional[Alignment] | None | 定义 controls 的对齐方式,当列表项展开时它们以列布局排列。 如果为 None,则使用 expanded_alignment;如果它也为 None,则默认为 CENTER。 |
expanded_cross_axis_alignment | CrossAxisAlignment | CrossAxisAlignment.CENTER | 定义列表项展开时 controls 中每个子控件的对齐方式。 抛出异常: ValueError:如果设为 BASELINE。 |
clip_behavior | Optional[ClipBehavior] | None | 定义此列表项的内容如何被裁剪。 如果设置了自定义的折叠或展开形状,此值决定该列表项如何被裁剪。 如果为 None,则使用 clip_behavior;如果它也为 None,则默认为 ANTI_ALIAS。 |
maintain_state | bool | False | 一个布尔值,定义当此列表项 expanded 与折叠时是否保持 controls 的状态。 当为 True 时,列表项折叠期间子控件仍保留在树中。当为 False(默认)时,列表项折叠时 controls 会从树中移除,展开时再重新创建。 |
text_color | Optional[ColorValue] | None | 当子列表 expanded 时此列表项标题的颜色。 如果为 None,则使用 text_color;如果它也为 None,则默认为 text_theme 的 body_large。 |
icon_color | Optional[ColorValue] | None | 当子列表 expanded 时此列表项展开箭头图标的图标颜色。 如果为 None,则使用 icon_color;如果它也为 None,则默认为 theme 的 primary。 |
shape | Optional[OutlinedBorder] | None | 当子列表 expanded 时此列表项的边框形状。 如果为 None,则使用 shape;如果它也为 None,则默认为两侧垂直、颜色为 divider_color 的 Border。 |
bgcolor | Optional[ColorValue] | None | 当 expanded 时显示在子列表后面的颜色。 如果为 None,则使用 bgcolor;如果它也为 None,则默认为 TRANSPARENT。 |
collapsed_bgcolor | Optional[ColorValue] | None | 定义当子列表折叠时(expanded 为 False)此列表项的背景颜色。 如果为 None,则使用 collapsed_bgcolor;如果它也为 None,则默认为 TRANSPARENT。 |
collapsed_icon_color | Optional[ColorValue] | None | 当子列表折叠时(expanded 为 False)此列表项展开箭头图标的图标颜色。 如果为 None,则使用 collapsed_icon_color;如果它也为 None,则默认为 theme 的 on_surface。 |
collapsed_text_color | Optional[ColorValue] | None | 当子列表折叠时(expanded 为 False)此列表项标题的颜色。 如果为 None,则使用 collapsed_text_color;如果它也为 None,则默认为 text_theme 的 body_large。 |
collapsed_shape | Optional[OutlinedBorder] | None | 当子列表折叠时列表项的边框形状。 如果为 None,则使用 shape;如果它也为 None,则默认为两侧垂直、颜色为 TRANSPARENT 的 Border。 |
dense | Optional[bool] | None | 此列表项是否属于垂直密集列表。 密集列表项默认高度更小。 在 Material3 中不建议将此属性设为 True。 如果为 None,则其值基于 dense。 |
enable_feedback | bool | True | 检测到的手势是否应提供声音和/或触觉反馈。例如,启用反馈时,在 Android 上点按会产生点击声,长按会产生短促振动。 |
show_trailing_icon | bool | True | 如果 trailing 为 None,此列表项是否应构建/显示一个默认的后置图标。 |
min_tile_height | Optional[Number] | None | 此列表项的最小高度。 如果为 None,则一行、两行和三行文本的默认列表项高度分别为 56.0、72.0 和 88.0。如果 dense 为 True,这些默认值变为 48.0、64.0 和 76.0。视觉密度值或大号标题也会调整默认列表项高度。 |
expanded | bool | False | 此列表项的展开状态。 True —— 展开,False —— 折叠。 |
visual_density | Optional[VisualDensity] | None | 定义此列表项布局的紧凑程度。 |
animation_style | Optional[AnimationStyle] | None | 定义此列表项展开和折叠的动画样式(曲线和时长)。 如果提供了 duration,它将用于覆盖展开动画时长。如果它为 None,则使用 animation_style 中的 duration。如果它也为 None,则默认使用 Duration(milliseconds=200)。 如果提供了 curve,它将用于覆盖展开动画曲线。如果它为 None,则使用 animation_style 中的 curve。如果它也为 None,则默认使用 EASE_IN。 如果提供了 reverse_curve,它将用于覆盖折叠动画曲线。如果它为 None,则使用 animation_style 中的 reverse_curve。如果它也为 None,则默认使用展开曲线。 提示: 要禁用动画,请使用 no_animation。 |
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['ExpansionTile']] | None | 当用户点击或点按列表项时调用。 事件处理器参数的 data 属性是一个布尔值,表示变化后该列表项的 expanded 状态。 |
on_size_change | Optional[EventHandler[LayoutSizeChangeEvent['LayoutControl']]] | None | 当此控件的尺寸发生变化时调用。 size_change_interval 定义此事件的调用频率。 |
on_animation_end | Optional[ControlEventHandler['LayoutControl']] | None | 动画完成时调用。 可用于串联多个动画。 事件处理器参数的 data 属性包含动画名称。 更多信息见此处。 |
方法
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
is_isolated | — | — | 返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外,并需要自行管理更新边界。 |
init | — | — | 在控件实例初始化之后、首次构建/更新周期之前调用。 重写此钩子以执行依赖已初始化字段的轻量级设置。不要在此处调用 update()。 |
build | — | — | 在控件初始化期间调用一次,用于定义其子控件。在此方法中 page 属性可用。 |
before_update | — | — | 每当此控件被更新时都会调用此方法。 注意: 务必不要在此处调用或请求 update()。 |
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 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。 |