Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
flet / controls / material / search_bar.py
Size: Mime:
from dataclasses import field
from typing import Optional

from flet.controls.base_control import control
from flet.controls.border import BorderSide
from flet.controls.box import BoxConstraints
from flet.controls.buttons import OutlinedBorder
from flet.controls.control import Control
from flet.controls.control_event import ControlEventHandler
from flet.controls.control_state import ControlStateValue
from flet.controls.layout_control import LayoutControl
from flet.controls.material.textfield import KeyboardType, TextCapitalization
from flet.controls.padding import PaddingValue
from flet.controls.text_style import TextStyle
from flet.controls.types import (
    ColorValue,
    Number,
)

__all__ = ["SearchBar"]


@control("SearchBar")
class SearchBar(LayoutControl):
    """
    Manages a "search view" route that allows the user to select one of the suggested
    completions for a search query.
    """

    controls: list[Control] = field(default_factory=list)
    """
    The list of controls to be displayed below the search bar when in search view.
    These controls are usually [`ListTile`][flet.ListTile]s and will be displayed
    in a [`ListView`][flet.ListView].
    """

    value: str = ""
    """
    The text in the search bar.
    """

    bar_leading: Optional[Control] = 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_trailing: Optional[list[Control]] = None
    """
    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.
    """

    bar_hint_text: Optional[str] = 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_bgcolor: Optional[ControlStateValue[ColorValue]] = None
    """
    Defines the background color of the
    search bar in all or specific
    [`ControlState`][flet.ControlState] states.
    """

    bar_overlay_color: Optional[ControlStateValue[ColorValue]] = None
    """
    Defines the highlight color that's
    typically used to indicate that the search bar is in `FOCUSED`, `HOVERED`, or
    `PRESSED` [`ControlState`][flet.ControlState]
    states.
    """

    bar_shadow_color: Optional[ControlStateValue[ColorValue]] = None
    """
    The shadow color of the search bar.
    """

    bar_elevation: Optional[ControlStateValue[Optional[Number]]] = None
    """
    The elevation of the search bar.
    """

    bar_border_side: Optional[ControlStateValue[BorderSide]] = None
    """
    The color and weight of the search bar's outline.

    This value is combined with [`SearchBar.bar_shape`][flet.SearchBar.bar_shape] to
    create a shape decorated with an outline.
    """

    bar_shape: Optional[ControlStateValue[OutlinedBorder]] = None
    """
    The shape of the search bar.

    This shape is combined with
    [`SearchBar.bar_border_side`][flet.SearchBar.bar_border_side] to create a shape
    decorated with an outline.
    """

    bar_text_style: Optional[ControlStateValue[TextStyle]] = None
    """
    The style to use for the text being edited.
    """

    bar_hint_text_style: Optional[ControlStateValue[TextStyle]] = None
    """
    The style to use for the [`SearchBar.bar_hint_text`][flet.SearchBar.bar_hint_text].
    """

    bar_padding: Optional[ControlStateValue[PaddingValue]] = None
    """
    The padding between the search bar's boundary and its contents.
    """

    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_size_constraints: Optional[BoxConstraints] = None
    """
    Optional size constraints for the search bar.
    """

    view_leading: Optional[Control] = 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_trailing: Optional[list[Control]] = None
    """
    A list of `Control`s to display after the text input field when the search view is
    open.

    Defaults to a close button which closes/pops the search view.
    """

    view_elevation: Optional[Number] = None
    """
    Defines the elevation of the search view.
    """

    view_bgcolor: Optional[ColorValue] = None
    """
    Defines the background color of the
    search view.
    """

    view_hint_text: Optional[str] = None
    """
    Defines the text to be displayed when the search bar's input field is empty.
    """

    view_side: Optional[BorderSide] = None
    """
    Defines the color and weight of the search view's outline.
    """

    view_shape: Optional[OutlinedBorder] = None
    """
    Defines the shape of the search view.
    """

    view_header_text_style: Optional[TextStyle] = None
    """
    Defines the [`TextStyle`][flet.TextStyle] of the
    text being edited on the search view.
    """

    view_hint_text_style: Optional[TextStyle] = None
    """
    Defines the [`TextStyle`][flet.TextStyle] of
    `view_hint_text`.
    """

    view_size_constraints: Optional[BoxConstraints] = None
    """
    Optional size constraints for the search view.

    By default, the search view has the same width as the search bar and is 2/3 the
    height of the screen. If the width and height of the view are within the
    view_size_constraints, the view will show its default size. Otherwise, the size of
    the view will be constrained by this property.
    """

    view_header_height: Optional[Number] = None
    """
    The height of the search field on the search view.
    """

    view_padding: Optional[PaddingValue] = None
    """
    The padding to use for the search view.

    Has no effect if the search view is full-screen.
    """

    view_bar_padding: Optional[PaddingValue] = None
    """
    The padding to use for the search view's search bar.

    If null, then the default value is 8.0 horizontally.
    """

    shrink_wrap: Optional[bool] = None
    """
    Whether the search view should shrink-wrap its contents.
    """

    divider_color: Optional[ColorValue] = None
    """
    The color of the divider when in search view.
    """

    capitalization: Optional[TextCapitalization] = None
    """
    Enables automatic on-the-fly capitalization of entered text.
    """

    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 = KeyboardType.TEXT
    """
    The type of action button to use for the keyboard.
    """

    autofocus: bool = False
    """
    Whether the text field should focus itself if nothing else is already focused.

    Defaults to `False`.
    """

    on_tap: Optional[ControlEventHandler["SearchBar"]] = None
    """
    Called when the search bar is tapped.
    """

    on_tap_outside_bar: Optional[ControlEventHandler["SearchBar"]] = None
    """
    TBD
    """

    on_submit: Optional[ControlEventHandler["SearchBar"]] = None
    """
    Called when user presses ENTER while focus is on SearchBar.
    """

    on_change: Optional[ControlEventHandler["SearchBar"]] = None
    """
    Called when the typed input in the search bar has changed.
    """

    on_focus: Optional[ControlEventHandler["SearchBar"]] = None
    """
    TBD
    """

    on_blur: Optional[ControlEventHandler["SearchBar"]] = None
    """
    TBD
    """

    def __contains__(self, item):
        return item in self.controls

    def before_update(self):
        super().before_update()

    # Public methods
    async def focus(self):
        await self._invoke_method("focus")

    async def blur(self):
        await self._invoke_method("blur")

    async def open_view(self):
        await self._invoke_method("open_view")

    async def close_view(self, text: Optional[str] = None):
        await self._invoke_method(
            "close_view", {"text": text if text is not None else self.value}
        )