Implements a search widget for the Search Filter component.

Date Range Widget

Basic usage

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

Settings

NameTypeDescription
fieldstringField to apply the query to. Required value
datetimeFormatstringDatetime format. Datetime formats used by the datetime picker are Moment.js instances, so you can use any datetime format supported by Moment. Default is 'DD/MM/YYYY HH:mm'.
maxDatetimestringA fixed datetime that will set the maximum searchable datetime. Default is no maximum.
hideDefaultActionbooleanShow/hide the widget actions. By default is false.

Details

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

Custom datetime format

You can set the datetime range picker to work with any datetime format your app requires. You can use any datetime format supported by Moment.js in the datetimeFormat and in the maxDatetime setting:

{
    "search": {
        "categories": [
            {
                "id": "createdDateTimeRange",
                "name": "Created Datetime (range)",
                "enabled": true,
                "component": {
                    "selector": "datetime-range",
                    "settings": {
                        "field": "cm:created",
                        "datetimeFormat": "DD-MMM-YY HH:mm:ss",
                        "maxDatetime": "10-Mar-20 20:00"
                    }
                }
            }
        ]
    }
}

See also

© 2023 Alfresco Software, Inc. All Rights Reserved.