Global Bootstrap Version

Generally, you may also want to set a default version globally for all Krajee Extensions (instead of setting it for each widget or extension separately). In order to do this, you can setup the bsVersion property within Yii 2 application params (i.e. Yii::$app->params['bsVersion']). To set this up, add this section of code to your application params configuration file (e.g. config/params.php):

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

If DatePicker::bsVersion property is set, in addition to Yii::$app->params['bsVersion'], the extension level setting (DatePicker::bsVersion property) will override the Yii::$app->params['bsVersion']. If DatePicker::bsVersion property is not set, and Yii::$app->params['bsVersion'] is also not set, DatePicker::bsVersion property will default to 3.x (i.e. Bootstrap 3.x version will be assumed as default).

Yii2 Bootstrap Dependency

You need to install one of yiisoft/yii2-bootstrap or yiisoft/yii2-bootstrap4 or yiisoft/yii2-bootstrap5 extensions manually in your application to enable Bootstrap 3.x or 4.x or 5.x functionality respectively. This dependency has not been pre-built into the composer configuration for Krajee extensions, to allow better control to the developers in configuring their bootstrap library version. If bsVersion is set to 5.x and yiisoft/yii2-bootstrap5 is not installed, then an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap5 extension. If bsVersion is set to 4.x and yiisoft/yii2-bootstrap4 is not installed, then an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap4 extension. Similarly, if bsVersion is set to 3.x and yiisoft/yii2-bootstrap is not installed, an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap extension.

To install yiisoft/yii2-bootstrap5, add the repo to the require section of your application's composer.json.

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

To install yiisoft/yii2-bootstrap4, add the repo to the require section of your application's composer.json.

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

To install yiisoft/yii2-bootstrap, add the repo to the require section of your application's composer.json.

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

Override Bootstrap CSS/JS

The Krajee extension asset bundle(s) by default depend on one of the following asset bundles to load the Bootstrap CSS and JS:

• yii\bootstrap\BootstrapAsset and/or yii\bootstrap\BootstrapPluginAsset for bootstrap 3.x (bsVersion = 3 setting)

• yii\bootstrap4\BootstrapAsset and/or yii\bootstrap4\BootstrapPluginAsset for bootstrap 4.x ( bsVersion = 4 setting)

• yii\bootstrap5\BootstrapAsset and/or yii\bootstrap5\BootstrapPluginAsset for bootstrap 5.x (bsVersion = 5 setting)

This is controlled by the property bsDependencyEnabled within the asset bundle (which defaults to true). One can override this and prevent the default yii2 bootstrap assets (CSS & JS) from loading by doing one or all of the following:

• Global Override: Set Yii::$app->params['bsDependencyEnabled'] to false in your Yii 2 application config params.php. This setting will be applied for all Krajee Extension Asset Bundles that depend on Bootstrap assets.

  'params' => [
      'bsDependencyEnabled' => false, // this will not load Bootstrap CSS and JS for all Krajee extensions
      // you need to ensure you load the Bootstrap CSS/JS manually in your view layout before Krajee CSS/JS assets
      //
      // other params settings below
      // 'bsVersion' => '5.x',
      // 'adminEmail' => 'admin@example.com'
  ]
  

• Asset Bundle Specific Override: Set bsDependencyEnabled to false for the specific asset bundle within Yii2 Asset Manager component in your Yii 2 application config file.

  // ...
  'components' => [
      'assetManager' => [
          'bundles' => [
              'kartik\form\ActiveFormAsset' => [
                  'bsDependencyEnabled' => false // do not load bootstrap assets for a specific asset bundle
              ],
          ],
      ],
  ],
  

Icons for Bootstrap

Bootstrap 5.x / 4.x does not include glyphicons or any other icons framework bundled with the library. Krajee extensions therefore will use Font Awesome 5.x icons instead of glyphicons when working with Bootstrap 5.x / 4.x. You can download Font Awesome 5.x icons from the icons website. Alternatively, you can load the free version of Font Awesome from their CDN.

For Krajee extensions and demos, the Font Awesome Free version is used and loaded as the Icons Display Package on all the Yii2 demo layouts. To include font awesome assets on your page, include the following markup on the HEAD section of your view layout file, when bsVersion is set to 4.x or 5.x.

• Option 1: Font CSS version of Font Awesome:

  <!-- on your view layout file HEAD section -->
  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css">
  

• Option 2: SVG / JS version of Font Awesome (recommended for cleaner scaling vector icons and features like icon layers):

  <!-- on your view layout file HEAD section -->
  <script defer src="https://use.fontawesome.com/releases/v5.3.1/js/all.js" crossorigin="anonymous"></script>
  

  Alternatively, you can use the FontAwesomeAsset from the kartik-v/yii2-icons package to load the SVG/JS version.

  // on your view layout file
  use kartik\icons\FontAwesomeAsset;
  FontAwesomeAsset::register($this);
  

Composer Package Manager Recommended

Installation via Composer is the recommended and most easy option to install Krajee Yii2 extensions. You can install yii2-widget-datepicker via composer package manager. Either run:

$ php composer.phar require kartik-v/yii2-widget-datepicker "dev-master"

or add:

"kartik-v/yii2-widget-datepicker": "dev-master"

to your application's composer.json file.

Manual Install

You may also manually install the extension to your project (in case your composer install does not work). Just download the source ZIP or TAR ball and extract the extension asset files and folders into your project. You may need to install dependencies manually and also set the namespaces to the extensions in your Yii2 extensions configurations manually.

echo '<label class="form-label">Birth Date</label>';
echo DatePicker::widget([
    'name' => 'dp_1',
    'type' => DatePicker::TYPE_INPUT,
    'value' => '23-Feb-1982',
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'dd-M-yyyy'
    ]
]);

echo '<label class="form-label">Birth Date</label>';
echo DatePicker::widget([
    'name' => 'dp_2',
    'type' => DatePicker::TYPE_COMPONENT_PREPEND,
    'value' => '23-Feb-1982',
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'dd-M-yyyy'
    ]
]);

echo '<label class="form-label">Birth Date</label>';
echo DatePicker::widget([
    'name' => 'dp_3',
    'type' => DatePicker::TYPE_COMPONENT_APPEND,
    'value' => '23-Feb-1982',
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'dd-M-yyyy'
    ]
]);

echo '<label class="form-label">Valid Dates</label>';
echo DatePicker::widget([
    'name' => 'from_date',
    'value' => '01-Feb-1996',
    'type' => DatePicker::TYPE_RANGE,
    'name2' => 'to_date',
    'value2' => '27-Feb-1996',
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'yyyy-mm-dd'
    ]
]);

// With Prepend
$layout1 = <<< HTML
<span class="input-group-text">Birth Date</span>
{picker}
<span class="input-group-text">bef</span>
{remove}
<span class="input-group-text">aft</span>
{input}
HTML;

echo DatePicker::widget([
    'name' => 'dp_addon_1',
    'type' => DatePicker::TYPE_COMPONENT_PREPEND,
    'value' => '23-Feb-1982',
    'layout' => $layout1,
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'dd-M-yyyy'
    ]
]);

// With Append
$layout2 = <<< HTML
<span class="input-group-text">Birth Date</span>
{input}
<span class="input-group-text">bef</span>
{picker}
<span class="input-group-text">aft</span>
{remove}
HTML;
echo DatePicker::widget([
    'name' => 'dp_addon_2',
    'type' => DatePicker::TYPE_COMPONENT_APPEND,
    'value' => '23-Feb-1982',
    'layout' => $layout2,
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'dd-M-yyyy'
    ]
]);

// With Range
$layout3 = <<< HTML
<span class="input-group-text">From Date</span>
{input1}
<span class="input-group-text">aft</span>
{separator}
<span class="input-group-text">To Date</span>
{input2}

    <span class="input-group-text kv-date-remove">
        <i class="fas fa-times kv-dp-icon"></i>
    </span>

HTML;

echo DatePicker::widget([
    'type' => DatePicker::TYPE_RANGE,
    'name' => 'dp_addon_3a',
    'value' => '01-Jul-2015',
    'name2' => 'dp_addon_3b',
    'value2' => '18-Jul-2015',
    'separator' => '<i class="fas fa-arrows-alt-h"></i>',
    'layout' => $layout3,
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'dd-M-yyyy'
    ]
]);

echo '<div class="well border border-secondary rounded p-1" style="width:285px">';
echo DatePicker::widget([
    'name' => 'dp_5',
    'type' => DatePicker::TYPE_INLINE,
    'value' => '23-Feb-1982',
    'type' => DatePicker::TYPE_INLINE,
    'pluginOptions' => [
        'format' => 'dd-M-yyyy',
        'multidate' => true
    ]
    'options' => [
        // you can hide the input by setting the following
        // 'style' => 'display:none'
    ]
]);
echo '</div>';

echo DatePicker::widget([
    'name' => 'dp_6',
    'type' => DatePicker::TYPE_BUTTON,
    'value' => '23-Feb-1982',
    'pluginOptions' => [
        'format' => 'dd-M-yyyy'
    ]
]);

use yii\bootstrap5\Modal;
use kartik\form\ActiveForm;
use kartik\date\DatePicker;

// Usage with model and Active Form (with no default initial value)
echo $form->field($model, 'date_1')->widget(DatePicker::classname(), [
    'options' => ['placeholder' => 'Enter birth date ...'],
    'pluginOptions' => [
        'autoclose' => true
    ]
]);

// Usage with model (with no default initial value)
echo '<label class="form-label">Birth Date</label>';
echo DatePicker::widget([
    'model' => $model, 
    'attribute' => 'date_1',
    'options' => ['placeholder' => 'Enter birth date ...'],
    'pluginOptions' => [
        'autoclose' => true
    ]
]);

// Usage without a model (with default initial value)
echo '<label class="form-label">Birth Date</label>';
echo DatePicker::widget([
    'name' => 'birth_date',
    'value' => '12/31/2010',
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'mm/dd/yyyy'
    ]
]);

// A read only datepicker input (with default initial value)
echo '<label class="form-label">Anniversary</label>';
echo DatePicker::widget([
    'name' => 'anniversary',
    'value' => '08/10/2004',
    'readonly' => true,
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'mm/dd/yyyy'
    ]
]);

// A disabled datepicker input (with default initial value)
echo '<label class="form-label">Anniversary</label>';
echo DatePicker::widget([
    'name' => 'anniversary',
    'value' => '02/22/2014',
    'disabled' => true
]);


// Change the widget size (e.g. lg for large)
echo '<label class="form-label">Inaugral Date</label>';
echo DatePicker::widget([
    'name' => 'inaugral_date',
    'value' => '01/29/2014',
    'size' => 'lg',
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'mm/dd/yyyy'
    ]
]);

// Customize `pickerIcon` and `removeIcon`
echo '<label class="form-label">Check Date</label>';
echo DatePicker::widget([
    'name' => 'check_date',
    'value' => '01/29/2014',
    'type' => DatePicker::TYPE_COMPONENT_APPEND,
    'pickerIcon' => '<i class="fas fa-calendar-alt text-primary"></i>',
    'removeIcon' => '<i class="fas fa-trash text-danger"></i>',
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'mm/dd/yyyy'
    ]
]);

// Do not render the `removeButton`
echo '<label class="form-label">Check Date</label>';
echo DatePicker::widget([
    'name' => 'check_date',
    'value' => '01/29/2014',
    'removeButton' => false,
    'pluginOptions' => [
        'autoclose' => true,
        'format' => 'mm/dd/yyyy'
    ]
]);

// Datepicker inside a modal window
<div class="row">
    <div class="col-sm-4">
        <div  style="margin-top: 20px">
        <?php
            Modal::begin([
                'title' => 'Datepicker with other fields',
                'toggleButton' => ['label' => 'Launch Modal', 'class' => 'btn btn-primary'],
            ]);
        ?>
        <?= $form->field($model, 'username') ?>
        <div class="row" style="margin-bottom: 8px">
            <div class="col-sm-6">
                <?= DatePicker::widget(['name' => 'date_in_modal_1', 'options' => ['placeholder' => 'Select birthday...'], 'pluginOptions' => ['autoclose' => true]]); ?>
            </div>
            <div class="col-sm-6">
                <?= DatePicker::widget(['name' => 'date_in_modal_2', 'options' => ['placeholder' => 'Select anniversary...'], 'pluginOptions' => ['autoclose' => true]]); ?>
            </div>
        </div>
        <?= $form->field($model, 'notes')->textarea() ?>
        <?php Modal::end();?>
        </div>
    </div>
    <div class="col-sm-6">
        <div class="alert alert-info"><p>DatePicker within a bootstrap modal window.</p></div>
    </div>
</div>

use kartik\date\DatePicker
use kartik\form\ActiveForm

// Client validation of date-ranges when using with ActiveForm
$form = ActiveForm::begin([
    'tooltipStyleFeedback' => true, // shows tooltip styled validation error feedback
]);
echo '<label class="form-label">Select date range</label>';
echo DatePicker::widget([
    'model' => $model,
    'attribute' => 'from_date',
    'attribute2' => 'to_date',
    'options' => ['placeholder' => 'Start date'],
    'options2' => ['placeholder' => 'End date'],
    'type' => DatePicker::TYPE_RANGE,
    'form' => $form,
    'pluginOptions' => [
        'format' => 'yyyy-mm-dd',
        'autoclose' => true,
    ]
]);
ActiveForm::end();

// Setting datepicker for your regional language (e.g. fr for French)
echo '<label class="form-label">Date de Naissance</label>';
echo DatePicker::widget([
    'name' => 'date_10',
    'language' => 'fr',
    'options' => ['placeholder' => 'Enter birth date ...'],
    'pluginOptions' => [
        'autoclose' => true,
    ]
]);

// Highlight today, show today button, change date format
echo '<label class="form-label">Birth Date</label>';
echo DatePicker::widget([
    'name' => 'date_11',
    'options' => ['placeholder' => 'Enter birth date ...'],
    'pluginOptions' => [
        'todayHighlight' => true,
        'todayBtn' => true,
        'format' => 'dd-M-yyyy',
        'autoclose' => true,
    ]
]);

// Show week numbers and disable certain days of week (e.g. weekends)
echo '<label class="form-label">Birth Date</label>';
echo DatePicker::widget([
    'name' => 'date_12',
    'value' => '31-Dec-2010',
    'pluginOptions' => [
        'calendarWeeks' => true,
        'daysOfWeekDisabled' => [0, 6],
        'format' => 'dd-M-yyyy',
        'autoclose' => true,
    ]
]);

// Change orientation of datepicker as well as markup type
echo '<label class="form-label">Setup Date</label>';
echo DatePicker::widget([
    'name' => 'date_12',
    'value' => '08/10/2004',
    'type' => DatePicker::TYPE_COMPONENT_APPEND,
    'pluginOptions' => [
        'orientation' => 'top right',
        'format' => 'mm/dd/yyyy',
        'autoclose' => true,
    ]
]);

// Multiple Dates Selection
echo '<label class="form-label">Select Dates</label>';
echo DatePicker::widget([
    'name' => 'date_12',
    'value' => '08/10/2004',
    'type' => DatePicker::TYPE_COMPONENT_APPEND,
    'pluginOptions' => [
        'format' => 'mm/dd/yyyy',
        'multidate' => true,
        'multidateSeparator' => ' ; ',
    ]
]);