DateRange supports configuration of the bootstrap library version so that you can use this either with any Bootstrap version 3.x and above. For setting up the bootstrap version for your extension, you can configure the DateRange::bsVersion property to one of the following.

• To use with bootstrap 3 library - you can set DateRange::bsVersion property to any string starting with 3 (e.g. 3 or 3.3.7 or 3.x)

• To use with bootstrap 4 library - you can set DateRange::bsVersion property to any string starting with 4 (e.g. 4 or 4.6.0 or 4.x)

• To use with bootstrap 5 library - you can set DateRange::bsVersion property to any string starting with 5 (e.g. 5 or 5.1.0 or 5.x)

'params' => [
    'bsVersion' => '5.x', // this will set globally `bsVersion` to Bootstrap 5.x for all Krajee Extensions
    // other settings
    // 'adminEmail' => 'admin@example.com'
]

"yiisoft/yii2-bootstrap5": "@dev"

"yiisoft/yii2-bootstrap4": "@dev"

"yiisoft/yii2-bootstrap": "@dev"

The yii2-date-range extension can be installed automatically or manually using one of these options:

$ php composer.phar require kartik-v/yii2-date-range "dev-master"

"kartik-v/yii2-date-range": "dev-master"

• bsVersion: string | int, the bootstrap library version to be used for the extension. Refer the Bootstrap Info section for details and pre-requisites on setting this property.

  • To use with Bootstrap library - you can set this to any string starting with 3 (e.g. 3 or 3.3.7 or 4.x / 3.x)

  • To use with bootstrap 4 - you can set this to any string starting with 4 (e.g. 4 or 4.6.0 or 4.x)

  • To use with bootstrap 5 - you can set this to any string starting with 4 (e.g. 5 or 5.1.0 or 5.x)

• bsColCssPrefixes: array, the bootstrap grid column css prefixes mapping, the key is the bootstrap versions, and the value is an array containing the sizes and their corresponding grid column css prefixes. The class using this trait, must implement kartik\base\BootstrapInterface. If not set will default to:.

  [
     3 => [
        self::SIZE_X_SMALL => 'col-xs-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-lg-',
        self::SIZE_XX_LARGE => 'col-lg-',
     ],
     4 => [
        self::SIZE_X_SMALL => 'col-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-xl-',
        self::SIZE_XX_LARGE => 'col-xl-',
     ],
     5 => [
        self::SIZE_X_SMALL => 'col-',
        self::SIZE_SMALL => 'col-sm-',
        self::SIZE_MEDIUM => 'col-md-',
        self::SIZE_LARGE => 'col-lg-',
        self::SIZE_X_LARGE => 'col-xl-',
        self::SIZE_XX_LARGE => 'col-xxl-',
     ],
  ];
  

• callback: string, 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 you set useWithAddon to true or autoUpdateOnInit to false. If you set a value here it will override any auto-generated callbacks. Refer the plugin usage documentation for more details on this.

• autoUpdateOnInit: boolean, whether to auto update the input on initialization. If set to false, this will auto set the plugin's autoUpdateInput property to false. A default callback will be auto-generated when this is set to false. Setting this to false is recommended for cases where you do not want the input change to be triggered on initialization like in gridview filters.

• hideInput: boolean, whether to hide the input (e.g. instead of an editable input, you just want to show 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 automatically generated in this case to display the selected range value within the container. Defaults to false.

• useWithAddon: boolean, whether you are using the picker with a Bootstrap library 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 icon. A default callback will be automatically setup in this case to generate the selected range value for the input. Defaults to false.

• initRangeExpr: boolean, whether, the widget should initialize all the list values set in pluginOptions['ranges'] and auto-convert all values to yii\web\JsExpression. Defaults to true.

• presetDropdown: boolean, whether, a preset dropdown should be automatically generated. If set to true, this will automatically generate a preset list of ranges (pluginOptions['ranges']) for selection. Setting this to true, will also automatically set initRangeExpr to true. Refer the plugin events documentation for more details on setting ranges. The following values are automatically set when this is set to true. Defaults to false.

  initRangeExpr = true;
  pluginOptions['ranges'] = [
      Yii::t('kvdrp', "Today") => ["moment().startOf('day')", "moment()"],
      Yii::t('kvdrp', "Yesterday") => ["moment().startOf('day').subtract(1,'days')", "moment().endOf('day').subtract(1,'days')"],
      (DATA FROM presetFilterDays based on includeDaysFilter setting),
      Yii::t('kvdrp', "This Month") => ["moment().startOf('month')", "moment().endOf('month')"],
      Yii::t('kvdrp', "Last Month") => ["moment().subtract(1, 'month').startOf('month')", "moment().subtract(1, 'month').endOf('month')"],
      (DATA FROM presetFilterMonths based on includeMonthsFilter setting),
  ];
  

• includeDaysFilter: boolean whether to add additional preset filter options for days (applicable only when presetDropdown is true). Applicable only when presetDropdown is true. Defaults to true. If this is set to true, the 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

• includeMonthsFilter: boolean whether to add additional preset filter options for months (applicable only when presetDropdown is true). Applicable only when presetDropdown is true. Defaults to true. If this is set to true, the following additional preset filter option(s) will be available:

  • Last {n} Months

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

• presetFilterDays: array list of preset filter days (which will be shown as last {n} days). Applicable only when presetDropdown is true. Defaults to [7, 30].

• presetFilterMonths: array list of preset filter months (which will be shown as last {n} months). Applicable only when presetDropdown is true. Defaults to [3, 6, 12].

• convertFormat: boolean whether the widget should automatically format the date from the PHP DateTime format to the Moment Datetime format.. Defaults to false.

• containerTemplate: string 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 tag {value} will be replaced with the value of the hidden form input during widget initialization (when hideInput is set to true).

  <span class="input-group-addon">
      <i class="fas fa-calendar-alt"></i>
  </span>
  <span class="form-control text-right text-end">
      <span class="pull-left">
          <span class="range-value">{value}</span>
      </span>
      <b class="caret"></b>
      {input}
  </span>
  

• containerOptions: array, the HTML attributes for container, if hideInput is set to true. The following special options are recognized:

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

• options: array the HTML attributes for the input

• i18n: array, the internalization configuration for this module. Defaults to:

  [
      'class' => 'yii\i18n\PhpMessageSource',
      'basePath' => '@kvdrp/messages',
      'forceTranslation' => true
  ]
  

• startAttribute: string, 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.

• endAttribute: string, 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.

• startInputOptions: array, 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.

• endInputOptions: array, the HTML attributes for the end input (applicable only if endAttribute is set). If using without a model, you can set a end value here within the value property.

• pluginOptions: array the JQuery plugin options for the bootstrap-date-range plugin. You can control many options for the plugin. Refer the plugin options documentation for details of all options that can be setup. The following important parameters determine how your output is generated:

  • locale: array, the plugin locale settings. The following properties are important:

    • format: string, the format for date time formatting. If convertFormat is set to true, this will be assumed as a PHP date time format and converted to Moment datetime format for javascript.

    • separator: string, the separator string to display between the start and end date when populating a text input the picker is attached to. Defaults to ' - '.

• pluginEvents: array the bootstrap-date-range plugin events. You must define events in event-name => event-function format. Refer the plugin events documentation for details. All events will be stacked in the sequence passed. For example:

  pluginEvents = [
  "show.daterangepicker" => "function() { log("show.daterangepicker"); }",
  "hide.daterangepicker" => "function() { log("hide.daterangepicker"); }",
  "apply.daterangepicker" => "function() { log("apply.daterangepicker"); }",
  "cancel.daterangepicker" => "function() { log("cancel.daterangepicker"); }",
  ];
  

use kartik\daterange\DateRangePicker;
use kartikorm\ActiveForm;
$form = ActiveForm::begin();
// DateRangePicker with ActiveForm and model. Check the `required` model validation for 
// the attribute. This also features configuration of Bootstrap input group addon.
echo $form->field($model, 'date_range', [
    'addon'=>['prepend'=>['content'=>'<i class="fas fa-calendar-alt"></i>']],
    'options'=>['class'=>'drp-container mb-2']
])->widget(DateRangePicker::classname(), [
    'useWithAddon'=>true
]);

// DateRangePicker without ActiveForm and with an initial default value, a custom date, 
// format and a custom separator. Auto conversion of date format from PHP DateTime to 
// Moment.js DateTime is set to <code>true</code>. Custom addon markup on the right and
// make the picker open in the direction right to left.
$addon = <<< HTML
<div class="input-group-append">
    <span class="input-group-text">
        <i class="fas fa-calendar-alt"></i>
    </span>
</div>
HTML;
echo '<label class="control-label">Date Range</label>';
echo '<div class="input-group drp-container">';
echo DateRangePicker::widget([
    'name'=>'date_range_1',
    'value'=>'01-Jan-14 to 20-Feb-14',
    'convertFormat'=>true,
    'useWithAddon'=>true,
    'pluginOptions'=>[
        'locale'=>[
            'format'=>'d-M-y',
            'separator'=>' to ',
        ],
        'opens'=>'left'
    ]
]) . $addon;
echo '</div>';

// DateRangePicker in a dropdown format (uneditable/hidden input) and uses the preset dropdown.
// Note that placeholder setting in this case will be displayed when value is null
// Also the includeMonthsFilter setting will display LAST 3, 6 and 12 MONTHS filters.
echo '<label class="control-label">Date Range</label>';
echo '<div class="drp-container">';
echo DateRangePicker::widget([
    'name'=>'date_range_2',
    'presetDropdown'=>true,
    'convertFormat'=>true,
    'includeMonthsFilter'=>true,
    'pluginOptions' => ['locale' => ['format' => 'd-M-y']],
    'options' => ['placeholder' => 'Select range...']
]);
echo '</div>';

//  A disabled Date Range Picker
echo '<label class="control-label">Date Range (Disabled)</label>';
echo '<div class="drp-container">';
echo DateRangePicker::widget([
    'name'=>'date_range_2a',
    'value'=>'2015-10-19 - 2015-11-03',
    'convertFormat'=>true,
    'disabled' => true,
    'pluginOptions'=>[
        'locale'=>['format'=>'Y-m-d']
    ]
]);
echo '</div>';

//  A readonly Date Range Picker
echo '<label class="control-label">Date Range (Readonly)</label>';
echo '<div class="drp-container">';
echo DateRangePicker::widget([
    'name'=>'date_range_2a',
    'value'=>'2015-10-19 - 2015-11-03',
    'convertFormat'=>true,
    'readonly' => true,
    'pluginOptions'=>[
        'locale'=>['format'=>'Y-m-d']
    ]
]);
echo '</div>';

//  Date and Time picker with time increment of 15 minutes and without any input group addons.
echo DateRangePicker::widget([
    'name'=>'date_range_3',
    'value'=>'2015-10-19 12:00 AM - 2015-11-03 01:00 PM',
    'convertFormat'=>true,
    'pluginOptions'=>[
        'timePicker'=>true,
        'timePickerIncrement'=>15,
        'locale'=>['format'=>'Y-m-d h:i A']
    ]            
]);

// Single date picker without range.
echo '<div class="input-group drp-container">';
echo DateRangePicker::widget([
    'name'=>'date_range_4',
    'value'=>'01/12/2015',
    'useWithAddon'=>true,
    'pluginOptions'=>[
        'singleDatePicker'=>true,
        'showDropdowns'=>true
    ]
]) . $addon;
echo '</div>';

// Single date time picker without range.
echo '<div class="input-group drp-container">';
echo DateRangePicker::widget([
    'name'=>'date_range_5',
    'value'=>'2015-10-19 12:00 AM',
    'useWithAddon'=>true,
    'convertFormat'=>true,
    'pluginOptions'=>[
        'timePicker'=>true,
        'timePickerIncrement'=>15,
        'locale'=>['format' => 'Y-m-d h:i A'],
        'singleDatePicker'=>true,
        'showDropdowns'=>true
    ]
]) . $addon;
echo '</div>';

// Advanced configuration using separate start and end attributes to store information.
// Note that you can have these attributes have their own validation rules in the model.
// In the scenario that your base attribute (e.g. `kvdate1` in this example), does not 
// have an initial value, then the initial value will be auto derived from the start and 
// end attributes.
$model->datetime_start = '2016-02-11';
$model->datetime_end = '2016-03-15';
echo '<div class="input-group drp-container">';
echo DateRangePicker::widget([
    'model'=>$model,
    'attribute' => 'kvdate1',
    'useWithAddon'=>true,
    'convertFormat'=>true,
    'startAttribute' => 'datetime_start',
    'endAttribute' => 'datetime_end',
    'pluginOptions'=>[
        'locale'=>['format' => 'Y-m-d'],
    ]
]) . $addon;
echo '</div>';

// Extension of above scenario using separate start and end attributes 
// but without a model. You can set the initial value within 
// `startInputOptions` and `endInputOptions`.
echo '<div class="input-group drp-container">';
echo DateRangePicker::widget([
    'name'=>'kvdate2',
    'useWithAddon'=>true,
    'convertFormat'=>true,
    'startAttribute' => 'from_date',
    'endAttribute' => 'to_date',
    'startInputOptions' => ['value' => '2017-06-11'],
    'endInputOptions' => ['value' => '2017-07-20'],
    'pluginOptions'=>[
        'locale'=>['format' => 'Y-m-d'],
    ]
]) . $addon;
echo '</div>';

// Variation of above scenario by setting a value directly in base attribute
// instead of setting separate attributes. In this case the individual
// attributes will be set automatically. 
echo '<div class="input-group drp-container">';
echo DateRangePicker::widget([
    'name'=>'kvdate3',
    'value' => '2018-10-04 - 2018-11-14',
    'useWithAddon'=>true,
    'convertFormat'=>true,
    'startAttribute' => 'from_date',
    'endAttribute' => 'to_date',
    'pluginOptions'=>[
        'locale'=>['format' => 'Y-m-d'],
    ]
]) . $addon;
echo '</div>';
ActiveForm::end();

yii2-date-range is released under the BSD-3-Clause License. See the bundled LICENSE.md for details.