SearchBar 继承自：LayoutControl, Control, BaseControl

管理一个「搜索视图」路由，让用户能够为某个搜索查询从建议补全中选择一个。

示例：

ft.SearchBar(bar_hint_text="Search...")

示例

import flet as ft

colors = [
    "Amber",
    "Blue Grey",
    "Brown",
    "Deep Orange",
    "Green",
    "Light Blue",
    "Orange",
    "Red",
]


def main(page: ft.Page):
    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER

    def build_tiles(items: list[str]) -> list[ft.Control]:
        return [
            ft.ListTile(
                title=ft.Text(item),
                data=item,
                on_click=handle_tile_click,
            )
            for item in items
        ]

    async def handle_tile_click(e: ft.Event[ft.ListTile]):
        await anchor.close_view()

    async def handle_change(e: ft.Event[ft.SearchBar]):
        query = e.control.value.strip().lower()
        matching = (
            [color for color in colors if query in color.lower()] if query else colors
        )
        anchor.controls = build_tiles(matching)

    def handle_submit(e: ft.Event[ft.SearchBar]):
        print(f"Submit: {e.data}")

    async def handle_tap(e: ft.Event[ft.SearchBar]):
        await anchor.open_view()

    anchor = ft.SearchBar(
        view_elevation=4,
        divider_color=ft.Colors.AMBER,
        bar_hint_text="Search colors...",
        view_hint_text="Choose a color from the suggestions...",
        on_change=handle_change,
        on_submit=handle_submit,
        on_tap=handle_tap,
        controls=build_tiles(colors),
    )

    page.add(ft.SafeArea(content=anchor))


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

属性

名称	类型	默认值	说明
controls	list[Control]	[]	处于搜索视图时显示在搜索栏下方的控件列表。 通常是 ListTile，并会显示在 ListView 中。
value	str	''	搜索栏中的文本。
bar_leading	Optional[Control]	None	搜索视图关闭时，显示在文本输入字段之前的控件。 通常是 Icon 或 IconButton。
bar_trailing	Optional[list[Control]]	None	搜索视图关闭时，显示在文本输入字段之后的控件列表。 这些控件可以表示额外的搜索方式（例如语音搜索）、头像或溢出菜单，通常不超过两个。
bar_hint_text	Optional[str]	None	定义搜索栏为空且搜索视图关闭时显示的文本。 通常是一些提示该字段接受何种输入的文本。
bar_bgcolor	Optional[ControlStateValue[ColorValue]]	None	定义搜索栏在所有或特定 ControlState 状态下的背景色。
bar_overlay_color	Optional[ControlStateValue[ColorValue]]	None	定义高亮颜色，通常用于表示搜索栏处于 FOCUSED、HOVERED 或 PRESSED 状态。
bar_shadow_color	Optional[ControlStateValue[ColorValue]]	None	搜索栏的阴影颜色。
bar_elevation	Optional[ControlStateValue[Optional[Number]]]	None	搜索栏的高度（elevation）。
bar_border_side	Optional[ControlStateValue[BorderSide]]	None	搜索栏轮廓的颜色和粗细。 此值与 bar_shape 结合，创建一个带轮廓装饰的形状。
bar_shape	Optional[ControlStateValue[OutlinedBorder]]	None	搜索栏的形状。 此形状与 bar_border_side 结合，创建一个带轮廓装饰的形状。
bar_text_style	Optional[ControlStateValue[TextStyle]]	None	用于正在编辑的文本的样式。
bar_hint_text_style	Optional[ControlStateValue[TextStyle]]	None	用于 bar_hint_text 的样式。
bar_padding	Optional[ControlStateValue[PaddingValue]]	None	搜索栏边界与其内容之间的内边距。
bar_scroll_padding	PaddingValue	20	配置文本字段滚动进入视图时，可滚动区域周围的内边距。 如果搜索栏的文本字段部分位于屏幕外或被遮盖（例如被键盘遮盖），它会滚动进入视图，并确保与可滚动区域边缘保持指定距离。
bar_size_constraints	Optional[BoxConstraints]	None	搜索栏可选的大小约束。
view_leading	Optional[Control]	None	搜索视图打开时，显示在文本输入字段之前的 Control。 通常是 Icon 或 IconButton。 默认是一个返回按钮，用于关闭／弹出搜索视图。
view_trailing	Optional[list[Control]]	None	搜索视图打开时，显示在文本输入字段之后的 Control 列表。 默认是一个关闭按钮，用于关闭／弹出搜索视图。
view_elevation	Optional[Number]	None	定义搜索视图的高度（elevation）。
view_bgcolor	Optional[ColorValue]	None	定义搜索视图的背景色。
view_hint_text	Optional[str]	None	定义搜索栏输入字段为空时显示的文本。
view_side	Optional[BorderSide]	None	定义搜索视图轮廓的颜色和粗细。
view_shape	Optional[OutlinedBorder]	None	定义搜索视图的形状。
view_header_text_style	Optional[TextStyle]	None	定义在搜索视图上正在编辑的文本的文本样式。
view_hint_text_style	Optional[TextStyle]	None	定义 view_hint_text 的文本样式。
view_size_constraints	Optional[BoxConstraints]	None	搜索视图可选的大小约束。 默认情况下，搜索视图与搜索栏宽度相同，高度为屏幕高度的 2/3。如果视图的宽度和高度都在 view_size_constraints 范围内，则视图显示默认尺寸。否则，视图的尺寸会受此属性约束。
view_header_height	Optional[Number]	None	搜索视图上搜索字段的高度。
view_padding	Optional[PaddingValue]	None	搜索视图使用的内边距。 如果搜索视图为全屏，则无效。
view_bar_padding	Optional[PaddingValue]	None	搜索视图的搜索栏使用的内边距。 若为 null，则水平方向的默认值为 8.0。
shrink_wrap	Optional[bool]	None	搜索视图是否应收缩包裹其内容。
divider_color	Optional[ColorValue]	None	搜索视图中的分隔线颜色。
capitalization	Optional[TextCapitalization]	None	启用输入文本的自动即时大写。
full_screen	bool	False	定义点击搜索栏时，搜索视图是否扩展以填满整个屏幕。
keyboard_type	KeyboardType	KeyboardType.TEXT	键盘使用的操作按钮类型。
autofocus	bool	False	如果当前没有其他控件获得焦点，文本字段是否应让自身获得焦点。
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_tap	Optional[ControlEventHandler['SearchBar']]	None	当点击搜索栏时调用。
on_tap_outside_bar	Optional[ControlEventHandler['SearchBar']]	None	当搜索栏已获得焦点且搜索视图关闭时，在搜索栏外部发生按下指针事件时触发。 这对应 on_tap_outside。若要在搜索视图打开时响应其外部的点击，请改用 on_tap_outside_view。
on_tap_outside_view	Optional[ControlEventHandler['SearchBar']]	None	当搜索视图打开时，用户点击其外部（例如点击使其关闭的周围遮罩）时触发。 点击视图自身的搜索字段或某个建议不会触发此事件。
on_submit	Optional[ControlEventHandler['SearchBar']]	None	当焦点在 SearchBar 上时用户按下 ENTER 键调用。
on_change	Optional[ControlEventHandler['SearchBar']]	None	当搜索栏中键入的输入发生变化时调用。
on_focus	Optional[ControlEventHandler['SearchBar']]	None	当搜索栏获得焦点时触发。
on_blur	Optional[ControlEventHandler['SearchBar']]	None	当搜索栏失去焦点时触发。
on_size_change	Optional[EventHandler[LayoutSizeChangeEvent['LayoutControl']]]	None	当此控件的尺寸发生变化时调用。 size_change_interval 定义此事件的调用频率。
on_animation_end	Optional[ControlEventHandler['LayoutControl']]	None	动画完成时调用。 可用于串联多个动画。 事件处理器参数的 data 属性包含动画名称。 更多信息见此处。

方法

名称	类型	默认值	说明
before_update	—	—	—
focus	—	—	为此控件请求焦点。
open_view	—	—	打开搜索视图。
close_view	—	—	关闭已打开的搜索视图。 参数： text：关闭视图时要在搜索栏中设置的文本。若未提供，则使用搜索栏当前的 value。
is_isolated	—	—	返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外，并需要自行管理更新边界。
init	—	—	在控件实例初始化之后、第一次 build / update 周期之前调用。 重写此钩子以执行依赖已初始化字段的轻量级设置。不要在此处调用 update()。
build	—	—	在控件初始化期间调用一次，用于定义其子控件。在此方法中 page 属性可用。
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 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。