inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ACS-6644] review search documentation and examples for adf (#9518)

Browse Source 
* ACS-6644 review search docs and examples

* ACS-6644 change widget description to more precise

* ACS-6644 small formatting fix, add new component links to main connected pages

* [ACS-6644] trigger codeQL job
This commit is contained in:
Grzegorz Jaśkowski
2024-04-11 15:33:59 +02:00
committed by GitHub
parent 5e886e29d1
commit 96be5a543c
10 changed files with 49 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/content-services/components/search-check-list.component.md
View File

@@ -2,12 +2,12 @@
Title: Search check list component
Added: v2.4.0
Status: Active
Last reviewed: 2018-06-11
Last reviewed: 2024-04-05
---
# [Search check list component](../../../lib/content-services/src/lib/search/components/search-check-list/search-check-list.component.ts "Defined in search-check-list.component.ts")
Implements a checklist [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) for the [Search Filter component](search-filter.component.md).
Implements a [search widget](../../../lib/content-services/src/lib/search/models/search-widget.interface.ts) consisting of 4 inputs representing logical conditions to form search query from.
![Check list widget screenshot](../../docassets/images/search-check-list.png)
@@ -23,8 +23,8 @@ Implements a checklist [widget](../../../lib/testing/src/lib/core/pages/form/wid
"enabled": true,
"component": {
"selector": "check-list",
"pageSize": 5,
"settings": {
"pageSize": 5,
"operator": "OR",
"allowUpdateOnChange": true,
"options": [
@@ -46,13 +46,11 @@ Implements a checklist [widget](../../../lib/testing/src/lib/core/pages/form/wid
| 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](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) actions. By default is false. |
| hideDefaultAction | boolean | Show/hide the widget actions. By default is false. |
## Details
This [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) 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.
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.
@@ -65,11 +63,10 @@ to the query:
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](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) will display "Show more" and "Show less"
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](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) to clear all checked
items in the list.
A "Clear all" button is also displayed at the bottom of the widget to clear all checked items in the list.
## See also

10
docs/content-services/components/search-datetime-range.component.md
View File

@@ -2,7 +2,7 @@
Title: Search datetime range component
Added: v4.2.0
Status: Active
Last reviewed: 2020-11-02
Last reviewed: 2024-04-05
---
# [Search datetime range component](../../../lib/content-services/src/lib/search/components/search-datetime-range/search-datetime-range.component.ts "Defined in search-datetime-range.component.ts")
@@ -38,9 +38,9 @@ Implements a [search widget](../../../lib/content-services/src/lib/search/search
| Name | Type | Description |
| ---- | ---- | ----------- |
| field | string | Field to apply the query to. Required value |
| datetimeFormat | string | Datetime format. Datetime formats used by the datetime picker are [Moment.js](https://momentjs.com/docs/#/parsing/string-format/) instances, so you can use any datetime format supported by Moment. Default is 'DD/MM/YYYY HH:mm'. |
| datetimeFormat | string | Datetime format. Datetime formats used by the datetime picker are [date-fns](https://date-fns.org/v2.30.0/docs/format) instances, so you can use any datetime format supported by date-fns. Default is 'dd/MM/yyyy HH:mm'. |
| maxDatetime | string | A fixed datetime that will set the maximum searchable datetime. Default is no maximum. |
| hideDefaultAction | boolean | Show/hide the [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) actions. By default is false. |
| hideDefaultAction | boolean | Show/hide the widget actions. By default is false. |
## Details
@@ -51,7 +51,7 @@ 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](https://momentjs.com/docs/#/parsing/string-format/)
any datetime format supported by [date-fns](https://date-fns.org/v2.30.0/docs/format)
in the `datetimeFormat` and in the `maxDatetime` setting:
```json
@@ -66,7 +66,7 @@ in the `datetimeFormat` and in the `maxDatetime` setting:
"selector": "datetime-range",
"settings": {
"field": "cm:created",
"datetimeFormat": "DD-MMM-YY HH:mm:ss",
"datetimeFormat": "dd-MMM-yy HH:mm:ss",
"maxDatetime": "10-Mar-20 20:00"
}
}

4
docs/content-services/components/search-logical-filter.component.md
View File

@@ -2,7 +2,7 @@
Title: Search Logical Filter component
Added: v6.1.0
Status: Active
Last reviewed: 2023-06-01
Last reviewed: 2024-04-05
---
# [Search Logical Filter component](../../../lib/content-services/src/lib/search/components/search-logical-filter/search-logical-filter.component.ts "Defined in search-logical-filter.component.ts")
@@ -40,7 +40,7 @@ Implements a [search widget](../../../lib/content-services/src/lib/search/models
| Name | Type | Description |
| ---- | ---- | ----------- |
| field | string | Field/fields to apply the query to. Required value |
| hideDefaultAction | boolean | Show/hide the [widget](../../../lib/testing/src/lib/protractor/core/pages/form/widgets/widget.ts) actions. By default is false. |
| hideDefaultAction | boolean | Show/hide the widget actions. By default is false. |
## Details

6
docs/content-services/components/search-number-range.component.md
View File

@@ -2,12 +2,12 @@
Title: Search number range component
Added: v2.4.0
Status: Active
Last reviewed: 2018-06-11
Last reviewed: 2024-04-05
---
# [Search number range component](../../../lib/content-services/src/lib/search/components/search-number-range/search-number-range.component.ts "Defined in search-number-range.component.ts")
Implements a number range [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) for the [Search Filter component](search-filter.component.md).
Implements a [search widget](../../../lib/content-services/src/lib/search/models/search-widget.interface.ts) consisting of 4 inputs representing logical conditions to form search query from.
![Number Range Widget](../../docassets/images/search-number-range.png)
@@ -40,7 +40,7 @@ Implements a number range [widget](../../../lib/testing/src/lib/core/pages/form/
| ---- | ---- | ----------- |
| field | string | Field to to use |
| format | string | Value format. Uses string substitution to allow all sorts of [range queries](https://docs.alfresco.com/5.2/concepts/rm-searchsyntax-ranges.html). |
| hideDefaultAction | boolean | Show/hide the [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) actions. By default is false. |
| hideDefaultAction | boolean | Show/hide the widget actions. By default is false. |
## Details

8
docs/content-services/components/search-radio.component.md
View File

@@ -2,12 +2,12 @@
Title: Search radio component
Added: v2.4.0
Status: Active
Last reviewed: 2018-08-10
Last reviewed: 2024-04-05
---
# [Search radio component](../../../lib/content-services/src/lib/search/components/search-radio/search-radio.component.ts "Defined in search-radio.component.ts")
Implements a radio button list [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) for the [Search Filter component](search-filter.component.md).
Implements a [search widget](../../../lib/content-services/src/lib/search/models/search-widget.interface.ts) consisting of 4 inputs representing logical conditions to form search query from.
![Radio Widget screenshot](../../docassets/images/search-radio.png)
@@ -46,7 +46,7 @@ Implements a radio button list [widget](../../../lib/testing/src/lib/core/pages/
| ---- | ---- | ----------- |
| 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. |
| allowUpdateOnChange | `boolean` | Enable/Disable the update fire event when text has been changed. By default is true. |
| hideDefaultAction | `boolean` | Show/hide the [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) actions. By default is false. |
| hideDefaultAction | `boolean` | Show/hide the widget actions. By default is false. |
## Details
@@ -57,7 +57,7 @@ query fragment in the search. This behaviour is very similar to that of the
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](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) will display "Show more" and "Show less"
When there is more than one page, the widget will display "Show more" and "Show less"
buttons as appropriate.
## See also

6
docs/content-services/components/search-slider.component.md
View File

@@ -2,12 +2,12 @@
Title: Search slider component
Added: v2.4.0
Status: Active
Last reviewed: 2018-06-11
Last reviewed: 2024-04-05
---
# [Search slider component](../../../lib/content-services/src/lib/search/components/search-slider/search-slider.component.ts "Defined in search-slider.component.ts")
Implements a numeric slider [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) for the [Search Filter component](search-filter.component.md).
Implements a [search widget](../../../lib/content-services/src/lib/search/models/search-widget.interface.ts) consisting of 4 inputs representing logical conditions to form search query from.
![Slider Widget](../../docassets/images/search-slider.png)
@@ -47,7 +47,7 @@ Implements a numeric slider [widget](../../../lib/testing/src/lib/core/pages/for
| step | number | The step between adjacent positions on the slider |
| thumbLabel | boolean | Toggles whether the "thumb" of the slider should show the current value |
| allowUpdateOnChange | boolean | Enable/Disable the update fire event when text has been changed. By default is true. |
| hideDefaultAction | boolean | Show/hide the [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) actions. By default is false. |
| hideDefaultAction | boolean | Show/hide the widget actions. By default is false. |
## Details

8
docs/content-services/components/search-text.component.md
View File

@@ -2,12 +2,12 @@
Title: Search text component
Added: v2.4.0
Status: Active
Last reviewed: 2018-06-11
Last reviewed: 2024-04-05
---
# [Search text component](../../../lib/content-services/src/lib/search/components/search-text/search-text.component.ts "Defined in search-text.component.ts")
Implements a text input [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) for the [Search Filter component](search-filter.component.md).
Implements a [search widget](../../../lib/content-services/src/lib/search/models/search-widget.interface.ts) consisting of 4 inputs representing logical conditions to form search query from.
![Text Widget](../../docassets/images/search-text.png)
@@ -45,11 +45,11 @@ Implements a text input [widget](../../../lib/testing/src/lib/core/pages/form/wi
| ---- | ---- | ----------- |
| field | string | Field to apply the query fragment to. Required value |
| pattern | string | Regular expression pattern to restrict the format of the input text |
| placeholder | string | Text displayed in the [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) when the input string is empty |
| placeholder | string | Text displayed in the widget when the input string is empty |
| searchSuffix | string | Text to append always in the search of a string |
| searchPrefix | string | Text to prepend always in the search of a string |
| allowUpdateOnChange | `boolean` | Enable/Disable the update fire event when text has been changed. By default is true. |
| hideDefaultAction | boolean | Show/hide the [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) actions. By default is false. |
| hideDefaultAction | boolean | Show/hide the widget actions. By default is false. |
## Details