alfresco-ng2-components/docs/core/components/search-text-input.component.md

Title, Added, Status, Last reviewed

Title	Added	Status	Last reviewed
Search Text Input Component	v3.6.0	Active	2019-11-06

Search Text Input Component

Displays a input text that supports autocompletion

Basic Usage

<adf-search-text-input
    [expandable]="true"
    [autocomplete]="autocomplete"
    [liveSearchEnabled]="liveSearchEnabled"
    (searchChange)="onSearchChanged($event)">
</adf-search-text-input>

Class members

Properties

Name	Type	Default value	Description
autocomplete	boolean	false	Toggles auto-completion of the search input field.
expandable	boolean	true	Toggles whether to use an expanding search control. If false then a regular input is used.
highlight	boolean	false	Toggles highlighting of the search term in the results.
inputType	string	"text"	Type of the input field to render, e.g. "search" or "text" (default).
liveSearchEnabled	boolean	true	Toggles "find-as-you-type" suggestions for possible matches.
searchAutocomplete	SearchTriggerDirective	null	Trigger autocomplete results on input change
searchTerm	string	empty	Preselected search widget value
debounceTime	number	0	Debounce time in miliseconds
collapseOnSubmit	boolean	true	Collapse search bar on submit
focusListener	Observable < FocusEvent >	null	Listener for results-list events (focus, blur and focusout)
defaultState	SearchTextStateEnum	collapsed	Default state of the search widget

Events

Name	Type	Description
searchChange	EventEmitter<string>	Emitted when search widget value is changed.
submit	EventEmitter<any>	Emitted when search widget is submited.
selectResult	EventEmitter<any>	Emitted when the result list is selected
reset	EventEmitter<any>	Emitted when the search widget is reseted