mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00

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

2.4 KiB

Raw Blame History

Added, Status, Last reviewed

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

Search number range component

Implements a number range widget for the Search Filter component.

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.

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]

2.4 KiB Raw Blame History