mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
1fa81962a0
* fix after rebase * new release strategy for ng next Signed-off-by: eromano <eugenioromano16@gmail.com> * peer dep Signed-off-by: eromano <eugenioromano16@gmail.com> * Angular 14 fix unit test and storybook Signed-off-by: eromano <eugenioromano16@gmail.com> fix after rebase Signed-off-by: eromano <eugenioromano16@gmail.com> update pkg.json Signed-off-by: eromano <eugenioromano16@gmail.com> missing dep Signed-off-by: eromano <eugenioromano16@gmail.com> Fix mistake and missing code Dream....build only affected libs Add utility run commands * Use nx command to run affected tests * Fix nx test core fix content tests Run unit with watch false core test fixes reduce test warnings Fix process cloud unit Fix adf unit test Fix lint process cloud Disable lint next line Use right core path Fix insights unit fix linting insights Fix process-services unit fix the extensions test report fix test warnings Fix content unit Fix bunch of content unit * Produce an adf alpha of 14 * hopefully fixing the content * Push back the npm publish * Remove flaky unit * Fix linting * Make the branch as root * Get rid of angualar13 * Remove the travis depth * Fixing version for npm * Enabling cache for unit and build * Fix scss for core and paths Copy i18 and asset by using ng-packager Export the theming alias and fix path Use ng-package to copy assets process-services-cloud Use ng-package to copy assets process-services Use ng-package to copy assets content-services Use ng-package to copy assets insights * feat: fix api secondary entry point * fix storybook rebase * Move dist under dist/libs from lib/dist * Fix the webstyle * Use only necessary nrwl deps and improve lint * Fix unit for libs * Convert lint.sh to targets - improve performance * Use latest of angular * Align alfresco-js-api Signed-off-by: eromano <eugenioromano16@gmail.com> Co-authored-by: eromano <eugenioromano16@gmail.com> Co-authored-by: Mikolaj Serwicki <mikolaj.serwicki@hyland.com> Co-authored-by: Tomasz <tomasz.gnyp@hyland.com>
55 lines
2.9 KiB
Markdown
55 lines
2.9 KiB
Markdown
---
|
|
Title: Search Text Input Component
|
|
Added: v3.6.0
|
|
Status: Active
|
|
Last reviewed: 2019-11-06
|
|
---
|
|
|
|
# [Search Text Input Component](lib/core/src/lib/search-text/search-text-input.component.ts "Defined in search-text-input.component.ts")
|
|
|
|
Displays a input text that supports autocompletion
|
|
|
|
|
|
|
|
## Basic Usage
|
|
|
|
```html
|
|
<adf-search-text-input
|
|
[expandable]="true"
|
|
[autocomplete]="autocomplete"
|
|
[liveSearchEnabled]="liveSearchEnabled"
|
|
(searchChange)="onSearchChanged($event)">
|
|
</adf-search-text-input>
|
|
```
|
|
|
|
## Class members
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| autocomplete | `boolean` | false | Toggles auto-completion of the search input field. |
|
|
| collapseOnBlur | `boolean` | true | Toggles whether to collapse the search on blur. |
|
|
| collapseOnSubmit | `boolean` | true | Collapse search bar on submit. |
|
|
| debounceTime | `number` | 0 | Debounce time in milliseconds. |
|
|
| defaultState | `SearchTextStateEnum` | | Default state expanded or Collapsed. |
|
|
| expandable | `boolean` | true | Toggles whether to use an expanding search control. If false then a regular input is used. |
|
|
| focusListener | [`Observable`](http://reactivex.io/documentation/observable.html)`<FocusEvent>` | | Listener for results-list events (focus, blur and focusout). |
|
|
| hintLabel | `string` | "" | Hint label |
|
|
| inputType | `string` | "text" | Type of the input field to render, e.g. "search" or "text" (default). |
|
|
| liveSearchEnabled | `boolean` | true | Toggles "find-as-you-type" suggestions for possible matches. |
|
|
| placeholder | `string` | "" | Placeholder text to show in the input field |
|
|
| searchAutocomplete | `any` | false | Trigger autocomplete results on input change. |
|
|
| searchTerm | `string` | "" | Search term preselected |
|
|
| showClearButton | `boolean` | false | Toggles whether to show a clear button that closes the search |
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| reset | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the result list is reset |
|
|
| searchChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the search term is changed. The search term is provided in the 'value' property of the returned object. If the term is less than three characters in length then it is truncated to an empty string. |
|
|
| searchVisibility | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the search visibility changes. True when the search is active, false when it is inactive |
|
|
| selectResult | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the result list is selected |
|
|
| submit | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the search is submitted by pressing the ENTER key. The search term is provided as the value of the event. |
|