SearchBar
Examples#
Basic Example#
import flet as ft
def main(page: ft.Page):
def handle_tile_click(e: ft.Event[ft.ListTile]):
anchor.close_view(e.control.title.value)
def handle_change(e: ft.Event[ft.SearchBar]):
print(f"handle_change e.data: {e.data}")
def handle_submit(e: ft.Event[ft.SearchBar]):
print(f"handle_submit e.data: {e.data}")
def handle_tap(e: ft.Event[ft.SearchBar]):
print("handle_tap")
anchor.open_view()
page.add(
ft.Row(
alignment=ft.MainAxisAlignment.CENTER,
controls=[
ft.OutlinedButton(
content="Open Search View",
on_click=lambda _: 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=[
ft.ListTile(title=ft.Text(f"Color {i}"), on_click=handle_tile_click)
for i in range(10)
],
),
)
ft.run(main)
Bases: ConstrainedControl
Manages a "search view" route that allows the user to select one of the suggested completions for a search query.
animate_offset: AnimationValue | None = None
animate_opacity: AnimationValue | None = None
animate_position: AnimationValue | None = None
animate_rotation: AnimationValue | None = None
animate_scale: AnimationValue | None = None
autofocus: bool = False
Whether the text field should focus itself if nothing else is already focused.
Defaults to False.
bar_bgcolor: ControlStateValue[ColorValue] | None = None
Defines the background color of the
search bar in all or specific
ControlState states.
bar_hint_text: str | None = None
Defines the text to be shown in the search bar when it is empty and the search view is close. Usually some text that suggests what sort of input the field accepts.
bar_leading: Control | None = None
A control to display before the text input field when the search view is close.
This is typically an Icon or an IconButton.
bar_overlay_color: ControlStateValue[ColorValue] | None = (
None
)
Defines the highlight color that's
typically used to indicate that the search bar is in FOCUSED, HOVERED, or
PRESSED ControlState
states.
bar_scroll_padding: PaddingValue = 20
Configures the padding around a Scrollable when the text field scrolls into view.
If the bar's text field is partially off-screen or covered (e.g., by the keyboard), it scrolls into view, ensuring it is positioned at the specified distance from the Scrollable edges.
bar_surface_tint_color: (
ControlStateValue[ColorValue] | None
) = None
TBD
A list of controls to display after the text input field when the search view is close.
These controls can represent additional modes of searching (e.g voice search), an avatar, or an overflow menu and are usually not more than two.
bottom: Number | None = None
The distance that the child's bottom edge is inset from the bottom of the stack.
Note
Effective only if this control is a descendant of one of the following:
Stack control, Page.overlay list.
capitalization: TextCapitalization | None = None
Enables automatic on-the-fly capitalization of entered text.
col: ResponsiveNumber = 12
If a parent of this control is a ResponsiveRow,
this property is used to determine
how many virtual columns of a screen this control will span.
Can be a number or a dictionary configured to have a different value for specific
breakpoints, for example col={"sm": 6}.
This control spans the 12 virtual columns by default.
Dimensions
| Breakpoint | Dimension |
|---|---|
| xs | <576px |
| sm | ≥576px |
| md | ≥768px |
| lg | ≥992px |
| xl | ≥1200px |
| xxl | ≥1400px |
disabled: bool = False
Every control has disabled property which is False by default - control and all
its children are enabled.
Note
The value of this property will be propagated down to all children controls recursively.
divider_color: ColorValue | None = None
The color of the divider when in search view.
expand_loose: bool = False
Allows the control to expand along the main axis if space is available, but does not require it to fill all available space.
More information here.
full_screen: bool = False
Defines whether the search view grows to fill the entire screen when the search
bar is tapped. Defaults to False.
keyboard_type: KeyboardType = TEXT
The type of action button to use for the keyboard.
left: Number | None = None
The distance that the child's left edge is inset from the left of the stack.
Note
Effective only if this control is a descendant of one of the following:
Stack control, Page.overlay list.
offset: OffsetValue | None = None
Applies a translation transformation before painting the control.
The translation is expressed as an Offset scaled to the control's size.
So, Offset(x=0.25, y=0), for example, will result in a horizontal translation
of one quarter the width of this control.
Example
The following example displays container at 0, 0 top left corner of a stack as
transform applies -1 * 100, -1 * 100 (offset * control's size) horizontal and
vertical translations to the control:
on_animation_end: (
ControlEventHandler[ConstrainedControl] | None
) = None
Called when animation completes.
Can be used to chain multiple animations.
The data property of the event handler argument contains the name of the animation.
More information here.
on_change: ControlEventHandler[SearchBar] | None = None
Called when the typed input in the search bar has changed.
on_submit: ControlEventHandler[SearchBar] | None = None
Called when user presses ENTER while focus is on SearchBar.
opacity: Number = 1.0
Defines the transparency of the control.
Value ranges from 0.0 (completely transparent) to 1.0 (completely opaque
without any transparency).
The page (of type Page or PageView) to which this control belongs to.
parent: BaseControl | None
The direct ancestor(parent) of this control.
It defaults to None and will only have a value when this control is mounted (added to the page tree).
The Page control (which is the root of the tree) is an exception - it always has parent=None.
right: Number | None = None
The distance that the child's right edge is inset from the right of the stack.
Note
Effective only if this control is a descendant of one of the following:
Stack control, Page.overlay list.
rotate: RotateValue | None = None
Transforms this control using a rotation around its center.
The value of rotate property could be one of the following types:
number- a rotation in clockwise radians. Full circle360°ismath.pi * 2radians,90°ispi / 2,45°ispi / 4, etc.Rotate- allows to specify rotationangleas well asalignment- the location of rotation center.
scale: ScaleValue | None = None
Scales this control along the 2D plane. Default scale factor is 1.0, meaning no-scale.
Setting this property to 0.5, for example, makes this control twice smaller, while 2.0 makes it twice larger.
Different scale multipliers can be specified for x and y axis, by setting
Control.scale property to an instance of Scale class.
Either scale or scale_x and scale_y could be specified, but not all of them.
tooltip: TooltipValue | None = None
The tooltip ot show when this control is hovered over.
top: Number | None = None
The distance that the child's top edge is inset from the top of the stack.
Note
Effective only if this control is a descendant of one of the following:
Stack control, Page.overlay list.
view_bgcolor: ColorValue | None = None
Defines the background color of the search view.
view_header_text_style: TextStyle | None = None
Defines the TextStyle of the
text being edited on the search view.
view_hint_text: str | None = None
Defines the text to be displayed when the search bar's input field is empty.
view_hint_text_style: TextStyle | None = None
Defines the TextStyle of
view_hint_text.
view_leading: Control | None = None
A Control to display before the text input field when the search view is open.
Typically an Icon or an IconButton.
Defaults to a back button which closes/pops the search view.
view_side: BorderSide | None = None
Defines the color and weight of the search view's outline.
view_surface_tint_color: ColorValue | None = None
Defines the color of the search view's surface tint.
A list of Controls to display after the text input field when the search view is
open.
Defaults to a close button which closes/pops the search view.
visible: bool = True
Every control has visible property which is True by default - control is
rendered on the page. Setting visible to False completely prevents control (and
all its children if any) from rendering on a page canvas. Hidden controls cannot be
focused or selected with a keyboard or mouse and they do not emit any events.