inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-19 17:14:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README with new output names and fix typos

Browse Source 
Refs #737, 363
This commit is contained in:
Will Abson 2016-09-23 18:35:41 +01:00
parent f0fa43e2ee
commit dc4a9722d2
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -91,7 +91,8 @@ Also make sure you include these dependencies in your .html page:
```html ```html
<alfresco-search-control [searchTerm]="searchTerm" <alfresco-search-control [searchTerm]="searchTerm"
inputType="search" inputType="search"
(searchChange)="customMethod($event);"> (searchChange)="onSearchChange($event);"
(searchSubmit)="onSearchSubmit($event);">
</alfresco-search-control> </alfresco-search-control>
``` ```
@ -116,7 +117,7 @@ import {
@Component({ @Component({
selector: 'alfresco-search-demo', selector: 'alfresco-search-demo',
template: ` template: `
<alfresco-search-control *ngIf="authenticated" [searchTerm]="searchTerm" (searchChange)="searchTermChange($event);"> <alfresco-search-control *ngIf="authenticated" [searchTerm]="searchTerm" (searchChange)="onSearchChange($event);" (searchSubmit)="onSearchSubmit($event)">
</alfresco-search-control> </alfresco-search-control>
<div *ngIf="!authenticated"> <div *ngIf="!authenticated">
Authentication failed to ip {{ host }} Authentication failed to ip {{ host }}
@ -141,11 +142,15 @@ class SearchDemo implements OnInit {
translation.addTranslationFolder(); translation.addTranslationFolder();
} }
searchTermChange(event) { onSearchChange(event) {
console.log('Search term changed', event); console.log('Search term changed', event);
this.searchTerm = event.value; this.searchTerm = event.value;
} }
onSearchSubmit(event) {
console.log('Search submitted', event);
}
ngOnInit() { ngOnInit() {
this.login(); this.login();
} }
@ -165,7 +170,8 @@ bootstrap(SearchDemo, [
``` ```
#### Events #### Events
**searchChange**: Emitted when the search term is changed and the form submitted, provided that the term is at least three characters in length<br /> **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.<br />
**searchSubmit**: Emitted when the search form is submitted. The search term is provided in the 'value' property of the returned object.<br />
#### Options #### Options
@ -220,7 +226,7 @@ Also make sure you include these dependencies in your .html page:
``` ```
Example of an component that displays search results, using the Angular2 router to supply a 'q' parameter containing the 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 pon the page of if the router does not provide such a parameter then an empty 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. results page will be shown.
```ts ```ts
@ -242,7 +248,7 @@ import {
@Component({ @Component({
selector: 'alfresco-search-demo', selector: 'alfresco-search-demo',
template: ` template: `
<alfresco-search *ngIf="authenticated" [searchTerm]="searchTerm"></alfresco-search> <alfresco-search *ngIf="authenticated"></alfresco-search>
<div *ngIf="!authenticated"> <div *ngIf="!authenticated">
Authentication failed to ip {{ host }} Authentication failed to ip {{ host }}
</div> </div>
@ -266,11 +272,6 @@ class SearchDemo implements OnInit {
translation.addTranslationFolder(); translation.addTranslationFolder();
} }
searchTermChange(event) {
console.log('Search term changed', event);
this.searchTerm = event.value;
}
ngOnInit() { ngOnInit() {
this.login(); this.login();
} }