puresoft/yii2-persian-datepicker

This extension will display a Persian datepicker.

v1.0.2 2017-11-06 12:54 UTC

This package is auto-updated.

Last update: 2024-04-26 12:51:39 UTC


README

This extension will display a Persian date picker.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist puresoft/yii2-persian-datepicker "~1.0"

or add

"puresoft/yii2-persian-datepicker": "~1.0"

to the require section of your composer.json file.

Usage

Once the extension is installed, simply use it in your code by:

# Within a model
<?= Datepicker::widget([
    'model' => $model,
    'attribute' => 'date',
]) ?>

# Or

<?= $form->field($model, 'date')->widget(Datepicker::className()) ?>
# Without model
<?= Datepicker::widget([
    'name' => 'my-date-picker',
    'value' => '1373/12/17',
]) ?>

Options

Following custom options are available:

  • size : The size of the input which must be one of ('lg', 'md', 'sm', 'xs').
  • addon : The addon markup if you wish to display the input as a component then set it to something like <i class="glyphicon glyphicon-calendar"></i>.
  • template : The template to render the input. {input} and {addon} placeholders are available.
  • inline : Whether to render the input as an inline calendar or not. It can be true or false.