AutoSuggestBox QML Type
A text input field with auto-completion suggestions. More...
| Import Statement: | import FluentUI.Controls 1.0 |
Properties
- filter : function
- items : list
- maximumCount : int
- noResultsMessage : string
- placeholderText : string
- text : string
- textRole : var
Signals
- void tap(var data)
Detailed Description
AutoSuggestBox displays a filtered list of suggestions as the user types. The suggestion list can be customized with a filter function, a maximum number of visible items, and a fallback message when no results match.
Property Documentation
filter : function
A custom filter function that determines which items match the current input. The function receives each item and the current text, and should return true if the item should appear as a suggestion.
items : list
The full list of candidate items used for auto-completion.
maximumCount : int
The maximum number of suggestions shown at once. Defaults to 8.
noResultsMessage : string
The message displayed when no suggestions match the current input.
placeholderText : string
The placeholder text shown when the input is empty.
text : string
The current text in the input field.
textRole : var
The role or property name used to extract display text from each item.
Signal Documentation
void tap(var data)
Emitted when the user selects a suggestion. The data parameter carries the selected item data.
Note: The corresponding handler is onTap.