inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added JSDocs and prop tables (#2898)

Browse Source
This commit is contained in:
Andy Stark
2018-01-31 17:40:28 +00:00
committed by Eugenio Romano
parent 0d93c65fd7
commit dd7afc65db
11 changed files with 99 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
lib/content-services/search/components/search.component.ts
View File

@@ -51,12 +51,15 @@ export class SearchComponent implements AfterContentInit, OnChanges {
@ContentChild(TemplateRef)
template: TemplateRef<any>;
/** Function that maps an option's value to its display value in the trigger. */
@Input()
displayWith: ((value: any) => string) | null = null;
/** Maximum number of results to show in the search. */
@Input()
maxResults: number = 20;
/** Number of results to skip from the results pagination. */
@Input()
skipResults: number = 0;
@@ -64,9 +67,13 @@ export class SearchComponent implements AfterContentInit, OnChanges {
@Input()
queryBody: QueryBody;
/** Search term to use when executing the search. Updating this value will
* run a new search and update the results.
*/
@Input()
searchTerm: string = '';
/** CSS class for display. */
@Input('class')
set classList(classList: string) {
if (classList && classList.length) {
@@ -75,9 +82,11 @@ export class SearchComponent implements AfterContentInit, OnChanges {
}
}
/** Emitted when search results have fully loaded. */
@Output()
resultLoaded: EventEmitter<NodePaging> = new EventEmitter();
/** Emitted when an error occurs. */
@Output()
error: EventEmitter<any> = new EventEmitter();