PageView 继承自：LayoutControl, Control, BaseControl

一次显示一个子 controls，并允许用户在它们之间滑动，类似于轮播。

它适用于引导流程、照片轮播，或任何把内容划分为离散的整宽页面的场景。

示例

import flet as ft


def main(page: ft.Page):
    page.padding = 0

    page.add(
        ft.SafeArea(
            expand=True,
            content=ft.PageView(
                expand=True,
                viewport_fraction=0.9,
                on_change=lambda e: print(f"Currently viewing page {int(e.data)}"),
                selected_index=1,
                horizontal=True,
                controls=[
                    ft.Container(
                        bgcolor=ft.Colors.INDIGO_400,
                        content=ft.Column(
                            alignment=ft.MainAxisAlignment.CENTER,
                            horizontal_alignment=ft.CrossAxisAlignment.CENTER,
                            controls=[
                                ft.Text("Welcome", size=40, weight=ft.FontWeight.BOLD),
                                ft.Text("Swipe to see what PageView can do."),
                            ],
                        ),
                    ),
                    ft.Container(
                        bgcolor=ft.Colors.PINK_300,
                        content=ft.Column(
                            alignment=ft.MainAxisAlignment.CENTER,
                            horizontal_alignment=ft.CrossAxisAlignment.CENTER,
                            controls=[
                                ft.Icon(ft.Icons.ANIMATION, size=72),
                                ft.Text(
                                    "Viewport fraction lets you peek at the next slide."
                                ),
                            ],
                        ),
                    ),
                    ft.Container(
                        bgcolor=ft.Colors.TEAL_300,
                        content=ft.Column(
                            alignment=ft.MainAxisAlignment.CENTER,
                            horizontal_alignment=ft.CrossAxisAlignment.CENTER,
                            controls=[
                                ft.Icon(ft.Icons.TOUCH_APP, size=72),
                                ft.Text("Use on_change to respond to page swipes."),
                            ],
                        ),
                    ),
                ],
            ),
        ),
    )


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

import flet as ft


def main(page: ft.Page):
    page.padding = 0

    async def show_previous_page(e: ft.Event[ft.FloatingActionButton]):
        await view.previous_page(
            animation_curve=ft.AnimationCurve.BOUNCE_OUT,
            animation_duration=ft.Duration(seconds=1),
        )

    async def show_next_page(e: ft.Event[ft.FloatingActionButton]):
        await view.next_page(
            animation_curve=ft.AnimationCurve.BOUNCE_OUT,
            animation_duration=ft.Duration(seconds=1),
        )

    page.floating_action_button = ft.Row(
        alignment=ft.MainAxisAlignment.CENTER,
        wrap=True,
        controls=[
            ft.FloatingActionButton(
                icon=ft.Icons.SWIPE_LEFT,
                on_click=show_previous_page,
                tooltip="Previous Page",
            ),
            ft.FloatingActionButton(
                icon=ft.Icons.SWIPE_RIGHT,
                on_click=show_next_page,
                tooltip="Next Page",
            ),
        ],
    )

    page.add(
        ft.SafeArea(
            expand=True,
            content=(
                view := ft.PageView(
                    expand=True,
                    viewport_fraction=0.9,
                    selected_index=1,
                    horizontal=True,
                    controls=[
                        ft.Container(
                            bgcolor=bgcolor,
                            content=ft.Column(
                                alignment=ft.MainAxisAlignment.CENTER,
                                horizontal_alignment=ft.CrossAxisAlignment.CENTER,
                                controls=[
                                    ft.Text(
                                        f"Page {idx}",
                                        size=55,
                                        weight=ft.FontWeight.BOLD,
                                    ),
                                ],
                            ),
                        )
                        for idx, bgcolor in enumerate(
                            [
                                ft.Colors.RED_800,
                                ft.Colors.BLUE_800,
                                ft.Colors.GREEN_800,
                                ft.Colors.ORANGE_800,
                                ft.Colors.PURPLE_800,
                                ft.Colors.PINK_800,
                            ]
                        )
                    ],
                )
            ),
        ),
    )


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

属性

名称	类型	默认值	说明
controls	list[Control]	[]	要显示的控件列表，每页一个，按应出现的顺序排列。
selected_index	Annotated[int, V.ge(0)]	0	当前可见页面的从零开始的索引。 之后再修改它（并调用 update）会无动画地跳转到指定页面。 抛出异常： ValueError：如果它不大于或等于 0。
keep_page	bool	True	重新构建时，此页面视图是否应恢复最近查看过的页面。
horizontal	bool	True	页面是否应水平排列和滚动。 False 表示垂直排列和滚动。
reverse	bool	False	是否反转页面的阅读和滑动顺序。 例如，如果阅读方向是从左到右且 horizontal 为 True，那么当 reverse 为 False 时该页面视图从左向右滚动，当 reverse 为 True 时从右向左滚动。 类似地，如果 horizontal 为 False，那么当 reverse 为 False 时该页面视图从上向下滚动，当 reverse 为 True 时从下向上滚动。
viewport_fraction	Annotated[Number, V.gt(0)]	1.0	每个页面在滚动方向（见 horizontal）上应占据视口的比例。 例如，1.0（默认值）表示每个页面填满视口。 抛出异常： ValueError：如果它不大于 0。
snap	bool	True	拖拽后视图是否应吸附到精确的页面边界。 如果 pad_ends 为 False 且 viewport_fraction < 1.0，页面会吸附到视口开头；否则页面会吸附到视口中心。
implicit_scrolling	bool	False	是否允许相邻页面在用户滚动到它们之前部分渲染，从而实现更平滑的过渡，并通过让焦点在导航期间无缝地在页面间移动来改善无障碍体验。 当此标志为 False 时，若无障碍焦点到达当前页面末尾且用户尝试将其移动到下一个元素，焦点会遍历到页面视图之外的下一控件。 当此标志为 True 时，若无障碍焦点到达当前页面末尾且用户尝试将其移动到下一个元素，焦点会遍历到页面视图中的下一页。
pad_ends	bool	True	是否在列表两端添加内边距。 如果此项为 True 且 viewport_fraction < 1.0，会在第一个页面之前和最后一个页面之后添加内边距，使它们在滚动到最开头或最末尾时吸附到视口中心。 注意： 如果 viewport_fraction >= 1.0，此属性不产生任何效果。
clip_behavior	ClipBehavior	ClipBehavior.HARD_EDGE	定义页面溢出其边界时如何被裁剪。
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_change	Optional[ControlEventHandler['PageView']]	None	当可见页面发生变化时触发。 事件参数的 data 属性包含新页面的索引。
on_size_change	Optional[EventHandler[LayoutSizeChangeEvent['LayoutControl']]]	None	当此控件的尺寸发生变化时调用。 size_change_interval 定义此事件的调用频率。
on_animation_end	Optional[ControlEventHandler['LayoutControl']]	None	动画完成时调用。 可用于串联多个动画。 事件处理器参数的 data 属性包含动画名称。 更多信息见此处。

方法

名称	类型	默认值	说明
go_to_page	—	—	以动画方式移动到索引为 index 的页面。 参数： index：要显示的页面索引。 animation_duration：动画的时长。 animation_curve：动画的缓动曲线。 抛出异常： ValueError：如果 index 为负数。
jump_to_page	—	—	无动画地立即跳转到索引为 index 的页面，将页面位置从当前值移动到给定值，既不做动画也不进行范围检查。 参数： index：要显示的页面索引。 抛出异常： ValueError：如果 index 为负数。
jump_to	—	—	无动画且不校验值是否在范围内，立即将滚动位置设置为给定值。 任何正在进行的滚动或动画都会被取消。 如果滚动位置发生变化，会派发一次 start/update/end 序列的滚动通知。此方法不产生过度滚动（overscroll）通知。 跳转之后，如果该值超出有效滚动范围，则会启动弹道活动（ballistic activity）。 参数： value：新的滚动位置。
next_page	—	—	以动画方式移动到下一页。等同于以 selected_index + 1 调用 go_to_page。 参数： animation_duration：动画的时长。 animation_curve：动画的缓动曲线。
previous_page	—	—	以动画方式移动到上一页。等同于以 selected_index - 1 调用 go_to_page。 参数： animation_duration：动画的时长。 animation_curve：动画的缓动曲线。
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 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。