f47fb2a7e9
* [ACS-6107] Removed date range component from ADF content-services * [ACS-6107] Removed references of date range component in code * [ACS-6107] Updated documentation to replace occurrences of date range component with date-range-advanced-tabbed component * [ACS-6107] Renamed DateRangeAdvanced to DateRange. Renamed DateRangeAdvancedTabbed to DateRangeTabbed * [ACS-6107] Fixed missing export of SearchDateRangeTabbedComponent * [ACS-6107] Replaced occurrences of date-range-advanced with date-range in HTML and Unit Tests automation ids * [ACS-6107] Documentation corrections * [ACS-6107] Reverted unneeded documentation formatting * [ACS-6107] Reverted unneeded documentation formatting * [ACS-6107] Reverted unneeded documentation formatting * [ACS-6107] Migrated unneeded E2E test case to unit test * [ACS-6107] Removed search-date-range E2E * [ACS-6107] Resolved PR comments. Removed date-range-filter.page.ts. Removed unused translation keys. Updated documentation to refer proper comment name * [ACS-6107] Updated documentation for SearchDateRange component to mention the change from original configuration to the newer configuration * [ACS-6107] Corrected wrong version in documentation * [ci:force] * [ACS-6107] Removed unneeded file * [ACS-6107] Updated unit tests and mock data after rebase * [ci:force] * [ACS-6107] Revert unneeded change. Remove unneeded file * [ci:force] * [ACS-6107] Updated E2E search config * [ci:force] * [ACS-6107] Updated E2E expects after component changes * [ci:force]
3.5 KiB
Title, Added, Status, Last reviewed
| Title | Added | Status | Last reviewed |
|---|---|---|---|
| Search check list component | v2.4.0 | Active | 2018-06-11 |
Search check list component
Implements a checklist widget for the Search Filter component.
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'" }
]
}
}
}
]
}
}
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. |
| allowUpdateOnChange | boolean |
Enable/Disable the update fire event when text has been changed. By default is true. |
| hideDefaultAction | boolean | Show/hide the widget actions. By default is false. |
Details
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.