# Datepicker

> Renders a Bootstrap datepicker as a text input, or as an inline calendar bound to a hidden input.

[API reference](/docs/api/index.md) › [Bootstrap 6](/docs/extensions/bootstrap6/reference/index.md) › Datepicker

| class | `yii2\extensions\bootstrap6\Datepicker` |
| --- | --- |
| Extends | [`InputWidget`](/docs/extensions/bootstrap6/reference/inputwidget/index.md) » [`yii\widgets\InputWidget`](/docs/api/yii/widgets/inputwidget/index.md) » [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) » [`yii\base\Component`](/docs/api/yii/base/component/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\ViewContextInterface`](/docs/api/yii/base/viewcontextinterface/index.md), [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Uses traits | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md), [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| Source | [`src/Datepicker.php`](https://github.com/yii2-extensions/bootstrap6/blob/main/src/Datepicker.php#L28) |

Renders a Bootstrap datepicker as a text input, or as an inline calendar bound to a hidden input.

Every option is emitted as the `data-bs-*` attribute read by the plugin. In inline mode the calendar container
carries the attributes and receives the `id` `{id}-datepicker`, and the selected dates default to the
comma-separated value of the hidden input.

See also: <https://getbootstrap.com/docs/6.0/forms/datepicker/>.

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-attribute"></span>[`$attribute`](/docs/api/yii/widgets/inputwidget/index.md#property-attribute) | `string\|null` | The model attribute that this widget is associated with. Default: `null`. | [`yii\widgets\InputWidget`](/docs/api/yii/widgets/inputwidget/index.md) |
| <span id="property-autoIdPrefix"></span>[`$autoIdPrefix`](/docs/api/yii/base/widget/index.md#property-autoIdPrefix) static | `string` | The prefix to the automatically generated widget IDs. Default: `'w'`. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-behaviors"></span>[`$behaviors`](/docs/api/yii/base/component/index.md#property-behaviors) read-only | `array<`[`yii\base\Behavior`](/docs/api/yii/base/behavior/index.md)`<static>>` | List of behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="property-clientEvents"></span>[`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents) | `array<string,` [`yii\web\JsExpression`](/docs/api/yii/web/jsexpression/index.md)`\|string>` | Event handlers attached to the widget element, as event name => JavaScript handler source. Default: `[]`. | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="property-clientOptions"></span>[`$clientOptions`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientOptions) | `array<string, mixed>\|false` | Options passed to the plugin constructor, or `false` to skip the JavaScript initialization. Default: `[]`. | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="property-containerOptions"></span>`$containerOptions` | `array<string, mixed>` | HTML attributes of the inline calendar container. Default: `[]`. | `Datepicker` |
| [`$dateFormat`](#property-dateFormat) | `array<string, mixed>\|null` | `Intl. Default: `null`. | `Datepicker` |
| <span id="property-dateMax"></span>`$dateMax` | `string\|null` | Latest selectable date in `YYYY-MM-DD` format, or `null` for no limit. Default: `null`. | `Datepicker` |
| <span id="property-dateMin"></span>`$dateMin` | `string\|null` | Earliest selectable date in `YYYY-MM-DD` format, or `null` for no limit. Default: `null`. | `Datepicker` |
| <span id="property-displayMonthsCount"></span>`$displayMonthsCount` | `int\|null` | Number of months displayed side by side, or `null` for the plugin default (`1`). Default: `null`. | `Datepicker` |
| <span id="property-field"></span>[`$field`](/docs/api/yii/widgets/inputwidget/index.md#property-field) | [`yii\widgets\ActiveField`](/docs/api/yii/widgets/activefield/index.md) | Active input field, which triggers this widget rendering. Default: `null`. Available since 2.0.11. | [`yii\widgets\InputWidget`](/docs/api/yii/widgets/inputwidget/index.md) |
| <span id="property-firstWeekday"></span>`$firstWeekday` | `int\|null` | First day of the week from `0` (Sunday) to `6` (Saturday), or `null` for the plugin default (`1`). Default: `null`. | `Datepicker` |
| <span id="property-id"></span>[`$id`](/docs/api/yii/base/widget/index.md#property-id) | `string` | Id of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-inline"></span>`$inline` | `bool` | Whether to render the calendar inline instead of a popup bound to a text input. Default: `false`. | `Datepicker` |
| <span id="property-locale"></span>`$locale` | `string\|null` | Locale used to format the dates, for example `de-DE`, or `null` for the browser locale. Default: `null`. | `Datepicker` |
| <span id="property-model"></span>[`$model`](/docs/api/yii/widgets/inputwidget/index.md#property-model) | [`yii\base\Model`](/docs/api/yii/base/model/index.md)`\|null` | The data model that this widget is associated with. Default: `null`. | [`yii\widgets\InputWidget`](/docs/api/yii/widgets/inputwidget/index.md) |
| <span id="property-name"></span>[`$name`](/docs/api/yii/widgets/inputwidget/index.md#property-name) | `string\|null` | The input name. Default: `null`. | [`yii\widgets\InputWidget`](/docs/api/yii/widgets/inputwidget/index.md) |
| <span id="property-options"></span>[`$options`](/docs/api/yii/widgets/inputwidget/index.md#property-options) | `array` | The HTML attributes for the input tag. Default: `[]`. | [`yii\widgets\InputWidget`](/docs/api/yii/widgets/inputwidget/index.md) |
| <span id="property-placement"></span>`$placement` | `string\|null` | Popup position relative to the input (`left`, `center`, `right`, `auto`), or `null` for the plugin default. Default: `null`. | `Datepicker` |
| <span id="property-selectedDates"></span>`$selectedDates` | `list<string>` | Preselected dates in `YYYY-MM-DD` format, taking precedence over the initial input value. Default: `[]`. | `Datepicker` |
| <span id="property-selectionMode"></span>`$selectionMode` | `string\|null` | Selection mode (`single`, `multiple`, `multiple-ranged`), or `null` for the plugin default (`single`). Default: `null`. | `Datepicker` |
| <span id="property-value"></span>[`$value`](/docs/api/yii/widgets/inputwidget/index.md#property-value) | `string` | The input value. Default: `null`. | [`yii\widgets\InputWidget`](/docs/api/yii/widgets/inputwidget/index.md) |
| <span id="property-view"></span>[`$view`](/docs/api/yii/base/widget/index.md#property-view) | [`yii\web\View`](/docs/api/yii/web/view/index.md) | The view object that can be used to render views or view files. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-viewPath"></span>[`$viewPath`](/docs/api/yii/base/widget/index.md#property-viewPath) read-only | `string` | The directory containing the view files for this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-__construct"></span>[`__construct()`](/docs/api/yii/base/baseobject/index.md#method-__construct) | Constructor. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__call"></span>[`__call()`](/docs/api/yii/base/component/index.md#method-__call) | Calls the named method which is not a class method. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__clone"></span>[`__clone()`](/docs/api/yii/base/component/index.md#method-__clone) | This method is called after the object is created by cloning an existing one. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__get"></span>[`__get()`](/docs/api/yii/base/component/index.md#method-__get) | Returns the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__isset"></span>[`__isset()`](/docs/api/yii/base/component/index.md#method-__isset) | Checks if a property is set, i.e. defined and not null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__set"></span>[`__set()`](/docs/api/yii/base/component/index.md#method-__set) | Sets the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__unset"></span>[`__unset()`](/docs/api/yii/base/component/index.md#method-__unset) | Sets a component property to be null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-addAttributes"></span>[`addAttributes()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addAttributes) | Adds a set of HTML attributes; attributes already set with the same name are replaced. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-addClass"></span>[`addClass()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addClass) | Adds one or more CSS classes to the existing classes; duplicated classes are collapsed. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-addCssStyle"></span>[`addCssStyle()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-addCssStyle) | Adds CSS style properties to the `style` attribute. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-afterRun"></span>[`afterRun()`](/docs/api/yii/base/widget/index.md#method-afterRun) | This method is invoked right after a widget is executed. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-attachBehavior"></span>[`attachBehavior()`](/docs/api/yii/base/component/index.md#method-attachBehavior) | Attaches a behavior to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attachBehaviors"></span>[`attachBehaviors()`](/docs/api/yii/base/component/index.md#method-attachBehaviors) | Attaches a list of behaviors to the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attribute"></span>[`attribute()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-attribute) | Sets an HTML attribute value. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-beforeRun"></span>[`beforeRun()`](/docs/api/yii/base/widget/index.md#method-beforeRun) | This method is invoked right before the widget is executed. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-begin"></span>[`begin()`](/docs/api/yii/base/widget/index.md#method-begin) static | Begins a widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-behaviors"></span>[`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) | Returns a list of behaviors that this component should behave as. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canGetProperty"></span>[`canGetProperty()`](/docs/api/yii/base/component/index.md#method-canGetProperty) | Returns a value indicating whether a property can be read. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canSetProperty"></span>[`canSetProperty()`](/docs/api/yii/base/component/index.md#method-canSetProperty) | Returns a value indicating whether a property can be set. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-class"></span>[`class()`](/docs/extensions/bootstrap6/reference/attributestrait/index.md#method-class) | Replaces the existing CSS classes with the specified ones. | [`AttributesTrait`](/docs/extensions/bootstrap6/reference/attributestrait/index.md) |
| <span id="method-className"></span>[`className()`](/docs/api/yii/base/baseobject/index.md#method-className) static | Returns the fully qualified name of this class. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-detachBehavior"></span>[`detachBehavior()`](/docs/api/yii/base/component/index.md#method-detachBehavior) | Detaches a behavior from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-detachBehaviors"></span>[`detachBehaviors()`](/docs/api/yii/base/component/index.md#method-detachBehaviors) | Detaches all behaviors from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-end"></span>[`end()`](/docs/api/yii/base/widget/index.md#method-end) static | Ends a widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-ensureBehaviors"></span>[`ensureBehaviors()`](/docs/api/yii/base/component/index.md#method-ensureBehaviors) | Makes sure that the behaviors declared in [`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) are attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehavior"></span>[`getBehavior()`](/docs/api/yii/base/component/index.md#method-getBehavior) | Returns the named behavior object. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehaviors"></span>[`getBehaviors()`](/docs/api/yii/base/component/index.md#method-getBehaviors) | Returns all behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getId"></span>[`getId()`](/docs/api/yii/base/widget/index.md#method-getId) | Returns the ID of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-getView"></span>[`getView()`](/docs/api/yii/base/widget/index.md#method-getView) | Returns the view object that can be used to render views or view files. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-getViewPath"></span>[`getViewPath()`](/docs/api/yii/base/widget/index.md#method-getViewPath) | Returns the directory containing the view files for this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-hasEventHandlers"></span>[`hasEventHandlers()`](/docs/api/yii/base/component/index.md#method-hasEventHandlers) | Returns a value indicating whether there is any handler attached to the named event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasMethod"></span>[`hasMethod()`](/docs/api/yii/base/component/index.md#method-hasMethod) | Returns a value indicating whether a method is defined. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasProperty"></span>[`hasProperty()`](/docs/api/yii/base/component/index.md#method-hasProperty) | Returns a value indicating whether a property is defined for this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| [`init()`](#method-init) | Initializes the widget and validates the closed option sets. | `Datepicker` |
| <span id="method-off"></span>[`off()`](/docs/api/yii/base/component/index.md#method-off) | Detaches an existing event handler from this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-on"></span>[`on()`](/docs/api/yii/base/component/index.md#method-on) | Attaches an event handler to an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-render"></span>[`render()`](/docs/api/yii/base/widget/index.md#method-render) | Renders a view. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-renderFile"></span>[`renderFile()`](/docs/api/yii/base/widget/index.md#method-renderFile) | Renders a view file. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| [`run()`](#method-run) |  | `Datepicker` |
| <span id="method-setId"></span>[`setId()`](/docs/api/yii/base/widget/index.md#method-setId) | Sets the ID of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-setView"></span>[`setView()`](/docs/api/yii/base/widget/index.md#method-setView) | Sets the view object to be used by this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-trigger"></span>[`trigger()`](/docs/api/yii/base/component/index.md#method-trigger) | Triggers an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-widget"></span>[`widget()`](/docs/api/yii/base/widget/index.md#method-widget) static | Creates a widget instance and runs it. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| [`dataAttributes()`](#method-dataAttributes) protected | Returns the `data-bs-*` attributes of the plugin element. | `Datepicker` |
| <span id="method-hasModel"></span>[`hasModel()`](/docs/api/yii/widgets/inputwidget/index.md#method-hasModel) protected |  | [`yii\widgets\InputWidget`](/docs/api/yii/widgets/inputwidget/index.md) |
| [`pluginInitialization()`](#method-pluginInitialization) protected |  | `Datepicker` |
| <span id="method-registerClientEvents"></span>[`registerClientEvents()`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#method-registerClientEvents) protected | Registers the JavaScript event handlers listed in [`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents) at [`View::POS_END`](/docs/api/yii/web/view/index.md#const-POS_END). | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| <span id="method-registerPlugin"></span>[`registerPlugin()`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#method-registerPlugin) protected | Registers the plugin asset, the plugin initialization when needed, and the [`$clientEvents`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md#property-clientEvents). | [`BootstrapWidgetTrait`](/docs/extensions/bootstrap6/reference/bootstrapwidgettrait/index.md) |
| [`renderInline()`](#method-renderInline) protected | Renders the inline calendar container with the hidden input that receives the selected dates. | `Datepicker` |
| <span id="method-renderInputHtml"></span>[`renderInputHtml()`](/docs/api/yii/widgets/inputwidget/index.md#method-renderInputHtml) protected | Render a HTML input tag. | [`yii\widgets\InputWidget`](/docs/api/yii/widgets/inputwidget/index.md) |

## Events

| Event | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="event-EVENT_INIT"></span>[`EVENT_INIT`](/docs/api/yii/base/widget/index.md#event-EVENT_INIT) | [`yii\base\Event`](/docs/api/yii/base/event/index.md) | An event that is triggered when the widget is initialized via [`init()`](/docs/api/yii/base/widget/index.md#method-init). Event name: `'init'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_BEFORE_RUN"></span>[`EVENT_BEFORE_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_BEFORE_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_AFTER_RUN"></span>[`EVENT_AFTER_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_AFTER_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |

## Constants

| Constant | Value | Description | Defined by |
| --- | --- | --- | --- |
| <span id="const-PLACEMENTS"></span>`PLACEMENTS` | `['left', 'center', 'right', 'auto']` | Allowed values of [`$placement`](/docs/extensions/bootstrap6/reference/datepicker/index.md#property-placement). | `Datepicker` |
| <span id="const-SELECTION_MODES"></span>`SELECTION_MODES` | `['single', 'multiple', 'multiple-ranged']` | Allowed values of [`$selectionMode`](/docs/extensions/bootstrap6/reference/datepicker/index.md#property-selectionMode). | `Datepicker` |

## Property details

### $dateFormat <span id="property-dateFormat"></span>

```php
public array<string, mixed>|null $dateFormat = null
```

`Intl.

DateTimeFormat` options used to display the dates, or `null` for the
locale default.

## Method details

### init() <span id="method-init"></span>

```php
public function init(): void
```

Initializes the widget and validates the closed option sets.

**Throws**

- [`yii\base\InvalidConfigException`](/docs/api/yii/base/invalidconfigexception/index.md): if [`$selectionMode`](/docs/extensions/bootstrap6/reference/datepicker/index.md#property-selectionMode), [`$placement`](/docs/extensions/bootstrap6/reference/datepicker/index.md#property-placement) or [`$firstWeekday`](/docs/extensions/bootstrap6/reference/datepicker/index.md#property-firstWeekday) is invalid.

### run() <span id="method-run"></span>

```php
public function run(): string
```

**Returns**

`string`

### dataAttributes() <span id="method-dataAttributes"></span>

```php
protected function dataAttributes(list<string> $selectedDates): array<string, mixed>
```

Returns the `data-bs-*` attributes of the plugin element.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$selectedDates` | `list<string>` | Preselected dates. |

**Returns**

`array<string, mixed>`

### pluginInitialization() <span id="method-pluginInitialization"></span>

```php
protected function pluginInitialization(string $name, string $element, string $options): string
```

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$name` | `string` |  |
| `$element` | `string` |  |
| `$options` | `string` |  |

**Returns**

`string`

### renderInline() <span id="method-renderInline"></span>

```php
protected function renderInline(): string
```

Renders the inline calendar container with the hidden input that receives the selected dates.

**Returns**

`string`