/ docs / guides / components / autocomplete.rst
autocomplete.rst
 1  Autocomplete
 2  ============
 3  A material design TextBox with autocomplete. A subclass of TextBox - other properties, events and methods inherited from TextBox.
 4  
 5  Properties
 6  ----------
 7  
 8  :suggestions: list[str]
 9  
10      A list of autocomplete suggestions
11  
12  :suggest_if_empty: bool
13  
14      If True then autocomplete will show all options when the textbox is empty
15  
16  :filter_mode: "contains" | "startswith"
17  
18      contains: the autocomplete component will filter if a suggestion contains the search term.
19      startswith: the autocomplete component will filter if a suggestions starts with the search term.
20  
21  Events
22  ------
23  
24  :suggestion_clicked:
25  
26      When a suggestion is clicked. If a suggestion is selected with enter the ``pressed_enter`` event fires instead.