Date Range Options Object

The “Date” parameter provides a calendar-like component to where it is being used. Highly configurable it provides a wide range of functionalities:

1. Calendar control.

2. Date range selection (start-to-end date selection).

3. Date selection control attributes (value can be selected only within a given range of dates).

The value type is object.

Field	Type	Description
name	string	The label of the widget. Example: Activation date
hintText	string	Provides help text describing what value is expected in control. Example: Specify when you want your subscription to be active
dateRange	bool	Turning this option on allows selection of two dates (start date & end date). Example: True
minAvailableDate	date	(optional) Prevents selection of the date value in the past beyond the value set in this constraint. Example: 2024-02-01
maxAvailableDate	date	(optional) Prevents selection of the date value in the future beyond the value set in this constraint. Example: 2024-12-10
defaultValue	One of singleDate or dateRange	(optional) Depending of the dateRange value - default value can be a date range or single date. Example: { "date": "2023-10-05" }

Example

{
  "name": "Date of birth",
  "hintText": "Specify your date of birth",
  "dateRange": false,
  "minAvailableDate": "1900-01-01",
  "maxAvailableDate": "2000-12-30",
  "defaultValue":  null
}

Value Fields

Field	Type
start	ISO 8601	Start of date range. Example: 2020-12-09
end	ISO 8601	End of date range. Example: 2025-12-09

Example

{
  "start": "2020-12-09",
  "end": "2024-12-09"
}