Dropdown 继承自：LayoutControl, Control, BaseControl

一个下拉控件，允许用户从 options 列表中选出单个选项。

示例：

ft.Dropdown(
    width=220,
    value="alice",
    options=[
        ft.DropdownOption(key="alice", text="Alice"),
        ft.DropdownOption(key="bob", text="Bob"),
    ],
)

示例

import flet as ft


def main(page: ft.Page):
    page.theme_mode = ft.ThemeMode.LIGHT

    def get_options() -> list[ft.DropdownOption]:
        colors = [
            ft.Colors.RED,
            ft.Colors.BLUE,
            ft.Colors.YELLOW,
            ft.Colors.PURPLE,
            ft.Colors.LIME,
        ]
        return [
            ft.DropdownOption(
                key=color.value,
                content=ft.Text(value=color.value, color=color),
            )
            for color in colors
        ]

    def handle_dropdown_select(e: ft.Event[ft.Dropdown]):
        e.control.color = e.control.value

    page.add(
        ft.SafeArea(
            content=ft.Dropdown(
                key="color_dropdown",
                editable=True,
                label="Color",
                options=get_options(),
                on_select=handle_dropdown_select,
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)

import flet as ft


def main(page: ft.Page):
    def get_options() -> list[ft.DropdownOption]:
        icons = [
            {"name": "Smile", "icon": ft.Icons.SENTIMENT_SATISFIED_OUTLINED},
            {"name": "Cloud", "icon": ft.Icons.CLOUD_OUTLINED},
            {"name": "Brush", "icon": ft.Icons.BRUSH_OUTLINED},
            {"name": "Heart", "icon": ft.Icons.FAVORITE},
        ]
        return [
            ft.DropdownOption(key=icon["name"], leading_icon=icon["icon"])
            for icon in icons
        ]

    page.add(
        ft.SafeArea(
            content=ft.Dropdown(
                key="icon_dropdown",
                border=ft.UnderlineInputBorder(),
                enable_filter=True,
                editable=True,
                leading_icon=ft.Icons.SEARCH,
                label="Icon",
                options=get_options(),
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)

from dataclasses import dataclass
from typing import cast

import flet as ft


@dataclass
@ft.observable
class Form:
    color: str = "red"

    def change_color(self, new_color: str):
        print("New color:", new_color)
        self.color = new_color


@ft.component
def App():
    form, _ = ft.use_state(lambda: Form())

    return ft.SafeArea(
        content=ft.Column(
            controls=cast(
                list[ft.Control],
                [
                    ft.Text(f"Selected color: {form.color}"),
                    ft.Column(
                        controls=[
                            ft.Dropdown(
                                key="declarative_dropdown",
                                editable=True,
                                label="Color",
                                value=form.color,
                                on_select=lambda e: form.change_color(
                                    cast(str, e.control.value)
                                ),
                                options=[
                                    ft.DropdownOption(key="red", text="Red"),
                                    ft.DropdownOption(key="green", text="Green"),
                                    ft.DropdownOption(key="blue", text="Blue"),
                                ],
                            ),
                        ],
                    ),
                ],
            ),
        ),
    )


def main(page: ft.Page):
    page.render(App)


if __name__ == "__main__":
    ft.run(main)

import flet as ft


def main(page: ft.Page):
    colors = [
        ft.Colors.RED,
        ft.Colors.BLUE,
        ft.Colors.YELLOW,
        ft.Colors.PURPLE,
        ft.Colors.LIME,
    ]

    def get_options() -> list[ft.DropdownOption]:
        options: list[ft.DropdownOption] = []
        for color in colors:
            options.append(
                ft.DropdownOption(
                    key=color.value,
                    content=ft.Text(value=color.value, color=color),
                    leading_icon=ft.Icon(ft.Icons.PALETTE, color=color),
                )
            )
        return options

    display_value = ft.Text()
    display_text = ft.Text()

    def dropdown_select(e: ft.Event[ft.Dropdown]):
        e.control.color = e.control.value
        display_value.value = f"VALUE changed to {e.control.value}"

    def dropdown_text_change(e: ft.Event[ft.Dropdown]):
        display_text.value = f"TEXT changed to {e.control.text}"

    page.scroll = ft.ScrollMode.AUTO
    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    display_value,
                    display_text,
                    ft.Dropdown(
                        key="select_change_dropdown",
                        editable=True,
                        label="Color",
                        width=float("inf"),
                        options=get_options(),
                        on_select=dropdown_select,
                        on_text_change=dropdown_text_change,
                    ),
                ],
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)

import flet as ft


def main(page: ft.Page):
    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    ft.Dropdown(
                        key="styled_dropdown_1",
                        text_size=20,
                        content_padding=10,
                        color=ft.Colors.PURPLE_200,
                        bgcolor=ft.Colors.BLUE_200,
                        filled=True,
                        border={
                            ft.ControlState.DEFAULT: ft.OutlineInputBorder(
                                border_radius=30,
                                side=ft.BorderSide(color=ft.Colors.GREEN_800),
                            ),
                            ft.ControlState.FOCUSED: ft.OutlineInputBorder(
                                border_radius=30,
                                side=ft.BorderSide(
                                    width=5, color=ft.Colors.GREEN_ACCENT_400
                                ),
                            ),
                        },
                        options=[
                            ft.DropdownOption("a", "Style 1A"),
                            ft.DropdownOption("b", "Style 1B"),
                            ft.DropdownOption("c", "Style 1C"),
                        ],
                    ),
                    ft.Dropdown(
                        key="styled_dropdown_2",
                        border={
                            ft.ControlState.DEFAULT: ft.OutlineInputBorder(
                                border_radius=30,
                                side=ft.BorderSide(color=ft.Colors.TRANSPARENT),
                            ),
                            ft.ControlState.FOCUSED: ft.OutlineInputBorder(
                                border_radius=30,
                                side=ft.BorderSide(width=20, color=ft.Colors.PINK_300),
                            ),
                        },
                        filled=True,
                        fill_color=ft.Colors.RED_400,
                        bgcolor=ft.Colors.RED_200,
                        color=ft.Colors.CYAN_400,
                        options=[
                            ft.DropdownOption("a", "Style 2A"),
                            ft.DropdownOption("b", "Style 2B"),
                            ft.DropdownOption("c", "Style 2C"),
                        ],
                    ),
                    ft.Dropdown(
                        key="styled_dropdown_3",
                        border={
                            ft.ControlState.DEFAULT: ft.OutlineInputBorder(
                                border_radius=30,
                                side=ft.BorderSide(
                                    width=5, color=ft.Colors.PINK_ACCENT
                                ),
                            ),
                            ft.ControlState.FOCUSED: ft.OutlineInputBorder(
                                border_radius=30,
                                side=ft.BorderSide(
                                    width=25, color=ft.Colors.GREEN_ACCENT_400
                                ),
                            ),
                        },
                        width=150,
                        options=[
                            ft.DropdownOption("a", "Style 3A"),
                            ft.DropdownOption("b", "Style 3B"),
                            ft.DropdownOption("c", "Style 3C"),
                        ],
                    ),
                    ft.Container(
                        padding=ft.Padding.only(bottom=20),
                        content=ft.Dropdown(
                            key="styled_dropdown_4",
                            text_size=30,
                            color=ft.Colors.ORANGE_ACCENT,
                            border={
                                ft.ControlState.DEFAULT: ft.OutlineInputBorder(
                                    border_radius=20,
                                    side=ft.BorderSide.none(),
                                ),
                                ft.ControlState.FOCUSED: ft.OutlineInputBorder(
                                    border_radius=20,
                                    side=ft.BorderSide(
                                        width=10, color=ft.Colors.GREEN_100
                                    ),
                                ),
                            },
                            filled=True,
                            autofocus=True,
                            width=200,
                            height=50,
                            options=[
                                ft.dropdown.Option("a", "Style 4A"),
                                ft.dropdown.Option("b", "Style 4B"),
                                ft.dropdown.Option("c", "Style 4C"),
                            ],
                        ),
                    ),
                    ft.Dropdown(
                        key="styled_dropdown_5",
                        text_size=30,
                        border={
                            ft.ControlState.DEFAULT: ft.OutlineInputBorder(
                                border_radius=20,
                                side=ft.BorderSide.none(),
                            ),
                            ft.ControlState.FOCUSED: ft.OutlineInputBorder(
                                border_radius=20,
                                side=ft.BorderSide(width=10, color=ft.Colors.GREEN_100),
                            ),
                        },
                        filled=True,
                        content_padding=20,
                        width=200,
                        options=[
                            ft.DropdownOption(
                                key="a",
                                text="Style 5A",
                                style=ft.ButtonStyle(
                                    shape=ft.BeveledRectangleBorder(radius=15),
                                    color={
                                        ft.ControlState.HOVERED: ft.Colors.WHITE,
                                        ft.ControlState.FOCUSED: ft.Colors.BLUE,
                                        ft.ControlState.DEFAULT: ft.Colors.BLACK,
                                    },
                                ),
                            ),
                            ft.DropdownOption(
                                key="b",
                                text="Style 5B",
                                style=ft.ButtonStyle(
                                    shape=ft.BeveledRectangleBorder(radius=15),
                                    color={
                                        ft.ControlState.HOVERED: ft.Colors.WHITE,
                                        ft.ControlState.FOCUSED: ft.Colors.BLUE,
                                        ft.ControlState.DEFAULT: ft.Colors.BLACK,
                                    },
                                ),
                            ),
                            ft.DropdownOption(
                                key="c",
                                text="Style 5C",
                                style=ft.ButtonStyle(
                                    shape=ft.BeveledRectangleBorder(radius=15),
                                    color={
                                        ft.ControlState.HOVERED: ft.Colors.WHITE,
                                        ft.ControlState.FOCUSED: ft.Colors.BLUE,
                                        ft.ControlState.DEFAULT: ft.Colors.BLACK,
                                    },
                                ),
                            ),
                        ],
                    ),
                ],
            ),
        )
    )


if __name__ == "__main__":
    ft.run(main)

属性

名称	类型	默认值	说明
value	Optional[str]	None	所选选项对应下拉 options 中的 key。
options	list[DropdownOption]	[]	要在下拉列表中显示的选项列表。
text	Optional[str]	None	在文本字段中输入的文本。
autofocus	bool	False	该控件是否会被选为初始焦点。如果页面上有多个设置了 autofocus 的控件，则第一个添加到页面上的控件会获得焦点。
text_align	TextAlign	TextAlign.START	Dropdown 的 TextField 的文本对齐方式。
elevation	Optional[ControlStateValue[Optional[Number]]]	8	下拉菜单在各种 ControlState 状态下的高度（elevation）。
enable_filter	bool	False	决定菜单列表能否通过文本输入进行筛选。默认为 false。 若设为 true，下拉菜单会显示筛选后的列表。筛选后的列表包含与输入字段所提供文本匹配的条目，比较时不区分大小写。
enable_search	bool	True	决定与文本输入匹配的第一个条目能否被高亮显示。
editable	bool	False	下拉控件是否允许编辑文本输入字段。
menu_height	Optional[Number]	None	下拉菜单的高度。 若为 None，菜单会在屏幕上显示尽可能多的条目。
menu_width	Optional[Number]	None	下拉菜单的宽度。 若为 None，菜单宽度将与输入文本字段宽度相同。
menu_style	Optional[MenuStyle]	None	定义菜单视觉属性的菜单样式。 菜单的默认宽度设置为文本字段的宽度。
expanded_insets	Optional[PaddingValue]	None	展开的下拉菜单的内缩距离。
selected_suffix	Optional[Control]	None	在下拉控件中所选项之后显示的控件。
input_filter	Optional[InputFilter]	None	应用于文本输入字段的过滤器。
capitalization	Optional[TextCapitalization]	None	配置文本输入应如何自动大写。
trailing_icon	Optional[IconDataOrControl]	None	在文本字段末尾显示的图标。
leading_icon	Optional[IconDataOrControl]	None	文本输入字段前端（装饰框内）的可选图标。 若不为 null，菜单条目会有额外的内边距，以便与文本字段中的文本对齐。
selected_trailing_icon	Optional[IconDataOrControl]	None	文本字段末尾的可选图标，用于表示文本字段被按下。
bgcolor	Optional[ControlStateValue[ColorValue]]	None	下拉菜单在各种 ControlState 状态下的背景色。
error_style	Optional[TextStyle]	None	用于 error_text 的 TextStyle。
error_text	Optional[str]	None	显示在输入边框下方的文本。 若非 null，边框颜色会动画过渡为红色，并且不显示 helper_text。
text_size	Optional[Number]	None	文本大小（虚拟像素）。
text_style	Optional[TextStyle]	None	用于输入文本字段中文本的 TextStyle。
label	Optional[StrOrControl]	None	描述输入字段的可选文本。 当输入字段为空且未获得焦点时，标签显示在输入字段之上（即屏幕上可输入文本的同一位置）。当输入字段获得焦点（或字段非空）时，标签上移，或紧贴输入字段上方，或移动到输入字段中央。
label_style	Optional[TextStyle]	None	label 的文本样式。
border	Optional[ControlStateValue[InputBorder]]	None	围绕装饰后输入区域绘制的边框。 接受单个 InputBorder，或把 ControlState 映射到 InputBorder 的字典。支持的状态键有 DEFAULT、FOCUSED、ERROR 和 DISABLED。 单个边框会为所有状态定义形状。若其 side 未设置，Material 主题会按状态解析边框颜色和粗细（例如聚焦边框使用主题的主色）；显式设置的 side 应用于启用状态，其他状态仍由主题解析。 在字典形式中，DEFAULT 条目的行为与单个形式一致，而每个未显式设置 side 的状态条目会回退到 DEFAULT 条目的 side（如果已设置）。
border_radius	Annotated[Optional[BorderRadiusValue], V.deprecated('border', version='1.0.0', delete_version='1.3.0', reason='Use border=OutlineInputBorder(border_radius=...) instead.', docs_reason='Use :attr:border with an :class:~flet.OutlineInputBorder instead.')]	None	将轮廓边框的圆角变圆。
border_width	Annotated[Optional[Number], V.deprecated('border', version='1.0.0', delete_version='1.3.0', reason='Use border=OutlineInputBorder(side=BorderSide(width=...)) instead.', docs_reason='Use :attr:border with a :class:~flet.BorderSide instead.')]	None	边框宽度（虚拟像素）。
border_color	Annotated[Optional[ColorValue], V.deprecated('border', version='1.0.0', delete_version='1.3.0', reason='Use border=OutlineInputBorder(side=BorderSide(color=...)) instead.', docs_reason='Use :attr:border with a :class:~flet.BorderSide instead.')]	None	边框颜色。
focused_border_width	Annotated[Optional[Number], V.deprecated('border', version='1.0.0', delete_version='1.3.0', reason='Use border={ControlState.FOCUSED: OutlineInputBorder(...)} instead.', docs_reason='Use :attr:border with a :attr:flet.ControlState.FOCUSED entry instead.')]	None	聚焦状态下的边框宽度。
focused_border_color	Annotated[Optional[ColorValue], V.deprecated('border', version='1.0.0', delete_version='1.3.0', reason='Use border={ControlState.FOCUSED: OutlineInputBorder(...)} instead.', docs_reason='Use :attr:border with a :attr:flet.ControlState.FOCUSED entry instead.')]	None	聚焦状态下的边框颜色。
color	Optional[ColorValue]	None	文本颜色。
content_padding	Optional[PaddingValue]	None	输入装饰容器的内边距。
dense	bool	False	TextField 是否属于紧凑型表单（即占用更少的垂直空间）。
filled	bool	False	装饰容器是否用主题的 fill_color 填充。
fill_color	Optional[ColorValue]	None	下拉输入文本字段的背景色。 注意： 若 filled=False，则不会显示。
hover_color	Optional[ColorValue]	None	鼠标悬停时下拉输入文本字段的颜色。
hint_text	Optional[str]	None	提示该字段接受何种输入的文本。 当输入为空，且满足 (a) label 为 null 或 (b) 输入已获得焦点时，显示在输入之上。
hint_style	Optional[TextStyle]	None	用于 hint_text 的 TextStyle。
helper_text	Optional[str]	None	提供有关输入值上下文的文本，例如该值将如何使用。 若非 null，文本显示在输入装饰器下方，位置与 error_text 相同。如果指定了非 null 的 error_text，则不会显示助手文本。
helper_style	Optional[TextStyle]	None	用于 helper_text 的 TextStyle。
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	用于在更新之间保持控件标识稳定的键。

只读属性

名称	类型	默认值	说明
parent	Optional['BaseControl']	—	此控件的直接祖先（父级）。 默认为 None，只有在此控件被挂载（加入页面树）后才有值。 Page 控件（页面树的根）是个例外 —— 它的 parent 始终为 None。
page	'Page'	—	此控件所属的页面。

事件

名称	类型	默认值	说明
on_select	Optional[ControlEventHandler['Dropdown']]	None	当此下拉控件的选中项发生变化时调用。
on_text_change	Optional[ControlEventHandler['Dropdown']]	None	当此下拉控件的 text 输入发生变化时调用。
on_focus	Optional[ControlEventHandler['Dropdown']]	None	当控件获得焦点时调用。
on_blur	Optional[ControlEventHandler['Dropdown']]	None	当控件失去焦点时调用。
on_size_change	Optional[EventHandler[LayoutSizeChangeEvent['LayoutControl']]]	None	当此控件的尺寸发生变化时调用。 size_change_interval 定义此事件的调用频率。
on_animation_end	Optional[ControlEventHandler['LayoutControl']]	None	动画完成时调用。 可用于串联多个动画。 事件处理器参数的 data 属性包含动画名称。 更多信息见此处。

方法

名称	类型	默认值	说明
focus	—	—	为此控件请求焦点。
is_isolated	—	—	返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外，并需要自行管理更新边界。
init	—	—	在控件实例初始化之后、第一次 build / update 周期之前调用。 重写此钩子以执行依赖已初始化字段的轻量级设置。不要在此处调用 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 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。