Checkbox 继承自：LayoutControl, AdaptiveControl, Control, BaseControl

Checkbox 允许从一组选项中选出一个或多个条目，或在两个互斥选项之间切换（选中或未选中、开或关）。

ft.Checkbox()
ft.Checkbox(label="Checked", value=True)
ft.Checkbox(label="Disabled", disabled=True)

示例

import flet as ft


def main(page: ft.Page):
    def handle_button_click(e: ft.Event[ft.Button]):
        message.value = (
            f"Checkboxes values are:  {c1.value}, {c2.value}, {c3.value}, "
            f"{c4.value}, {c5.value}."
        )

    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    c1 := ft.Checkbox(
                        label="Unchecked by default checkbox", value=False
                    ),
                    c2 := ft.Checkbox(
                        label="Undefined by default tristate checkbox", tristate=True
                    ),
                    c3 := ft.Checkbox(label="Checked by default checkbox", value=True),
                    c4 := ft.Checkbox(label="Disabled checkbox", disabled=True),
                    c5 := ft.Checkbox(
                        label="Checkbox with LEFT label_position",
                        label_position=ft.LabelPosition.LEFT,
                    ),
                    ft.Button(content="Submit", on_click=handle_button_click),
                    message := ft.Text(),
                ]
            )
        )
    )


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

import flet as ft


def main(page: ft.Page):
    events = ft.Column()

    def handle_checkbox_change(e: ft.Event[ft.Checkbox]):
        events.controls.append(ft.Text(f"Checkbox value changed to {e.control.value}"))

    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    ft.Checkbox(
                        label="Checkbox with 'change' event",
                        on_change=handle_checkbox_change,
                    ),
                    events,
                ]
            )
        )
    )


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

import flet as ft


def main(page: ft.Page):
    page.add(
        ft.SafeArea(
            content=ft.Column(
                controls=[
                    ft.Checkbox(label="Checkbox with default style"),
                    ft.Checkbox(
                        label="Checkbox with constant fill color",
                        fill_color=ft.Colors.RED,
                        check_color=ft.Colors.YELLOW,
                    ),
                    ft.Row(
                        controls=[
                            ft.Checkbox(
                                key="dynamic_fill_checkbox",
                                fill_color={
                                    ft.ControlState.HOVERED: ft.Colors.BLUE,
                                    ft.ControlState.SELECTED: ft.Colors.GREEN,
                                    ft.ControlState.DEFAULT: ft.Colors.RED,
                                },
                            ),
                            ft.Text("Checkbox with dynamic fill color"),
                        ],
                    ),
                ]
            )
        ),
    )


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

属性

名称	类型	默认值	说明
label	Optional[StrOrControl]	None	显示在 Checkbox 右侧的可点击标签。
value	Optional[bool]	False	此 Checkbox 的值。 - 若为 True，则此 Checkbox 处于选中状态。 - 若为 False，则此 Checkbox 处于未选中状态。 - 若为 None 且 tristate 为 True，则此 Checkbox 处于不确定状态（显示为短横线）。
label_position	LabelPosition	LabelPosition.RIGHT	定义 label 应显示在 Checkbox 的哪一侧。
label_style	Optional[TextStyle]	None	label 的文本样式。
tristate	bool	False	若为 True，则此 Checkbox 的 value 可以是 True、False 或 None。
autofocus	bool	False	若设为 True，则此控件会被选为初始焦点。如果页面上有多个设置了 autofocus 的控件，则最先添加到页面的控件会获得焦点。
fill_color	Optional[ControlStateValue[ColorValue]]	None	在所有或特定 ControlState 下填充此 Checkbox 的颜色。 注意： 支持的状态：SELECTED、HOVERED、DISABLED、FOCUSED 和 DEFAULT。
overlay_color	Optional[ControlStateValue[ColorValue]]	None	此 Checkbox 的叠加层在各种 ControlState 状态下的颜色。 注意： 支持的状态：PRESSED、SELECTED、HOVERED、FOCUSED 和 DEFAULT。
check_color	Optional[ColorValue]	None	当此 Checkbox 被选中时用于勾选图标的颜色。
active_color	Optional[ColorValue]	None	此 Checkbox 被选中时使用的颜色。
hover_color	Optional[ColorValue]	None	此 Checkbox 被鼠标悬停时使用的颜色。
focus_color	Optional[ColorValue]	None	此 Checkbox 获得输入焦点时其 Material 的颜色。若 overlay_color 在 FOCUSED 状态下返回非 None 颜色，则改为使用该颜色。 默认为 FOCUSED 状态下的 overlay_color；若其为 None，则回退到 focus_color。
semantics_label	Optional[str]	None	Checkbox 的语义标签，不在 UI 中显示，但会在无障碍模式（如 TalkBack/VoiceOver）下由屏幕阅读器朗读。
shape	Optional[OutlinedBorder]	None	Checkbox 的形状。 默认为 shape；若其为 None，则回退到 RoundedRectangleBorder(radius=2)。
splash_radius	Optional[Number]	None	圆形 Material 墨水响应（水波纹）的半径（逻辑像素）。 默认为 splash_radius；若其为 None，则回退到 20.0。
border_side	Optional[ControlStateValue[BorderSide]]	None	此 Checkbox 的边框在所有或特定 ControlState 下的颜色和宽度。 默认为 border_side；若其为 None，则回退到宽度为 2.0 的 BorderSide。 注意： 支持的状态：SELECTED、HOVERED、DISABLED、FOCUSED、PRESSED、ERROR 和 DEFAULT。
error	bool	False	此 Checkbox 是否要显示错误状态。 若为 True，则此 Checkbox 将使用不同的默认容器颜色和勾选颜色。
visual_density	Optional[VisualDensity]	None	定义 Checkbox 布局的紧凑程度。
mouse_cursor	Optional[MouseCursor]	None	鼠标指针进入或悬停在此 Checkbox 上时显示的光标。 默认为 mouse_cursor；若其为 None，则回退到 MouseCursor.CLICK。
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	启用平台特定渲染，或从父控件继承自适应能力。

只读属性

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

事件

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

方法

名称	类型	默认值	说明
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 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。