package.src.docs.Events.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eonasdan-bootstrap-datetimepicker Show documentation

A date/time picker component designed to work with Bootstrap 3 and Momentjs. For usage, installation and demos see Project Site on GitHub

The newest version!

## Events

### dp.hide

Fired when the widget is hidden.

Parameters:

```
e = {
    date //the currently set date. Type: moment object (clone)
}
```

Emitted from:

* toggle()
* hide()
* disable()

----------------------

### dp.show

Fired when the widget is shown.

Parameters:

No parameters are include, listen to `dp.change` instead

Emitted from:

* toggle()
* show()

----------------------

### dp.change

Fired when the date is changed, including when changed to a non-date (e.g. When keepInvalid=true).

Parameters:

```
e = {
    date, //date the picker changed to. Type: moment object (clone)
    oldDate //previous date. Type: moment object (clone) or false in the event of a null
}
```

Emitted from:

* toggle() **Note**: Only fired when using `useCurrent`
* show() **Note**: Only fired when using `useCurrent` or when or the date is changed to comply with date rules (min/max etc)
* date(newDate)
* minDate(minDate)
* maxDate(maxDate)
* daysOfWeekDisabled()

----------------------

### dp.error

Fired when a selected date fails to pass validation.

Parameters:

```
e = {
    date //the invalid date. Type: moment object (clone)
    oldDate //previous date. Type: moment object (clone) or false in the event of a null
}
```

Emmited from:

* minDate(minDate)
* maxDate(maxDate)
* daysOfWeekDisabled()
* setValue() *private function*

----------------------

### dp.update

4.14.30

Fired (in most cases) when the `viewDate` changes. E.g. Next and Previous buttons, selecting a year.

Parameters:

```
e = {
   change, //Change type as a momentjs format token. Type: string e.g. yyyy on year change
   viewDate //new viewDate. Type: moment object
}
```