inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/content-services/search-text.component.md
Andy Stark 992cd38216 [ADF-2824] Reviewed search docs for 2.4 (#3477) 
* [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
2018-06-13 12:46:33 +01:00

1.8 KiB
Raw Blame History

Added, Status, Last reviewed
Added Status Last reviewed
v2.4.0 Active 2018-06-11

Search text component

Implements a text input widget for the Search Filter component.

Text Widget

Basic usage

{
    "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 for full details of how to use widgets in a search query.

See also