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

readme search fix types

Browse Source
This commit is contained in:
Eugenio Romano
2017-07-12 23:18:11 +01:00
committed by Eugenio Romano
parent 8cdb276dc4
commit 8e2b022b6b
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
ng2-components/ng2-alfresco-search/README.md
View File

@@ -59,10 +59,10 @@ results component embedded inside the same component.
| expandable | boolean | true | Whether to use an expanding search control, if false then a regular input is used. |
| autocomplete | boolean | true | Whether the browser should offer field auto-completion for the input field to the user. |
| liveSearchEnabled | boolean | true | Whether find-as-you-type suggestions should be offered for matching content items. Set to false to disable. |
| liveSearchRoot | boolean | "-root-" | NodeRef or node name where the search should start. |
| liveSearchResultType | boolean | | Node type to filter live search results by, e.g. 'cm:content'. |
| liveSearchMaxResults | boolean | 5 | Maximum number of results to show in the live search. |
| liveSearchResultSort | boolean | | Criteria to sort live search results by, must be one of "name" , "modifiedAt" or "createdAt" |
| liveSearchRoot | string | "-root-" | NodeRef or node name where the search should start. |
| liveSearchResultType | string | | Node type to filter live search results by, e.g. 'cm:content'. |
| liveSearchMaxResults | number | 5 | Maximum number of results to show in the live search. |
| liveSearchResultSort | string | | Criteria to sort live search results by, must be one of "name" , "modifiedAt" or "createdAt" |
## Events
@@ -90,10 +90,10 @@ results page will be shown.
| Name | Type | Optional | Default | Description |
| --- | --- | --- | --- | --- |
| searchTerm | string | | Search term to use when executing the search. Updating this value will run a new search and update the results |
| rootNodeId | boolean | "-root-" | NodeRef or node name where the search should start. |
| resultType | boolean | | Node type to filter search results by, e.g. 'cm:content'. |
| maxResults | boolean | 20 | Maximum number of results to show in the search. |
| resultSort | boolean | | Criteria to sort search results by, must be one of "name" , "modifiedAt" or "createdAt" |
| rootNodeId | string | "-root-" | NodeRef or node name where the search should start. |
| resultType | string | | Node type to filter search results by, e.g. 'cm:content'. |
| maxResults | number | 20 | Maximum number of results to show in the search. |
| resultSort | string | | Criteria to sort search results by, must be one of "name" , "modifiedAt" or "createdAt" |
| navigationMode | string | "dblclick" | Event used to initiate a navigation action to a specific result, one of "click" or "dblclick" |
### Events