| Title | Added | Status | Last reviewed |
|---|---|---|---|
Search date range component |
v6.2.0 |
Active |
2023-07-10 |
Represents a date range component for the SearchDateRangeTabbedComponent.
NOTE: As of v6.5.0, the settings configuration for the original SearchDateRangeComponent have changed. If you have been using this component since before that release, please ensure that your component configuration is updated according to the new settings listed below.
<adf-search-date-range></adf-search-date-range>| Name | Type | Description |
|---|---|---|
| field | string | Field to apply the query to. Required value |
| maxDate | string | A fixed date (default format: dd-MMM-yy) or the string "today" that will set the maximum searchable date. Default is today. |
| dateFormat | string | Date format. Dates used by the datepicker are Javascript Date objects, using date-fns for formatting, so you can use any date format supported by the library. Default is 'dd-MMM-yy (sample date - 07-Jun-23) |
| initialValue | SearchDateRange | Initial value for the component |
| Name | Type | Description |
|---|---|---|
| changed | EventEmitter<Partial<SearchDateRange>> |
Emitted whenever a change is made in the component values. Emits the changes being made in the component. |
| valid | EventEmitter<boolean> |
Emitted whenever a change is made in the component values. Emits a flag indicating whether the current state of the component is valid or not. |
This component lets the user choose a variety of options to perform date related operations.
- Anytime - No date related data will be returned. This option is selected by default
- In the last - Allows user to perform date related operations over a period of time. The user can select the length of the period from current time, as well as its unit. Currently, 3 units are supported - Days, Weeks, and Months.
- Between - Allows the user to select a range of dates to perform operations on.