Module: alfresco/forms/controls/DateRange

alfresco/forms/controls/DateRange

Extends the DateTextBox widget to add an additional date picker to allow the user to select a date range.
Since:
  • 1.0.91
Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Members

baseCssClass :string

The prefix to all CSS classes used for BEM implementation to avoid duplicate declaration of strings.
Type:
  • string
Default Value:
  • "alfresco-forms-controls-DateRange"
Source:

cssRequirements :Array

An array of the CSS files to use with this widget.
Type:
  • Array
Source:

dateSeparator :string

This is the string used to separate the to and from values.
Type:
  • string
Default Value:
  • "|"
Source:

i18nRequirements :Array

An array of the i18n files to use with this widget.
Type:
  • Array
Source:

toBeforeFromErrorMessage :string

The error message to display when the user selects a "from" date after the the "to" date.
Type:
  • string
Default Value:
  • "daterange.toBeforeFrom.error"
Source:

Methods

getValue() → {object}

Extends the inherited function to combine the to and from dates to create a range value.
Source:
Returns:
The current value of the field
Type
object

placeWidget()

Extends the inherited function to create an additional Date selector to complete the range selection options.
Source:

postMixInProperties()

Extends the inherited function to setup validation for any configured confirmationTargetId
Since:
  • 1.0.87
Source:

setValue(value)

Extends the inherited function to split the value into the to and from data and set the widget values appropriately.
Parameters:
Name Type Description
value object The value to set
Source:

validateFromIsBeforeTo(validationConfig)

This is a validation callback function that is always applied to ensure that the "from" date is before the "to" date.
Parameters:
Name Type Description
validationConfig object The configuration for the requested validation
Source: