Implements a checklist widget for the Search Filter component.

Check list widget screenshot

Basic usage

    "search": {
        "categories": [
                "id": "checkList",
                "name": "Check List",
                "enabled": true,
                "component": {
                    "selector": "check-list",
                    "pageSize": 5,
                    "settings": {
                        "operator": "OR",
                        "allowUpdateOnChange": true,
                        "options": [
                            { "name": "Folder", "value": "TYPE:'cm:folder'" },
                            { "name": "Document", "value": "TYPE:'cm:content'" }


operatorstringLogical operator to combine query fragments. Can be 'AND' or 'OR'.
optionsarrayArray of objects with name and value properties. Each object defines a checkbox, labelled with name, that adds the query fragment in value to the query when enabled.
allowUpdateOnChangebooleanEnable/Disable the update fire event when text has been changed. By default is true.
hideDefaultActionbooleanShow/hide the widget actions. By default is false.


This widget displays a list of checkboxes, each of which toggles a particular query fragment in the search. See the Search filter component for full details of how to use the widgets in a search query.

In the settings, the options array, defines the checkboxes that toggle the supplied query fragments and the operator selects logical AND or OR to combine the fragments. In the example above, if the user checks both boxes then the following fragment will be added to the query:

... (TYPE:'cm:folder' OR TYPE:'cm:content') ...

The component can be set to split a long checklist into separate pages of checkboxes using the pageSize value as the number of boxes to show per page (default is 5). When there is more than one page, the widget will display "Show more" and "Show less" buttons as appropriate.

A "Clear all" button is also displayed at the bottom of the widget to clear all checked items in the list.

See also

© 2023 Alfresco Software, Inc. All Rights Reserved.