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.5 KiB

Raw Blame History

Added, Status, Last reviewed

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

Search date range component

Implements a date range widget for the Search Filter component.

Basic usage

{
    "search": {
        "categories": [
            {
                "id": "createdDateRange",
                "name": "Created Date (range)",
                "enabled": true,
                "component": {
                    "selector": "date-range",
                    "settings": {
                        "field": "cm:created"
                    }
                }
            }
        ]
    }
}

Settings

Name	Type	Description
field	string	Field to apply the query to. Required value
dateFormat	string	Date format. Dates used by the datepicker are Moment.js instances, so you can use any date format supported by Moment. Default is 'DD/MM/YYYY'.

Details

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

Custom date format

You can set the date range picker to work with any date format your app requires. You can use any date format supported by Moment.js in the dateFormat setting:

{
    "search": {
        "categories": [
            {
                "id": "createdDateRange",
                "name": "Created Date (range)",
                "enabled": true,
                "component": {
                    "selector": "date-range",
                    "settings": {
                        "field": "cm:created",
                        "dateFormat": "DD-MMM-YY"
                    }
                }
            }
        ]
    }
}

2.5 KiB Raw Blame History