Hero 继承自：LayoutControl, Control, BaseControl

将 content 标记为路由切换时的共享元素。

在源视图和目标视图中各放置一个具有相同 tag 的 Hero，即可在路由之间对该控件进行动画过渡。

示例

import flet as ft


def main(page: ft.Page):
    hero_tag = "demo-hero-card"

    def build_card(size: int, label: str) -> ft.Container:
        icon_size = max(24, int(size * 0.28))
        return ft.Container(
            width=size,
            height=size,
            border_radius=ft.BorderRadius.all(20),
            gradient=ft.LinearGradient(
                begin=ft.Alignment.TOP_LEFT,
                end=ft.Alignment.BOTTOM_RIGHT,
                colors=[ft.Colors.BLUE_700, ft.Colors.CYAN_400],
            ),
            alignment=ft.Alignment.CENTER,
            content=ft.Stack(
                fit=ft.StackFit.EXPAND,
                controls=[
                    ft.Container(
                        alignment=ft.Alignment.CENTER,
                        content=ft.Icon(
                            ft.Icons.ROCKET_LAUNCH,
                            size=icon_size,
                            color=ft.Colors.WHITE,
                        ),
                    ),
                    ft.Container(
                        alignment=ft.Alignment.BOTTOM_CENTER,
                        padding=ft.Padding.only(left=8, right=8, bottom=10),
                        content=ft.Text(
                            label,
                            color=ft.Colors.WHITE,
                            weight=ft.FontWeight.BOLD,
                            size=12,
                            no_wrap=True,
                            max_lines=1,
                            overflow=ft.TextOverflow.ELLIPSIS,
                            text_align=ft.TextAlign.CENTER,
                        ),
                    ),
                ],
            ),
        )

    async def go_to_details(_):
        await page.push_route("/details")

    async def go_home(_):
        await page.push_route("/")

    def build_home_view() -> ft.View:
        return ft.View(
            route="/",
            appbar=ft.AppBar(title=ft.Text("Hero animation")),
            controls=[
                ft.SafeArea(
                    expand=True,
                    content=ft.Container(
                        expand=True,
                        alignment=ft.Alignment.CENTER,
                        content=ft.Column(
                            alignment=ft.MainAxisAlignment.CENTER,
                            horizontal_alignment=ft.CrossAxisAlignment.CENTER,
                            spacing=20,
                            controls=[
                                ft.Text("Tap the card to navigate"),
                                ft.GestureDetector(
                                    mouse_cursor=ft.MouseCursor.CLICK,
                                    on_tap=go_to_details,
                                    content=ft.Hero(
                                        tag=hero_tag,
                                        content=build_card(130, "Open details"),
                                    ),
                                ),
                            ],
                        ),
                    ),
                )
            ],
        )

    def build_details_view() -> ft.View:
        return ft.View(
            route="/details",
            appbar=ft.AppBar(title=ft.Text("Details")),
            controls=[
                ft.SafeArea(
                    expand=True,
                    content=ft.Container(
                        expand=True,
                        alignment=ft.Alignment.CENTER,
                        content=ft.Column(
                            alignment=ft.MainAxisAlignment.CENTER,
                            horizontal_alignment=ft.CrossAxisAlignment.CENTER,
                            spacing=20,
                            controls=[
                                ft.Hero(
                                    tag=hero_tag,
                                    transition_on_user_gestures=True,
                                    content=build_card(280, "Details"),
                                ),
                                ft.Button("Back", on_click=go_home),
                            ],
                        ),
                    ),
                )
            ],
        )

    def route_change(e: ft.RouteChangeEvent = None):
        page.views.clear()
        page.views.append(build_home_view())
        if page.route == "/details":
            page.views.append(build_details_view())
        page.update()

    async def view_pop(e: ft.ViewPopEvent):
        if e.view is not None:
            page.views.remove(e.view)
            await page.push_route(page.views[-1].route)

    page.on_route_change = route_change
    page.on_view_pop = view_pop
    route_change()


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

import flet as ft

PRODUCTS = [
    {
        "id": 1,
        "name": "Comet",
        "subtitle": "Fast launch profile",
        "description": "Balanced setup for quick iteration and lightweight payloads.",
        "icon": ft.Icons.ROCKET_LAUNCH,
        "start_color": ft.Colors.BLUE_700,
        "end_color": ft.Colors.CYAN_400,
    },
    {
        "id": 2,
        "name": "Nebula",
        "subtitle": "Visual pipeline",
        "description": "Optimized for rich UI transitions and animated data surfaces.",
        "icon": ft.Icons.AUTO_AWESOME,
        "start_color": ft.Colors.DEEP_PURPLE_700,
        "end_color": ft.Colors.PINK_400,
    },
    {
        "id": 3,
        "name": "Orbit",
        "subtitle": "Reliable baseline",
        "description": "Stable profile focused on consistency and performance.",
        "icon": ft.Icons.PUBLIC,
        "start_color": ft.Colors.GREEN_700,
        "end_color": ft.Colors.LIGHT_GREEN_400,
    },
    {
        "id": 4,
        "name": "Aurora",
        "subtitle": "Analytics focus",
        "description": "Configured for telemetry-heavy apps and live metrics.",
        "icon": ft.Icons.ANALYTICS,
        "start_color": ft.Colors.ORANGE_700,
        "end_color": ft.Colors.AMBER_400,
    },
    {
        "id": 5,
        "name": "Pulse",
        "subtitle": "Real-time profile",
        "description": "Tuned for frequent updates, messaging, and event streams.",
        "icon": ft.Icons.BOLT,
        "start_color": ft.Colors.RED_700,
        "end_color": ft.Colors.DEEP_ORANGE_400,
    },
]


def hero_tag(product_id: int) -> str:
    return f"product-hero-{product_id}"


def main(page: ft.Page):
    def product_by_id(product_id: int):
        for product in PRODUCTS:
            if product["id"] == product_id:
                return product
        return None

    def route_product_id(route: str):
        segments = [segment for segment in route.split("/") if segment]
        if len(segments) != 2 or segments[0] != "product":
            return None
        try:
            return int(segments[1])
        except ValueError:
            return None

    async def open_product(product_id: int):
        await page.push_route(f"/product/{product_id}")

    async def back_to_gallery(e: ft.Event[ft.Button]):
        await page.push_route("/")

    def build_hero_tile(product: dict, size: int) -> ft.Hero:
        icon_size = max(24, int(size * 0.4))
        return ft.Hero(
            tag=hero_tag(product["id"]),
            transition_on_user_gestures=True,
            content=ft.Container(
                width=size,
                height=size,
                border_radius=ft.BorderRadius.all(20),
                gradient=ft.LinearGradient(
                    begin=ft.Alignment.TOP_LEFT,
                    end=ft.Alignment.BOTTOM_RIGHT,
                    colors=[product["start_color"], product["end_color"]],
                ),
                alignment=ft.Alignment.CENTER,
                content=ft.Icon(product["icon"], color=ft.Colors.WHITE, size=icon_size),
            ),
        )

    def build_home_view() -> ft.View:
        rows: list[ft.Control] = []
        for product in PRODUCTS:
            rows.append(
                ft.GestureDetector(
                    mouse_cursor=ft.MouseCursor.CLICK,
                    on_tap=lambda _, pid=product["id"]: page.run_task(
                        open_product, pid
                    ),
                    content=ft.Card(
                        content=ft.Container(
                            padding=12,
                            content=ft.Row(
                                vertical_alignment=ft.CrossAxisAlignment.CENTER,
                                spacing=12,
                                controls=[
                                    build_hero_tile(product, 78),
                                    ft.Column(
                                        spacing=4,
                                        controls=[
                                            ft.Text(
                                                product["name"],
                                                size=18,
                                                weight=ft.FontWeight.W_600,
                                            ),
                                            ft.Text(
                                                product["subtitle"],
                                                color=ft.Colors.ON_SURFACE_VARIANT,
                                            ),
                                            ft.Text(
                                                "Tap to view details",
                                                size=12,
                                                color=ft.Colors.PRIMARY,
                                            ),
                                        ],
                                    ),
                                ],
                            ),
                        )
                    ),
                )
            )

        return ft.View(
            route="/",
            appbar=ft.AppBar(title=ft.Text("Hero gallery")),
            controls=[
                ft.SafeArea(
                    expand=True,
                    content=ft.Column(
                        expand=True,
                        spacing=10,
                        scroll=ft.ScrollMode.AUTO,
                        horizontal_alignment=ft.CrossAxisAlignment.CENTER,
                        controls=[
                            ft.Text(
                                "Each card has a unique Hero tag. "
                                "Open any item to see a matched transition.",
                                color=ft.Colors.ON_SURFACE_VARIANT,
                            ),
                            *rows,
                        ],
                    ),
                )
            ],
        )

    def build_details_view(product: dict) -> ft.View:
        return ft.View(
            route=f"/product/{product['id']}",
            appbar=ft.AppBar(title=ft.Text(product["name"])),
            controls=[
                ft.SafeArea(
                    expand=True,
                    content=ft.Column(
                        expand=True,
                        horizontal_alignment=ft.CrossAxisAlignment.CENTER,
                        spacing=16,
                        scroll=ft.ScrollMode.AUTO,
                        controls=[
                            ft.Container(height=8),
                            build_hero_tile(product, 220),
                            ft.Text(
                                product["subtitle"],
                                size=20,
                                weight=ft.FontWeight.W_600,
                                text_align=ft.TextAlign.CENTER,
                            ),
                            ft.Container(
                                width=520,
                                content=ft.Text(
                                    product["description"],
                                    text_align=ft.TextAlign.CENTER,
                                    color=ft.Colors.ON_SURFACE_VARIANT,
                                ),
                            ),
                            ft.Button("Back to gallery", on_click=back_to_gallery),
                        ],
                    ),
                )
            ],
        )

    def route_change(e: ft.RouteChangeEvent = None):
        page.views.clear()
        page.views.append(build_home_view())

        pid = route_product_id(page.route)
        if pid is not None:
            product = product_by_id(pid)
            if product is not None:
                page.views.append(build_details_view(product))

        page.update()

    async def view_pop(e: ft.ViewPopEvent):
        if e.view is not None:
            page.views.remove(e.view)
            await page.push_route(page.views[-1].route)

    page.on_route_change = route_change
    page.on_view_pop = view_pop
    route_change()


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

属性

名称	类型	默认值	说明
tag	Annotated[str, V.instance_of(str)]	必填	用于匹配源与目标 Hero 控件的唯一标识符。 抛出异常： ValueError：如果它不是 str 类型。
content	Annotated[Control, V.visible_control()]	必填	要显示并参与动画的控件。 抛出异常： ValueError：如果它不可见。
transition_on_user_gestures	bool	False	当路由通过用户手势（例如 iOS 的返回滑动）切换时是否进行动画。
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_size_change	Optional[EventHandler[LayoutSizeChangeEvent['LayoutControl']]]	None	当此控件的尺寸发生变化时调用。 size_change_interval 定义此事件的调用频率。
on_animation_end	Optional[ControlEventHandler['LayoutControl']]	None	动画完成时调用。 可用于串联多个动画。 事件处理器参数的 data 属性包含动画名称。 更多信息见此处。

方法

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