Class kartik\daterange\DateRangePicker

The generated input for end attribute when $endAttribute has been set

The pluginOptions format configuration for the date time

Locale language configuration to be used for the plugin

The pluginOptions separator configuration

The generated input for start attribute when $startAttribute has been set

Whether to auto update the input on initialization. If set to false, this will auto set the pluginOptions['autoUpdateInput'] to false. A default $callback will be auto-generated when this is set to false.

The javascript callback to be passed to the plugin constructor. Note: a default value is set for this property when you set $hideInput to false, OR when you set $useWithAddon to true or $autoUpdateOnInit to false. If you do set this property, it will override any auto-generated callbacks.

The HTML attributes for the container applied when $hideInput is set to true. The following special options are recognized:

• tag: string, the HTML tag for rendering the container. Defaults to div.

The template for rendering the container, when hideInput is set to true. The special tag {input} will be replaced with the hidden form input. In addition, the element with css class range-value will be replaced by the calculated plugin value. The special token {value} will be replaced with the value of the hidden form input during initialization and the token {pickerIcon} will be replaced with the $pickerIcon property.

The HTML attributes for the span element that displays the default value for a preset dropdown. This property is not used any more and the $containerTemplate setting directly can be used to render the preset value input.

Whether to HTML encode the value

The attribute name which you can set optionally to track changes to the range end value. One of the following actions will be taken when this is set:

• If using with model, an active hidden input will be automatically generated using this as an attribute name for the end value of the range.
• If using without model, a normal hidden input will be automatically generated using this as an input name for the end value of the range.

The HTML attributes for the end input (applicable only if $endAttribute is set). If using without a model, you can set an end value here within the value property.

Whether to hide the input (e.g. when you want to show the date range picker as a dropdown). If set to true, the input will be hidden. The plugin will be initialized on a container element (default 'div'), using the container template. A default $callback will be setup in this case to display the selected range value within the container.

Whether to add additional preset filter options for days (applicable only when $presetDropdown is true). If this is set to true following additional preset filter option(s) will be available:

• Last {n} Days

where n will be picked up from the list of filter days set via [presetFilterDays]

Whether to add additional preset filter options for months (applicable only when $presetDropdown is true). If this is set to true following additional preset filter options will be available:

• Last {n} Months

where n will be picked up from the list of filter months set via [presetFilterMonths]

Initialize all the list values as part of ranges configuration in $pluginOptions and convert all values to yii\web\JsExpression

The HTML attributes for the form input

The markup for the calendar picker icon. If not set this will default to:

• <i class="glyphicon glyphicon-calendar"></i> if $bsVersion is set to 3.x
• <i class="fas fa-calendar-alt"></i> if $bsVersion is set to 4.x or 5.x

The plugin name

Show a preset dropdown. If set to true, this will automatically generate a preset list of ranges for selection. Setting this to true will also automatically set $initRangeExpr to true.

List of preset filter days (which will be shown as Last {n} days)

List of preset filter months (which will be shown as Last {n} months)

The attribute name which you can set optionally to track changes to the range start value. One of the following actions will be taken when this is set:

• If using with model, an active hidden input will be automatically generated using this as an attribute name for the start value of the range.
• If using without model, a normal hidden input will be automatically generated using this as an input name for the start value of the range.

The HTML attributes for the start input (applicable only if $startAttribute is set). If using without a model, you can set a start value here within the value property.

Whether you are using the picker with a input group addon. You can set it to true, when $hideInput is false, and you wish to show the picker position more correctly at the input-group addon indicator. A default $callback will be generated in this case to generate the selected range value for the input.