nkovacs / yii2-datetimepicker
Bootstrap datetimepicker widget for Yii 2, based on Eonasdan/bootstrap-datetimepicker.
Installs: 53 936
Dependents: 0
Suggesters: 0
Security: 0
Stars: 10
Watchers: 2
Forks: 8
Open Issues: 0
Type:yii2-extension
Requires
- php: >=5.4.0
- bower-asset/nkovacs-bootstrap-datetimepicker: ~5.0
- yiisoft/yii2: ^2.0.4
- yiisoft/yii2-bootstrap: *
README
Bootstrap datetimepicker widget for Yii 2, based on Eonasdan/bootstrap-datetimepicker.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist nkovacs/yii2-datetimepicker "*"
or add
"nkovacs/yii2-datetimepicker": "*"
to the require section of your composer.json
file.
Usage
Once the extension is installed, simply use it in your code:
<?= \nkovacs\datetimepicker\DateTimePicker::widget([ 'name' => 'time', ]); ?>
or as an active field:
<?= $form->field($model, 'time')->widget(\nkovacs\datetimepicker\DateTimePicker::className(), [ 'clientOptions' => [ 'extraFormats' => ['YYYY-MM-DD HH:mm'], ], ]) ?>
To show just a datepicker:
<?= $form->field($model, 'time')->widget(\nkovacs\datetimepicker\DateTimePicker::className(), [ 'type' => 'date', ]) ?>
or just a timepicker:
<?= $form->field($model, 'time')->widget(\nkovacs\datetimepicker\DateTimePicker::className(), [ 'type' => 'time', ]) ?>
The widget will load the moment locale file for Yii::$app->language
if it can find it.
It will also use Yii::$app->formatter->dateFormat
, Yii::$app->formatter->timeFormat
or Yii::$app->formatter->datetimeFormat
depending on type
.
Use the timestampAttribute
property of the validator in this extension to get the parsed timestamp.
Both can be overriden using the locale
and format
options.
Validators
The extension comes with an improved datetime validator. Yii's default DateValidator cannot handle
time values with the default ICU 'medium' format. The validator adds a type
option that specifies what
kind of value should be accepted: date
, time
or datetime
.
To register the validator, add the following line to your app config file:
\nkovacs\datetimepicker\DateTimeValidator::register();
This replaces the built-in date
validator and adds a time
and datetime
validator:
... ['timestamp', 'datetime'], ['time', 'time'], ['date', 'date'], ...