主题
View 继承自:ScrollableControl, LayoutControl, Control, BaseControl
View 是所有其他控件的最顶层容器。
新的用户会话启动时,会自动创建一个根视图。从布局的角度看,View 相当于一个 Column 控件,因此行为相似并共享相同的属性。
属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
controls | list[BaseControl] | [] | 要显示的控件列表。 |
route | str | '/'() | 视图的路由 —— 目前不被 Flet 框架使用,但可以在用户程序中用于在视图弹出时更新 route。 |
appbar | 'Optional[Union[AppBar, CupertinoAppBar]]' | None | 显示在 Page 顶部的 AppBar 控件。 |
bottom_appbar | Optional[BottomAppBar] | None | 显示在 Page 底部的 BottomAppBar 控件。 |
floating_action_button | Optional[FloatingActionButton] | None | 显示在 Page 内容之上的 FloatingActionButton 控件。 |
floating_action_button_location | Optional[Union[FloatingActionButtonLocation, OffsetValue]] | None | 描述 floating_action_button 的位置 |
navigation_bar | 'Union[NavigationBar, CupertinoNavigationBar, None]' | None | 显示在 Page 底部的导航栏(NavigationBar 或 CupertinoNavigationBar)控件。 |
drawer | Optional[NavigationDrawer] | None | 作为从视图起始边缘滑出的面板显示的 NavigationDrawer 控件。 |
end_drawer | Optional[NavigationDrawer] | None | 作为从视图末端边缘滑出的面板显示的 NavigationDrawer 控件。 |
vertical_alignment | MainAxisAlignment | MainAxisAlignment.START | 定义子 controls 应如何垂直放置。 |
horizontal_alignment | CrossAxisAlignment | CrossAxisAlignment.START | 子控件应如何水平放置。 |
spacing | Number | 10 | Page 上 controls 之间的垂直间距。 注意: 仅当 vertical_alignment 设置为 START、END 或 CENTER 时才生效。 |
padding | Optional[PaddingValue] | Padding.all(10() | 页面内容与其边缘之间的空白。 |
bgcolor | Optional[ColorValue] | None | 视图的背景色。 |
decoration | Optional[BoxDecoration] | None | 背景装饰。 |
foreground_decoration | Optional[BoxDecoration] | None | 前景装饰。 |
fullscreen_dialog | bool | False | 如果为 True,该视图是一个全屏模态对话框。 |
services | list[Service] | [] | 与此视图关联的 Service 控件列表。 |
can_pop | bool | True | 视图是否可以被弹出。 |
scroll | Optional[Union[ScrollMode, Scrollbar]] | None | 定义此控件的滚动条配置。 可以是 Scrollbar 实例,以便完全控制滚动条外观;也可以是 ScrollMode 值,使用现成的滚动条行为。 |
auto_scroll | bool | False | 内容变化时是否自动将滚动位置移动到末尾。 这样在添加新子控件时以及现有内容就地增长时(例如文本流式写入现有子控件),视图都会保持在末尾。当用户滚动离开末尾时暂停固定,一旦滚回末尾则恢复。 注意: 必须为 False,scroll_to 方法才能生效。 |
auto_scroll_animation | Optional[AnimationValue] | None | auto_scroll 将视图移动到末尾时使用的动画。 接受 Animation(时长 + 曲线)、以毫秒为单位的 int 时长,或 True。默认为 1 秒的 ease 动画;将时长设为 0 可立即跳转(在跟随快速的逐 token 流式输出时推荐使用,以便视图紧密保持固定)。 |
scroll_interval | Number | 10 | on_scroll 事件的节流时间(毫秒)。 |
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 | 用于在更新之间保持控件标识稳定的键。 |
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。 |
只读属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
parent | Optional['BaseControl'] | — | 此控件的直接祖先(父级)。 默认为 None,只有在此控件被挂载(加入页面树)后才有值。 Page 控件(页面树的根)是个例外 —— 它的 parent 始终为 None。 |
page | 'Page' | — | 此控件所属的页面。 |
事件
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
on_confirm_pop | Optional[ControlEventHandler['View']] | None | 当视图即将被弹出时调用的事件处理器。你可以使用此事件通过调用 confirm_pop 方法来确认或取消弹出操作。 |
on_scroll | Optional[EventHandler[OnScrollEvent]] | None | 当用户改变滚动位置时调用。 |
on_size_change | Optional[EventHandler[LayoutSizeChangeEvent['LayoutControl']]] | None | 当此控件的尺寸发生变化时调用。 size_change_interval 定义此事件的调用频率。 |
on_animation_end | Optional[ControlEventHandler['LayoutControl']] | None | 动画完成时调用。 可用于串联多个动画。 事件处理器参数的 data 属性包含动画名称。 更多信息见此处。 |
方法
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
init | — | — | — |
confirm_pop | None | — | 解析此视图待处理的弹出确认请求。 在 on_confirm_pop 中调用此方法,以允许或取消当前的后退导航尝试。 参数: should_pop:True 表示继续弹出此视图,False 表示将视图保留在导航栈中。 说明: - 此方法仅在弹出确认待处理时有效。 - 如果不调用,前端确认等待会超时,弹出操作将被取消。 |
show_drawer | — | — | 显示抽屉。 抛出异常: ValueError:如果未定义 drawer。 |
close_drawer | — | — | 关闭抽屉。 |
show_end_drawer | — | — | 显示末端抽屉。 抛出异常: ValueError:如果未定义 end_drawer。 |
close_end_drawer | — | — | 关闭末端抽屉。 |
scroll_to | — | — | 移动滚动位置。 参数: offset:以像素为单位的绝对滚动目标。负值表示相对于末尾(例如 -1 跳到最末尾)。 delta:以像素为单位的相对滚动变化量。正值向前滚动,负值向后滚动。 scroll_key:要滚动到的目标控件的 key。 duration:滚动动画时长。 curve:滚动动画曲线。 说明: - offset、delta 或 scroll_key 中应且只应提供一个。 - auto_scroll 必须为 False。 - 对动态构建条目的控件(例如 ListView、GridView)此方法无效。 示例: python await products.scroll_to(offset=100, duration=1000) await products.scroll_to(offset=-1, duration=1000) # to the end await products.scroll_to(delta=50) # forward 50px await products.scroll_to(scroll_key="item_20", duration=500) |
is_isolated | — | — | 返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外,并需要自行管理更新边界。 |
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 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。 |