主题
ListTile 继承自:LayoutControl, AdaptiveControl, ActionControl, Control, BaseControl
一个固定高度的单行,通常包含一些文本以及前置或后置图标。
示例:
python
ft.ListTile(
width=400,
leading=ft.Icon(ft.Icons.ACCOUNT_CIRCLE),
title="Jane Doe",
subtitle="Product Manager",
trailing=ft.Icon(ft.Icons.CHEVRON_RIGHT),
bgcolor=ft.Colors.SURFACE_CONTAINER_LOW,
)示例
python
import flet as ft
def main(page: ft.Page):
page.title = "ListTile Example"
page.add(
ft.SafeArea(
content=ft.Card(
content=ft.Container(
width=500,
padding=ft.Padding.symmetric(vertical=10),
content=ft.Column(
spacing=0,
controls=[
ft.ListTile(title=ft.Text("One-line list tile")),
ft.ListTile(
title=ft.Text("One-line dense list tile"),
dense=True,
),
ft.ListTile(
leading=ft.Icon(ft.Icons.SETTINGS),
title=ft.Text("One-line selected list tile"),
selected=True,
),
ft.ListTile(
leading=ft.Image(
src="assets/icon-192.png",
fit=ft.BoxFit.CONTAIN,
),
title=ft.Text("One-line with leading control"),
),
ft.ListTile(
title=ft.Text("One-line with trailing control"),
trailing=ft.PopupMenuButton(
icon=ft.Icons.MORE_VERT,
items=[
ft.PopupMenuItem(content="Item 1"),
ft.PopupMenuItem(content="Item 2"),
],
),
),
ft.ListTile(
leading=ft.Icon(ft.Icons.ALBUM),
title=ft.Text(
value=(
"One-line with leading and trailing controls"
)
),
trailing=ft.PopupMenuButton(
icon=ft.Icons.MORE_VERT,
items=[
ft.PopupMenuItem(content="Item 1"),
ft.PopupMenuItem(content="Item 2"),
],
),
),
ft.ListTile(
leading=ft.Icon(ft.Icons.SNOOZE),
title=ft.Text(
value=(
"Two-line with leading and trailing controls"
)
),
subtitle=ft.Text("Here is a second title."),
trailing=ft.PopupMenuButton(
icon=ft.Icons.MORE_VERT,
items=[
ft.PopupMenuItem(content="Item 1"),
ft.PopupMenuItem(content="Item 2"),
],
),
),
],
),
)
),
)
)
if __name__ == "__main__":
ft.run(main)
属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
title | Optional[StrOrControl] | None | 作为列表项主要内容显示的控件。 通常是 Text 控件。它不应换行。要强制单行限制,可使用 max_lines。 |
subtitle | Optional[StrOrControl] | None | 显示在标题下方的附加内容。 如果 is_three_line 为 False,它不应换行。如果 is_three_line 为 True,则应将其配置为最多占两行。例如,你可以使用 max_lines 来强制行数。 通常是 Text 控件。 |
is_three_line | Optional[bool] | None | 此列表项是否用于显示三行文本。 若为 True,则 subtitle 必须非空(因为它预期提供第二行和第三行文本)。 若为 False,则当 subtitle 为空时列表项被视为一行,subtitle 非空时被视为两行。 当 title 和 subtitle 使用 Text 控件时,你可以用 max_lines 强制行数限制。 |
leading | Optional[IconDataOrControl] | None | 显示在 title 之前的控件。 |
trailing | Optional[IconDataOrControl] | None | 显示在 title 之后的控件。 通常是 Icon 控件。 |
content_padding | Optional[PaddingValue] | None | 该列表项的内部内边距。它为该列表项的内容设置内缩,即其 leading、title、subtitle 和 trailing 控件。 |
bgcolor | Optional[ColorValue] | None | 列表项的背景颜色。 |
splash_color | Optional[ColorValue] | None | 控件被点击后列表项的水波纹颜色。 |
hover_color | Optional[ColorValue] | None | 悬停时列表项的颜色。仅当 toggle_inputs 为 True 或提供了 on_click 时才生效。 |
selected | bool | False | 如果该列表项已启用,则图标和文本以相同颜色渲染。默认情况下选中颜色为主题的主色。 |
dense | Optional[bool] | None | 此列表项是否属于垂直密集列表。 密集列表项默认高度更小。 |
autofocus | bool | False | 若控件将被选为初始焦点则为 True。如果页面上有多个设置了 autofocus 的控件,则最先添加到页面的控件获得焦点。 |
toggle_inputs | bool | False | 点击列表项是否应切换该列表项内 Radio、Checkbox 或 Switch 的状态。 |
selected_color | Optional[ColorValue] | None | 定义当 selected=True 时用于图标和文本的颜色。 |
selected_tile_color | Optional[ColorValue] | None | 定义当 selected=True 时 ListTile 的背景颜色。 |
style | Optional[ListTileStyle] | None | 定义用于标题的字体。 默认为 ListTileStyle.LIST。 |
enable_feedback | Optional[bool] | None | 检测到的手势是否应提供声音和/或触觉反馈。例如在 Android 上,将其设为 True 会产生点击声,长按会产生短促振动。 |
horizontal_spacing | Optional[Number] | None | title 与 leading、trailing 控件之间的水平间距。 |
min_leading_width | Optional[Number] | None | 为 leading 控件分配的最小宽度。 |
min_vertical_padding | Optional[Number] | None | title 和 subtitle 控件顶部和底部的最小内边距。 |
url | Optional[Union[str, Url]] | None | 点击此按钮时要打开的 URL。 此外,如果提供了 on_click 事件回调,它会在其后触发。 |
title_alignment | Optional[ListTileTitleAlignment] | None | 定义 leading 和 trailing 相对于标题(title 和 subtitle)的垂直对齐方式。 在 Material 3 中默认为 ListTileTitleAlignment.THREE_LINE,在 Material 2 中默认为 ListTileTitleAlignment.TITLE_HEIGHT。 |
icon_color | Optional[ColorValue] | None | 定义 leading 和 trailing 中图标的默认颜色。 |
text_color | Optional[ColorValue] | None | 用于 title、subtitle、leading 和 trailing 中文本的颜色。 |
shape | Optional[OutlinedBorder] | None | 列表项的形状。 |
visual_density | Optional[VisualDensity] | None | 定义控件布局的紧凑程度。 |
mouse_cursor | Optional[MouseCursor] | None | 鼠标指针进入或悬停在此控件上时要显示的光标。值为 MouseCursor 枚举。 |
title_text_style | Optional[TextStyle] | None | title 控件的 TextStyle。 |
subtitle_text_style | Optional[TextStyle] | None | subtitle 控件的 TextStyle。 |
leading_and_trailing_text_style | Optional[TextStyle] | None | leading 和 trailing 控件的 TextStyle。 |
min_height | Optional[Number] | None | 为此控件分配的最小高度。 如果为 None 或未设置,则一行、两行和三行文本的默认列表项高度分别为 56.0、72.0 和 88.0。如果 dense 为 True,这些默认值变为 48.0、64.0 和 76.0。 注意,视觉密度值或大号标题也会调整默认列表项高度。 |
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 | 启用平台特定渲染,或从父控件继承自适应能力。 |
action | Optional[Union[ClientAction, list[ClientAction]]] | None | 当此控件被激活时由客户端执行的动作,无需往返到你的 Python 代码。 当你需要执行浏览器仅在处理用户点击时才允许的操作(例如打开文件选择器、写入剪贴板、显示分享面板或打开新标签页)时,可使用此属性。参见 ClientAction。 |
只读属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
parent | Optional['BaseControl'] | — | 此控件的直接祖先(父级)。 默认为 None,只有在此控件被挂载(加入页面树)后才有值。 Page 控件(页面树的根)是个例外 —— 它的 parent 始终为 None。 |
page | 'Page' | — | 此控件所属的页面。 |
事件
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
on_click | Optional[ControlEventHandler['ListTile']] | None | 当用户点击或点按列表项时调用。 |
on_long_press | Optional[ControlEventHandler['ListTile']] | None | 当用户长按此列表项时调用。 |
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 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。 |