alfresco-ng2-components/docs/search.component.md

Search component

Searches items for supplied search terms.

Basic usage

<adf-search 
    [searchTerm]="searchTerm"
    (resultLoaded)="showSearchResult($event)">
</adf-search>

Properties

Name	Type	Default	Description
searchTerm	string		Search term to use when executing the search. Updating this value will run a new search and update the results
maxResults	number	20	Maximum number of results to show in the search.
skipResults	number	0	Number of results to skip from the results pagination.
displayWith	function		Function that maps an option's value to its display value in the trigger
queryBody	QueryBody		object which allow you to perform more elaborated query from the search api. This input is deprecated, to use the extended query body function please refer to the suggested solution here

Events

Name	Description
resultLoaded	Emitted when search results have fully loaded

Details

Customise Search Results

You have to add a template that will be shown when the results are loaded.

<adf-search [searchTerm]="searchTerm">
    <ng-template let-result>
        <ul>
            <li *ngFor="let item of result?.list?.entries">
                {{ item?.entry.name }}
            </li>
        </ul>
    </ng-template>
</adf-search>

The results are provided via the $implicit variable of angular2 and can be accessed via the sugar sintax 'let-yourChosenName'. As per example above the result will be something like :

But you can define even a more complex template :

<adf-search class="adf-search-result-autocomplete"
            [rootNodeId]="liveSearchRoot"
            [resultType]="liveSearchResultType"
            [resultSort]="liveSearchResultSort"
            [maxResults]="liveSearchMaxResults">
    <ng-template let-data>
        <mat-list *ngIf="isSearchBarActive()" id="autocomplete-search-result-list">
            <mat-list-item
                *ngFor="let item of data?.list?.entries; let idx = index"
                id="result_option_{{idx}}"
                [tabindex]="0"
                (focus)="onFocus($event)"
                (blur)="onBlur($event)"
                class="adf-search-autocomplete-item"
                (click)="elementClicked(item)"
                (keyup.enter)="elementClicked(item)">
                <mat-icon mat-list-icon>
                    <img [src]="getMimeTypeIcon(item)" />
                </mat-icon>
                    <h4 mat-line id="result_name_{{idx}}"
                        *ngIf="highlight; else elseBlock"
                        class="adf-search-fixed-text"
                        [innerHtml]="item.entry.name | highlight: searchTerm">
                        {{ item?.entry.name }}</h4>
                    <ng-template #elseBlock>
                        <h4 class="adf-search-fixed-text" mat-line id="result_name_{{idx}}" [innerHtml]="item.entry.name"></h4>
                    </ng-template>
                    <p mat-line class="adf-search-fixed-text"> {{item?.entry.createdByUser.displayName}} </p>
            </mat-list-item>
            <mat-list-item
                id="search_no_result"
                *ngIf="data?.list?.entries.length === 0">
                <p mat-line class="adf-search-fixed-text">{{ 'SEARCH.RESULTS.NONE' | translate:{searchTerm: searchTerm} }}</p>
            </mat-list-item>
        </mat-list>
    </ng-template>
</adf-search>

Which will look like :

Attach an input field to the search

You can also attach your input field to the adf-search component via the trigger [searchAutocomplete] Yuo can do this by exporting the adf-search panel instance into a local template variable (here we called it "search"), and binding that variable to the input's searchAutocomplete property.

<input type="text" [searchAutocomplete]="search">

<adf-search #search="searchAutocomplete">
    <ng-template let-result>
        <span *ngFor="let item of result?.list?.entries">
            {{ item?.entry.name }}
        </span>
    </ng-template>
</adf-search>        

In this way it is possible to fetch the results from the word typed into the input text straight into the adf-search component via the custom template variable.

QueryBody

This is an example on how you can provide your own class to generate your custom query body without giving it in input to the search component.

1. Service Class You need to create your own service class which will implement the SearchConfigurationInterface this will force you to create the method generateQueryBody that is the one which needs to return the QueryBody object.

   import { QueryBody } from 'alfresco-js-api';
   import { SearchConfigurationInterface } from '@alfresco/adf-core';
   
   export class TestSearchConfigurationService implements SearchConfigurationInterface {
   
       constructor() {
       }
   
       public generateQueryBody(searchTerm: string, maxResults: string, skipCount: string): QueryBody {
           const defaultQueryBody: QueryBody = {
               query: {
                   query: searchTerm ? `${searchTerm}* OR name:${searchTerm}*` : searchTerm
               },
               include: ['path', 'allowableOperations'],
               paging: {
                   maxItems: maxResults,
                   skipCount: skipCount
               },
               filterQueries: [
                   { query: "TYPE:'cm:folder'" },
                   { query: 'NOT cm:creator:System' }]
           };
   
           return defaultQueryBody;
       }
   }
   

2. Provide your service class to the module Once you have created your service class to provide your custom query body you need to inform the component to use your class instead of the default one. This can be easily achieved via your component providers :

       import { SearchService, SearchConfigurationService } from '@alfresco/adf-core';
       import { TestSearchConfigurationService } from './search-config-test.service';
   
       @Component({
           selector: 'app-search-extended-component',
           templateUrl: './search-extended.component.html',
           styleUrls: ['./search-extended.component.scss'],
           encapsulation: ViewEncapsulation.None,
           providers: [
               { provide: SearchConfigurationService, useClass: TestSearchConfigurationService },
               SearchService
           ]
       })
   

   You need to add as provider even the SearchService to avoid the override of the module instance. So this component will have his own instance of the SearchService that will use as configuration the class you have provided.