mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[AAE-534] Core - add search cloud component (#5193)
* [AAE-534] - add search cloud component * change doc file * more changes on doc file * remove empty scss file * add animation and more customizations * add preselect value property * fix unit tests
This commit is contained in:
40
docs/core/components/search-cloud.component.md
Normal file
40
docs/core/components/search-cloud.component.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
Title: Search Cloud Component
|
||||
Added: v3.5.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-10-24
|
||||
---
|
||||
|
||||
# [Search Cloud Component](../../../lib/core/search-cloud/search-cloud.component.ts "Defined in pagination.component.ts")
|
||||
|
||||
Should manage search for cloud components
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-search-cloud>
|
||||
[type]="'text'"
|
||||
[placeholder]="'placeholder'"
|
||||
[debounceTime]="200"
|
||||
[expandable]='false'
|
||||
(change)="onSearchValueChanged($event)"
|
||||
</adf-search-cloud>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| type | [`SearchCloudTypesEnum`](../../../lib/core/models/search-cloud.model.ts) | | search type ('text'). |
|
||||
| value | `string` | | preselected input value |
|
||||
| expandable | `boolean` | false | The field should expand on click when this flag is true |
|
||||
| placeholder | `string` | | placeholder content. |
|
||||
| debounceTime | `number` | 500 | Time in miliseconds for debounce the event. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| change | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when search widget value is changed. |
|
Reference in New Issue
Block a user