Skip to content

Latest commit

 

History

History
69 lines (58 loc) · 2.6 KB

search-text.component.md

File metadata and controls

69 lines (58 loc) · 2.6 KB
Raw
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 always in the search of a string
searchPrefix string Text to prepend always in the search of a string
allowUpdateOnChange boolean Enable/Disable the update fire event when text has been changed. By default is true.
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