Search Component
- Prerequisites
- Install
- Basic usage
- Properties
- Events
- Basic usage Search results
- Build from sources
- NPM scripts
- Demo
- License
Prerequisites
Before you start using this development framework, make sure you have installed all required software and done all the necessary configuration, see this page.
If you plan using this component with projects generated by Angular CLI, please refer to the following article: Using ADF with Angular CLI
Install
npm install ng2-alfresco-search
Basic usage
<adf-search-control
[searchTerm]="searchTerm"
inputType="search"
(searchChange)="onSearchChange($event);"
(searchSubmit)="onSearchSubmit($event);"
(fileSelect)="onSearchResultSelect($event);">
</adf-search-control>
Example of an component that uses the search control. In this example the search term is simply logged to the console but instead the component could emit an event to be consumed upstream, or it could trigger a change inside a search results component embedded inside the same component.
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| searchTerm | string | Search term to pre-populate the field with | |
| inputType | string | "text" | Type of the input field to render, e.g. "search" or "text" (default) |
| 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. |
| highlight | boolean | false | Use the true value if you want to see the searched word highlighted. |
| liveSearchEnabled | boolean | true | Whether find-as-you-type suggestions should be offered for matching content items. Set to false to disable. |
| 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
| Name | Description |
|---|---|
| searchChange | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is at less than three characters in length then the term is truncated to an empty string. |
| searchSubmit | Emitted when the search form is submitted. The search term is provided in the 'value' property of the returned object. |
| fileSelect | Emitted when a file item from the list of find-as-you-type results is selected |
| expand | Emitted when the expanded state of the control changes based on focus events and the content of the input control |
Basic usage Search results
<adf-search
[searchTerm]="searchTerm">
</adf-search>
Example of an component that displays search results, using the Angular2 router to supply a 'q' parameter containing the search term. If no router is present on the page of if the router does not provide such a parameter then an empty results page will be shown.
Properties
| 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 | string | "-root-" | NodeRef or node name where the search should start. | |
| resultType | string | Node type to filter search results by, e.g. 'cm:content', 'cm:folder' if you want only the files. | ||
| 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
| Name | Description |
|---|---|
| preview | emitted when user acts upon files with either single or double click (depends on navigation-mode), recommended for Viewer components integration |
| resultsLoad | Emitted when search results have fully loaded |
Build from sources
You can build component from sources with the following commands:
npm install
npm run build
The
buildtask rebuilds all the code, runs tslint, license checks and other quality check tools before performing unit testing.
NPM scripts
| Command | Description |
|---|---|
| npm run build | Build component |
| npm run test | Run unit tests in the console |
| npm run test-browser | Run unit tests in the browser |
| npm run coverage | Run unit tests and display code coverage report |
Demo
Please check the demo folder for a demo project
cd demo
npm install
npm start