# Class yii\jui\DatePicker

Inheritance | yii\jui\DatePicker » yii\jui\InputWidget » yii\jui\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable, yii\base\ViewContextInterface
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-jui/blob/master/DatePicker.php

DatePicker renders a `datepicker` jQuery UI widget.

For example to use the datepicker with a model:

    echo DatePicker::widget([
        'model' => $model,
        'attribute' => 'from_date',
        //'language' => 'ru',
        //'dateFormat' => 'yyyy-MM-dd',
    ]);

The following example will use the name property instead:

    echo DatePicker::widget([
        'name'  => 'from_date',
        'value'  => $value,
        //'language' => 'ru',
        //'dateFormat' => 'yyyy-MM-dd',
    ]);

You can also use this widget in an ActiveForm using the widget() method, for example like this:

    <?= $form->field($model, 'from_date')->widget(\yii\jui\DatePicker::className(), [
        //'language' => 'ru',
        //'dateFormat' => 'yyyy-MM-dd',
    ]) ?>

Note that and empty string (`''`) and `null` will result in an empty text field while `0` will be interpreted as a UNIX timestamp and result in a date displayed as `1970-01-01`. It is recommended to add a validation filter in your model that sets the value to `null` in case when no date has been entered:

    [['from_date'], 'default', 'value' => null],

See also http://api.jqueryui.com/datepicker/.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$attribute | string | The model attribute that this widget is associated with. | yii\jui\DatePicker
$autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$clientEvents | array | The event handlers for the underlying jQuery UI widget. | yii\jui\Widget
$clientOptions | array | The options for the underlying jQuery UI widget. | yii\jui\Widget
$containerOptions | array | The HTML attributes for the container tag. | yii\jui\DatePicker
$counter | integer | A counter used to generate $id for widgets. | yii\base\Widget
$dateFormat | string | The format string to be used for formatting the date value. | yii\jui\DatePicker
$id | string|null | ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. | yii\base\Widget
$inline | boolean | If true, shows the widget as an inline calendar and the input as a hidden field. | yii\jui\DatePicker
$language | string | The locale ID (e.g. 'fr', 'de', 'en-GB') for the language to be used by the date picker. | yii\jui\DatePicker
$model | yii\base\Model | The data model that this widget is associated with. | yii\jui\InputWidget
$name | string | The input name. | yii\jui\InputWidget
$options | array | The HTML attributes for the widget container tag. | yii\jui\Widget
$stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget
$value | string | The input value. | yii\jui\DatePicker
$view | yii\web\View | The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. | yii\base\Widget
$viewPath | string | The directory containing the view files for this widget. This property is read-only. | yii\base\Widget

## Protected Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$clientEventMap | array | Event names mapped to what should be specified in `. | yii\jui\Widget

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component
__construct() | Constructor. | yii\base\BaseObject
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__unset() | Sets a component property to be null. | yii\base\Component
afterRun() | This method is invoked right after a widget is executed. | yii\base\Widget
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
beforeRun() | This method is invoked right before the widget is executed. | yii\base\Widget
begin() | Begins a widget. | yii\base\Widget
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
end() | Ends a widget. | yii\base\Widget
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
getId() | Returns the ID of the widget. | yii\base\Widget
getView() | Returns the view object that can be used to render views or view files. | yii\base\Widget
getViewPath() | Returns the directory containing the view files for this widget. | yii\base\Widget
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
init() | Initializes the widget. | yii\jui\DatePicker
off() | Detaches an existing event handler from this component. | yii\base\Component
on() | Attaches an event handler to an event. | yii\base\Component
render() | Renders a view. | yii\base\Widget
renderFile() | Renders a view file. | yii\base\Widget
run() | Renders the widget. | yii\jui\DatePicker
setId() | Sets the ID of the widget. | yii\base\Widget
setView() | Sets the view object to be used by this widget. | yii\base\Widget
trigger() | Triggers an event. | yii\base\Component
widget() | Creates a widget instance and runs it. | yii\base\Widget

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
hasModel() |  | yii\jui\InputWidget
registerClientEvents() | Registers a specific jQuery UI widget events | yii\jui\Widget
registerClientOptions() | Registers a specific jQuery UI widget options | yii\jui\Widget
registerWidget() | Registers a specific jQuery UI widget asset bundle, initializes it with client options and registers related events | yii\jui\Widget
renderWidget() | Renders the DatePicker widget. | yii\jui\DatePicker

## Events

Hide inherited events

Event | Type | Description | Defined By
--- | --- | --- | ---
EVENT_AFTER_RUN | yii\base\WidgetEvent | An event raised right after executing a widget. (available since version 2.0.11) | yii\base\Widget
EVENT_BEFORE_RUN | yii\base\WidgetEvent | An event raised right before executing a widget. (available since version 2.0.11) | yii\base\Widget
EVENT_INIT | yii\base\Event | An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) | yii\base\Widget

## Property Details

$attribute public property

The model attribute that this widget is associated with. The value of the attribute will be converted using `Yii::$app->formatter->asDate()` with the $dateFormat if it is not null.

public string $attribute = null
$containerOptions public property

The HTML attributes for the container tag. This is only used when $inline is true.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $containerOptions = []
$dateFormat public property

The format string to be used for formatting the date value. This option will be used to populate the clientOption `dateFormat`. The value can be one of "short", "medium", "long", or "full", which represents a preset format of different lengths.

It can also be a custom format as specified in the ICU manual. Alternatively this can be a string prefixed with `php:` representing a format that can be recognized by the PHP date()-function.

For example:

    'MM/dd/yyyy' // date in ICU format
    'php:m/d/Y' // the same date in PHP format

If not set the default value will be taken from `Yii::$app->formatter->dateFormat`.

public string $dateFormat = null
$inline public property

If true, shows the widget as an inline calendar and the input as a hidden field.

public boolean $inline = false
$language public property

The locale ID (e.g. 'fr', 'de', 'en-GB') for the language to be used by the date picker. If this property is empty, then the current application language will be used.

Since version 2.0.2 a fallback is used if the application language includes a locale part (e.g. `de-DE`) and the language file does not exist, it will fall back to using `de`.

public string $language = null
$value public property

The input value. This value will be converted using `Yii::$app->formatter->asDate()` with the $dateFormat if it is not null.

public string $value = null

## Method Details

init() public method

Initializes the widget.

If you override this method, make sure you call the parent implementation first.

public void init ( )

renderWidget() protected method

Renders the DatePicker widget.

protected string renderWidget ( )
return | string | The rendering result.

run() public method

Renders the widget.

public void run ( )