mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
992cd38216
* [ADF-2824] Moved search widget docs into separate pages * [ADF-2824] Separated search widget page and added search filter service docs * [ADF-2824] Updated new search docs with doc tools
60 lines
1.8 KiB
Markdown
60 lines
1.8 KiB
Markdown
---
|
|
Added: v2.4.0
|
|
Status: Active
|
|
Last reviewed: 2018-06-11
|
|
---
|
|
|
|
# Search text component
|
|
|
|
Implements a text input widget for the [Search Filter component](../content-services/search-filter.component.md).
|
|
|
|
|
|
|
|
## Basic usage
|
|
|
|
```json
|
|
{
|
|
"search": {
|
|
"categories": [
|
|
{
|
|
"id": "queryName",
|
|
"name": "Name",
|
|
"enabled": true,
|
|
"expanded": true,
|
|
"component": {
|
|
"selector": "text",
|
|
"settings": {
|
|
"pattern": "cm:name:'(.*?)'",
|
|
"field": "cm:name",
|
|
"placeholder": "Enter the name"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
### Settings
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| field | string | Field to apply the query fragment to. Required value |
|
|
| pattern | string | Regular expression pattern to restrict the format of the input text |
|
|
| placeholder | string | Text displayed in the widget when the input string is empty |
|
|
|
|
## Details
|
|
|
|
This component lets the user add a text value to search for in the specified
|
|
`field`. See the [Search filter component](../content-services/search-filter.component.md) for full
|
|
details of how to use widgets in a search query.
|
|
|
|
## See also
|
|
|
|
- [Search filter component](../content-services/search-filter.component.md)
|
|
- [Search check list component](../content-services/search-check-list.component.md)
|
|
- [Search date range component](../content-services/search-date-range.component.md)
|
|
- [Search number range component](../content-services/search-number-range.component.md)
|
|
- [Search radio component](../content-services/search-radio.component.md)
|
|
- [Search slider component](../content-services/search-slider.component.md)
|