inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
992cd3821666cca4da2afb09936d75454e1ee5e0
alfresco-ng2-components/docs/content-services/search-radio.component.md
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.7 KiB
Raw Blame History

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

Search radio component

Implements a radio button list widget for the Search Filter component.

Radio Widget screenshot

Basic usage

{
    "search": {
        "categories": [
            {
                "id": "queryType",
                "name": "Type",
                "enabled": true,
                "component": {
                    "selector": "radio",
                    "settings": {
                        "field": null,
                        "pageSize": 5,
                        "options": [
                            { "name": "None", "value": "", "default": true },
                            { "name": "All", "value": "TYPE:'cm:folder' OR TYPE:'cm:content'" },
                            { "name": "Folder", "value": "TYPE:'cm:folder'" },
                            { "name": "Document", "value": "TYPE:'cm:content'" }
                        ]
                    }
                }
            }
        ]
    }
}

Settings

Name Type Description
options array Array of objects with name and value properties. Each object defines a radio button, labelled with name, that adds the query fragment in value to the query when enabled. Set the default property to true for one item to have it selected initially when the widget is displayed.

Details

This component displays a list of radio buttons, each of which toggles a particular query fragment in the search. This behaviour is very similar to that of the Search check list component except only one item at a time can be selected. See the Search filter component for full details of how to use the widgets in a search query.

The component can be set to split a long list of buttons into separate pages using the pageSize value as the number of buttons 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.

See also