inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +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
docs/search.component.md
+12 -10
View File
@@ -13,19 +13,21 @@ Searches items for supplied search terms.
### 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](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md) | | 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](search-configuration.interface.md) |
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| displayWith | `(value: any) => string` | `null` | Function that maps an option's value to its display value in the trigger. |
| maxResults | `number` | `20` | Maximum number of results to show in the search. |
| skipResults | `number` | `0` | Number of results to skip from the results pagination. |
| queryBody | `QueryBody` | | |
| searchTerm | `string` | `''` | Search term to use when executing the search. Updating this value will run a new search and update the results. |
| classList | `string` | | CSS class for display. |
### Events
| Name | Description |
| ---- | ----------- |
| resultLoaded | Emitted when search results have fully loaded |
| Name | Type | Description |
| ---- | ---- | ----------- |
| resultLoaded | `EventEmitter<NodePaging>` | Emitted when search results have fully loaded. |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
## Details