README

Persian datetime picker widget for Yii2

Read this in other languages: English

Table of Contents

• Installation
  • Use extension
  • Call widget
• Usage
• Screenshots
• Customization
• Examples
• License
• Contributions

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist winkers/yii2-persian-datetime-picker-widget "*"  

or add

"winkers/yii2-persian-datetime-picker-widget": "*"  

to the require section of your composer.json file.

Usage

Once the extension is installed, simply follow bellow steps :

Use extension

Simply use the extension in your view file :

use winkers\persianDatetimePickerWidget\PersianDatetimePickerWidget;  

Call widget

Basic usage :

<?= PersianDatetimePickerWidget::widget(); ?>  

Usage with model :

<?= PersianDatetimePickerWidget::widget([  
    'model' => $model,  
    'attribute' => 'attribute'  
]) ?>  

Usage with ActiveForm :

<?= $form->field($model, 'attribute')->widget(PersianDatetimePickerWidget::className()) ?>  

Screenshots

This is a screenshot of the extension :

Customization

Use this options to customize widget for your requirements :

icon

• value type : bool
• default value : true

iconOptions

• value type : array
• default value : ['class' => 'glyphicon glyphicon-calendar']

addonOptions

• value type : array
• default value : ['class' => 'input-group-addon']

options

• value type : array
• default value : ['class' => 'form-control']

settings

• placement

  • value type : string
  • value : left | top | right | bottom
  • default type : bottom

• trigger

  • value type : string
  • value : click | focus | mouseover
  • default type : click

• format

  • value type : string
  • value :
    • yyyy : 4 digit year
    • yy : 2 digit year
    • MMMM : persian month name
    • MM : 2 digit month
    • M : 1 digit month
    • dddd : persian day name
    • dd : 2 digit day
    • d : 1 digit day
    • HH : 2 digit hour from 00 to 24
    • H : 1 digit hour from 0 to 24
    • hh : 2 digit hour from 00 to 12
    • h : 1 digit hour from 0 to 12
    • mm : 2 digit minutes
    • m : 1 digit minutes
    • ...
  • default type : yyyy-MM-dd

• groupId

  • value type : string
  • default value : No Default Value

• fromDate

  • value type : string
  • value : true | false
  • default value : false

• toDate

  • value type : string
  • value : true | false
  • default value : false

• disableBeforeToday

  • value type : string
  • value : true | false
  • default value : false

• disabled

  • value type : string
  • value : true | false
  • default value : false

• enableTimePicker

  • value type : string
  • value : true | false
  • default value : false

• isGregorian

  • value type : string
  • value : true | false
  • default value : false

• englishNumber

  • value type : string
  • value : true | false
  • default value : false

Examples

This is an example of widget usage :

<?= $form->field($model, 'attribute')->widget(PersianDatetimePickerWidget::className(), [
    'icon' => true,
    'iconOptions' => [
        'class' => 'glyphicon glyphicon-calendar'
    ],
    'settings' => [
        'enableTimePicker' => 'true',
        'format' => 'yyyy-MM-dd HH:mm',
        'placement' => 'left',
    ]
])
?>

License

This project is released under GNU General Public License v2.0. Look at LICENSE for details.

Contributions

I wrote this extension for Yii2. Thanks to Mohammmad Dayyan for MD.BootstrapPersianDateTimePicker and releasing this wonderful javascript datepicker under The MIT License.