README

Renders a Bootstrap DateTimePicker plugin.

Installation

The preferred way to install this extension is through composer.

Either run

composer require 2amigos/yii2-date-time-picker-widget:~1.0

or add

"2amigos/yii2-date-time-picker-widget" : "~1.0"

to the require section of your application's composer.json file.

Usage

This widget renders a Bootstrap DateTimePicker input control. Best suitable for model with date string attribute. Its functionality is similar to Bootstrap DatePicker plugin but this widget is enhanced with Time selection.

It also allows you to restrict the views so you can use this widget as a DatePicker, TimePicker, or DateTimePicker.

There are two ways of using it, with an ActiveForm instance or as a widget setting up its model and attribute.

<?php
use dosamigos\datetimepicker\DateTimePicker;

// as a widget
?>

<?= DateTimePicker::widget([
    'model' => $model,
    'attribute' => 'created_at',
    'language' => 'es',
    'size' => 'ms',
    'clientOptions' => [
        'autoclose' => true,
        'format' => 'dd MM yyyy - HH:ii P',
        'todayBtn' => true
    ]
]);?>

<?php 
// with an ActiveForm instance displayed as a TimePicker

use dosamigos\datetimepicker\DateTimePicker;
?>
<?= $form->field($tour, 'date_from')->widget(DateTimePicker::className(), [
    'language' => 'es',
    'size' => 'ms',
    'template' => '{input}',
    'pickButtonIcon' => 'glyphicon glyphicon-time',
    'inline' => true,
    'clientOptions' => [
        'startView' => 1,
        'minView' => 0,
        'maxView' => 1,
        'autoclose' => true,
        'linkFormat' => 'HH:ii P', // if inline = true
        // 'format' => 'HH:ii P', // if inline = false
        'todayBtn' => true
    ]
]);?>

Testing

To test the extension, is better to clone this repository on your computer. After, go to the extensions folder and do the following (assuming you have composer installed on your computer:

$ composer install --no-interaction --prefer-source --dev

Once all required libraries are installed then do:

$ phpunit

Further Information

Please, check the Bootstrap DateTimePicker site documentation for further information about its configuration options.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The BSD License (BSD). Please see License File for more information.

Web development has never been so fun!
www.2amigos.us

2amigos / yii2-date-time-picker-widget

Maintainers

Details