AutoComplete

Examples

Live example

Basic example

import flet as ft


def main(page: ft.Page):
    page.add(
        ft.AutoComplete(
            on_select=lambda e: print(e.control.selected_index, e.selection),
            suggestions=[
                ft.AutoCompleteSuggestion(key="one 1", value="One"),
                ft.AutoCompleteSuggestion(key="two 2", value="Two"),
                ft.AutoCompleteSuggestion(key="three 3", value="Three"),
            ],
        ),
        ft.Text("Type in 1, 2 or 3 to receive suggestions."),
    )


ft.run(main)

AutoComplete

Bases: Control

Helps the user make a selection by entering some text and choosing from among a list of displayed options.

badge

badge: BadgeValue | None = None

A badge to show on top of this control.

col

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

data

data: Any = skip_field()

Arbitrary data of any type.

disabled

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.

Example

For example, if you have a form with multiple entry controls you can disable them all together by disabling container:

ft.Column(
    disabled = True,
    controls=[
        ft.TextField(),
        ft.TextField()
    ]
)

expand

expand: bool | int | None = None

Specifies whether/how this control should expand to fill available space in its parent layout.

More information here.

Note

Has effect only if the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

expand_loose

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.

Note

If expand_loose is True, it will have effect only if:

• expand is not None and
• the direct parent of this control is one of the following controls, or their subclasses: Column, Row, View, Page.

key

key: (
    str | int | float | bool | ValueKey | ScrollKey | None
) = None

on_select

on_select: EventHandler[AutoCompleteSelectEvent] | None = (
    None
)

Called when a suggestion is selected.

opacity

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).

page

page: Page | PageView | None

The page (of type Page or PageView) to which this control belongs to.

parent

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.

rtl

rtl: bool = False

Whether the text direction of the control should be right-to-left (RTL).

selected_index

selected_index

suggestions

suggestions: list[AutoCompleteSuggestion] = field(
    default_factory=list
)

A list of AutoCompleteSuggestion controls representing the suggestions to be displayed.

Note

• The internal filtration process of the suggestions (based on their keys) with respect to the user's input is case-insensitive because the comparison is done in lowercase.
• A valid AutoCompleteSuggestion must have at least a key or value specified, else it will be ignored. If only key is provided, value will be set to key as fallback and vice versa.

suggestions_max_height

suggestions_max_height: Number = 200

The maximum - visual - height of the suggestions list.

tooltip

tooltip: TooltipValue | None = None

The tooltip ot show when this control is hovered over.

visible

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.

before_event

before_event(e: ControlEvent)

before_update

before_update()

clean

clean() -> None

did_mount

did_mount()

init

init()

is_isolated

is_isolated()

update

update() -> None

will_unmount

will_unmount()