alfresco-ng2-components/docs/core/components/search-text-input.component.md
Silviu Popa f20b78a2c5 [AAE-534] Search - extract search text input from SearchControlComponent (#5213)
* [AAE-534] - add search cloud component

* change doc file

* more changes on doc file

* remove empty scss file

* add animation and more customizations

* add preselect value property

* fix unit tests

* [AAE-534] Search - extract search text input from SearchControlComponent

* rename component and fix build

* fix import scss and lint

* change in doc files

* PR changes

* more changes

* add return type

* fix unit test
2019-11-12 20:22:48 +01:00

2.5 KiB

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

Text Widget

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
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
reset EventEmitter<any> Emitted when the search widget is reseted