Files
alfresco-ng2-components/docs/content-services/components/search-text.component.md
Michal Kinas d8b36606e2 [MNT-25681] Search refactoring and unification (#12019)
* [MNT-25681] Search refactoring and unification

* [MNT-25681] CR fixes
2026-07-02 17:46:30 +02:00

2.9 KiB

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Search text component v2.4.0 Active 2024-05-13

Search text component

Implements a search widget consisting of a input representing a value used in search query to specify field contents.

Text Widget

Basic usage

{
    "search": {
        "categories": [
            {
                "id": "queryName",
                "name": "Name",
                "enabled": true,
                "expanded": true,
                "component": {
                    "selector": "text",
                    "settings": {
                        "searchPrefix": "",
                        "searchSuffix": "",
                        "pattern": "cm:name:'(.*?)'",
                        "field": "cm:name",
                        "placeholder": "Enter the name",
                        "allowUpdateOnChange": true
                    }
                }
            }
        ]
    }
}

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
searchSuffix string Text to append in the search of a string. Only applied when wildcard matching is enabled (the search-wildcards-enabled app config flag, default true).
searchPrefix string Text to prepend in the search of a string. Only applied when wildcard matching is enabled (the search-wildcards-enabled app config flag, default true).
allowUpdateOnChange boolean Enable/Disable firing the search update when the text changes. Defaults to false; when disabled the search runs only when the user submits the value.
hideDefaultAction boolean Show/hide the widget actions. By default is false.

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