[ADF-4152] Restructured Content Services docs (#4429)

* [ADF-4152] Moved content services docs to subfolders * [ADF-4152] Manual URL fixes for cont services docs * [ADF-4152] Moved content services docs to subfolders * [ADF-4152] Manual URL fixes for cont services docs * [ADF-4152] Updated doc index pages for content services
2025-07-24 17:32:15 +00:00 · 2019-03-13 18:44:37 +00:00
parent bc5208b767
commit dfea5c2f04
72 changed files with 958 additions and 1055 deletions
--- a/docs/content-services/components/search-check-list.component.md
+++ b/docs/content-services/components/search-check-list.component.md
@@ -0,0 +1,78 @@
+---
+Title: Search check list component
+Added: v2.4.0
+Status: Active
+Last reviewed: 2018-06-11
+---
+
+# [Search check list component](../../../lib/content-services/search/components/search-check-list/search-check-list.component.ts "Defined in search-check-list.component.ts")
+
+Implements a checklist widget for the [Search Filter component](search-filter.component.md).
+
+![Check list widget screenshot](../../docassets/images/search-check-list.png)
+
+## Basic usage
+
+```json
+{
+    "search": {
+        "categories": [
+            {
+                "id": "checkList",
+                "name": "Check List",
+                "enabled": true,
+                "component": {
+                    "selector": "check-list",
+                    "pageSize": 5,
+                    "settings": {
+                        "operator": "OR",
+                        "options": [
+                            { "name": "Folder", "value": "TYPE:'cm:folder'" },
+                            { "name": "Document", "value": "TYPE:'cm:content'" }
+                        ]
+                    }
+                }
+            }
+        ]
+    }
+}
+```
+
+### Settings
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| operator | `string` | Logical operator to combine query fragments. Can be 'AND' or 'OR'. |
+| options | `array` | Array 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. |
+
+## Details
+
+This widget displays a list of checkboxes, each of which toggles a particular query fragment
+in the search. See the [Search filter component](search-filter.component.md) 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:
+
+```text
+... (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
+
+-   [Search filter component](search-filter.component.md)
+-   [Search date range component](search-date-range.component.md)
+-   [Search number range component](search-number-range.component.md)
+-   [Search radio component](search-radio.component.md)
+-   [Search slider component](search-slider.component.md)
+-   [Search text component](search-text.component.md)