kartik-v/yii2-date-range An advanced Yii 2 date range picker input for based on bootstrap-daterangepicker plugin.

extension widget bootstrap date range time date-range bootstrap3

yii2-date-range

An advanced date range picker input for Yii Framework 2 based on dangrossman/bootstrap-daterangepicker plugin. The date range picker widget is styled for Bootstrap 3.x and 4.x versions and creates a dropdown menu from which a user can select a range of dates. If the plugin is invoked with no options, it will present two calendars to choose a start and end date from. Optionally, you can provide a list of date ranges the user can select from instead of choosing dates from the calendars. If attached to a text input, the selected dates will be inserted into the text box. Otherwise, you can provide a custom callback function to receive the selection.

Additional enhancements added for this widget (by Krajee):

allows ability to work with Bootstrap input group addons and set the picker position to point at the input-group-addon icon.
enhanced translation features using yii i18n message files.
automatically convert format from PHP Date/time format to Moment.js Date/time format.
automatically trigger change of base field to enforce Yii ActiveField validation
ability to set the widget to display a preset dropdown of date options within a container (and hidden input).
style the container options as per your need using templates
automatically disable date-range based on disabled/readonly options.

Demo

You can see detailed documentation on usage of the extension.

Release Changes

Refer the CHANGE LOG for details of various releases.

Installation

The preferred way to install this extension is through composer.

Note: Check the composer.json for this extension's requirements and dependencies. Read this web tip /wiki on setting the minimum-stability settings for your application's composer.json.

Either run

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

or add

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

to the require section of your composer.json file.

Usage

DateRangePicker

use kartik\daterange\DateRangePicker;
echo DateRangePicker::widget([
    'model'=>$model,
    'attribute'=>'datetime_range',
    'convertFormat'=>true,
    'pluginOptions'=>[
        'timePicker'=>true,
        'timePickerIncrement'=>30,
        'locale'=>[
            'format'=>'Y-m-d h:i A'
        ]
    ]
]);

or using seperate min/max attributes on model

use kartik\daterange\DateRangePicker;
echo DateRangePicker::widget([
    'model'=>$model,
    'attribute'=>'datetime_range',
    'convertFormat'=>true,
    'startAttribute'=>'datetime_min',
    'endAttribute'=>'datetime_max',
    'pluginOptions'=>[
        'timePicker'=>true,
        'timePickerIncrement'=>30,
        'locale'=>[
            'format'=>'Y-m-d h:i A'
        ]
    ]
]);

DateRangeBehavior

use kartik\daterange\DateRangeBehavior;

class UserSearch extends User
{
    public $createTimeRange;
    public $createTimeStart;
    public $createTimeEnd;

    public function behaviors()
    {
        return [
            [
                'class' => DateRangeBehavior::className(),
                'attribute' => 'createTimeRange',
                'dateStartAttribute' => 'createTimeStart',
                'dateEndAttribute' => 'createTimeEnd',
            ]
        ];
    }

    public function rules()
    {
        return [
            // ...
            [['createTimeRange'], 'match', 'pattern' => '/^.+\s\-\s.+$/'],
        ];
    }

    public function search($params)
    {
        $query = User::find();
        $dataProvider = new ActiveDataProvider([
            'query' => $query,
        ]);
        $this->load($params);
        if (!$this->validate()) {
            $query->where('0=1');
            return $dataProvider;
        }

        $query->andFilterWhere(['>=', 'createdAt', $this->createTimeStart])
              ->andFilterWhere(['<', 'createdAt', $this->createTimeEnd]);

        return $dataProvider;
    }
}

License

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

Changelog

Change Log: `yii2-date-range`

Version 1.7.4

(enh #170) Update Russian Translations.

Version 1.7.3

Date: 01-Sep-2021

(enh #163): Enhancements to support Bootstrap v5.x.
(enh #162): Update Uzbek Translations.
(enh #156): Update Greek Translations.
(enh #155): Update Indonesian Translations.
(enh #154): Update Kazakh Translations.
(enh #150): Add following properties to DateRangePicker (applicable only when presetDropdown is true).
- includeDaysFilter : bool defaults to true
- presetFilterDays : array defaults to [7, 30]
- If above is true - following preset options are additionally available:
  - Last 7 Days
  - Last 30 Days
- includeMonthsFilter : bool defaults to false
- presetFilterMonths : array defaults to [3, 6, 12]
- If above is true - following preset options are additionally available:
  - Last 6 Months
  - Last 12 Months

Version 1.7.2

Date: 09-Feb-2020

(enh #148): Correct date range preset dropdown selection for "Today".
(enh #147): Allow date range picker value to be cleared for preset dropdown.
(enh #146): Enhance preset dropdown user interface.
(enh #143): Update initSettings to support indexes.

Version 1.7.1

Date: 17-May-2019

(enh #139): Update Latvian Translations.
(enh #134): Merge ranges for preset dropdown.
Implement stale bot.

Version 1.7.0

Date: 09-Oct-2018

Update composer dependencies.
(enh #129): Update Russian Translations.
(enh #128): Move init moment() variable.
Enhancements to support Bootstrap 4.x.
(enh #126): Fix kv-drp-container CSS style.
(enh #125): Add Czech Translations.
(enh #122): Better responsive styling of preset dropdown.
(bug #119): Correct client validation of model range attributes.
(enh #118): More correct predefined default date ranges.
Update to latest release v3.0.3 of daterangepicker plugin.
Reorganize code in src folder.
(enh #113): Allow specifying direction in preset dropdown.

Version 1.6.9

Date: 15-Mar-2018

(enh #112): New boolean property encodeValue to HTML encode the value (to prevent XSS).
(enh #81, #108): Enhance empty date validation.
(bug #104, bug #111): Allow specifying direction in preset dropdown.

Version 1.6.8

Date: 08-Aug-2017

Chronological arrangement of issues in CHANGE.log.
(enh #101): Update Turkish Translations.
(enh #98): Update Danish Translations.
(enh #97): Update Hebrew Translations.
(enh #95): Update Chinese Traditional Translations.
(enh #93): Various styling enhancements and preset plugin defaults for preset dropdown.
(enh #92): Correct example for Date Range Behavior in README.md.
Add github contribution and issue/PR logging templates.
Update daterangepicker library to latest release.
(enh #91): Update moment library to latest release.
(enh #90): Add Date Range Behavior for easier application with model range attributes.
(enh #88): Enhance preset dropdown to default today's date when date is empty.
(enh #85, #86): Add Greek Translations.

Version 1.6.7

Date: 12-Jul-2016

(bug #76, #77, #78, #79): Correct dependency for DateRangePickerAsset.
(bug #75): Correct code for PHP 5.5.
(bug #74): Correct asset bundle dependency.
(bug #73): Correct dependency for DateRangePickerAsset and LanguageAsset.
(enh #71): Add Thai translations.
(bug #70): More better attribute and input options parsing.
(enh #68): Update to latest release of bootstrap-daterangepicker plugin and moment library.
(enh #67): Parse input change correctly when range input value is cleared.
(bug #65): Correct moment weekdaysStart to weekdaysMin.
Add branch alias for dev-master latest release.
(enh #62): Add Romanian Translations.
(enh #61): Add Dutch Translations.
(enh #59): Add Hungarian Translations.
(enh #58): Add support for separate start and end attributes and inputs.

Version 1.6.6

Date: 11-Jan-2016

(enh #56): Update to latest version of bootstrap-daterangepicker.
(enh #55): Enhancements for PJAX based reinitialization. Complements enhancements in kartik-v/yii2-krajee-base#52 and kartik-v/yii2-krajee-base#53.

Version 1.6.5

Date: 22-Oct-2015

(enh #53): Added correct German translations.
(enh #52): New property autoUpdateOnInit to prevent plugin triggering change due to pluginOptions['autoUpdateInput'] default setting.

Version 1.6.4

Date: 19-Oct-2015

(enh #51): Update to latest release of bootstrap-datarangepicker plugin.
(enh #43): Add Slovak translations.
(enh #41): Add Simplified Chinese translations.

Version 1.6.3

Date: 22-May-2015

(enh #40): Update moment library and locales.
(enh #38): Update to latest release of bootstrap-datarangepicker plugin.
(enh #36): Add Polish translations.
(enh #32): Add Portugese translations.
(enh #31): Add Ukranian translations.

Version 1.6.2

Date: 02-Mar-2015

(enh #29): Improve validation to retrieve the right translation messages folder.
(enh #28): Upgrade to latest release of bootstrap-daterangepicker plugin.
(enh #27): Correct initial value initialization for all cases.
Set copyright year to current.

Version 1.6.1

Date: 16-Feb-2015

Set copyright year to current.
(enh #28): Upgrade to latest release of bootstrap-daterangepicker plugin.
(enh #27): Correct initial value initialization for all cases.

Version 1.6.0

Date: 12-Jan-2015

Revamp to use new Krajee base InputWidget and TranslationTrait.
Code formatting updates as per Yii2 standards.
(enh #23): Russian translations updated.
(enh #22): Estonian translation for kvdrp.php

Version 1.5.0

Date: 29-Nov-2014

(enh #20): Enhance language locale file parsing and registering
- Remove _localeLang property
- Rename locale folder to locales to be consistent with datepicker and datetimepicker plugins
- Utilize enhancements in krajee base enh #9 and enh #10
- Update LanguageAsset for new path

Version 1.4.0

Date: 25-Nov-2014

(enh #19): Enhance widget to use updated plugin registration from Krajee base
(bug #18): Plugin data attributes not set because of input rendering sequence.
(enh #17): Updated Russian translations

Version 1.3.0

Date: 21-Nov-2014

(enh #16): Update Lithunian translations and create German translations.
(enh #15): Revamp widget to remove dependency on custom locale JS files enhancement
(enh #14): Update moment library to latest release.
(enh #13): Update moment.js related range initializations.
(enh #12): Added Spanish Translations
(enh #7): Added Russian Translations

Version 1.2.0

Date: 20-Nov-2014

Upgrade to latest plugin release 1.3.16 dated 12-Nov-2014.
(bug #11): Fix bug in daterangepicker.js for duplicate dates in Dec 2013.

Version 1.1.0

Date: 10-Nov-2014

Set release to stable
Set dependency on Krajee base components
PSR4 alias change

Version 1.0.0

Date: 09-May-2014

Initial release

Statistics

Downloads

GitHub Stars

GitHub Forks

Releases

v1.7.301 September 2021
v1.7.209 February 2020
v1.7.117 May 2019
v1.7.009 October 2018
v1.6.915 March 2018
1.6.808 August 2017
v1.6.712 July 2016
v1.6.611 January 2016
v1.6.522 October 2015
v1.6.419 October 2015
v1.6.322 May 2015
v1.6.221 April 2015
v1.6.116 February 2015
v1.6.012 January 2015
v1.5.028 November 2014
v1.4.025 November 2014
v1.3.021 November 2014
v1.2.020 November 2014
v1.1.010 November 2014
v1.0.024 September 2014

Comments

v1.7.3 is the latest of 20 releases

kartik-v

github.com/kartik-v/yii2-date-range

BSD-3-Clause license

Stats

93 github stars & 80 github forks

1919 downloads in the last day

47139 downloads in the last 30 days

2412658 total downloads