Skip to content

Latest commit

 

History

History
82 lines (65 loc) · 2.86 KB

search-number-range.component.md

File metadata and controls

82 lines (65 loc) · 2.86 KB
Title Added Status Last reviewed
Search number range component
v2.4.0
Active
2024-05-03

Search number range component

Implements a search widget consisting of 2 inputs accepting numerical values, representing start and end of a numerical parameter's range used as a search query parameter.

Number Range Widget

Basic usage

{
    "search": {
        "categories": [
            {
                "id": "contentSizeRange",
                "name": "Content Size (range)",
                "enabled": true,
                "component": {
                    "selector": "number-range",
                    "settings": {
                        "field": "cm:content.size",
                        "format": "[{FROM} TO {TO}]"
                    }
                }
            }
        ]
    }
}

Settings

Name Type Description
field string Field to to use
format string Value format. Uses string substitution to allow all sorts of range queries.
hideDefaultAction boolean Show/hide the widget actions. By default is false.

Details

This component lets the user specify a range between two predefined numbers based on the particular field. See the Search filter component for full details of how to use widgets in a search query.

Range query format

See the Search for ranges page in the ACS docs for more information about the date range format.

The format setting specifies how the date is displayed textually. Most of the format is displayed as-is but you can use {FROM} and {TO} markers to interpolate the range limits into the format string:

"settings": {
    "field": "cm:content.size",
    "format": "[{FROM} TO {TO}]"
}

The format above would be displayed at runtime as follows:

cm:content.size:[0 TO 100]

See also