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

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"
}
}