mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00

* move doc dependency in doctools

* add ignore link

* rebuild doc

* version index

* put it back some deps

2021-03-03 14:08:15 +00:00

2.9 KiB

Raw Permalink Blame History

Title, Added, Status, Last reviewed

Title	Added	Status	Last reviewed
Search control component	v2.0.0	Active	2019-01-16

Search control component

Displays a input text that shows find-as-you-type suggestions.

Basic usage

<adf-search-control 
    [highlight]="true"
    (optionClicked)="onItemClicked($event)"
    (submit)="onSearchSubmit($event)">
</adf-search-control>

Transclusions

You can show your own custom template when no results are found for the search:

<adf-search-control [highlight]="true"
                    (optionClicked)="onItemClicked($event)"
                    (submit)="onSearchSubmit($event)">
    <adf-empty-search-result>
        <!-- YOUR CUSTOM TEMPLATE HERE -->
        <span>YOUR CUSTOM MESSAGE</span>
    </adf-empty-search-result>
</adf-search-control>

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.
liveSearchMaxResults	`number`	5	Maximum number of results to show in the live search.

Events

Name	Type	Description
optionClicked	`EventEmitter<any>`	Emitted when a file item from the list of "find-as-you-type" results is selected.
searchChange	`EventEmitter<string>`	Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string.
submit	`EventEmitter<any>`	Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event.

Details

Below is an example of a component that uses the search control. In this example the search term is simply logged to the console. However, the component could instead emit an event to be consumed upstream,or it could trigger a change inside a search results component embedded inside the same component.

<adf-search-control 
    [highlight]="true"
    (optionClicked)="onItemClicked($event)"
    (submit)="onSearchSubmit($event)">
</adf-search-control>

2.9 KiB Raw Permalink Blame History