This article describes the API migration process of DatePicker component from Essential JS 1 to Essential JS 2.
|
Behavior
|
API in Essential JS 1
|
API in Essential JS 2
|
|
CSS Class
|
property: cssClass
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
cssClass: "gradient-lime"
});
```
|
property: cssClass
```ts
let datepickerObject: DatePicker = new DatePicker({
cssClass: 'e-custom-style'
});
datepickerObject.appendTo('#element');
```
|
|
Event callback for each cell creation
|
Not Applicable
|
Event: renderDayCell
```ts
let datepickerObject: DatePicker = new DatePicker({
renderDayCell: onRenderCell
});
datepickerObject.appendTo('#element');
function onRenderCell(args: RenderDayCellEventArgs): void {
/* code block */
}
```
|
|
Show/Hide the today button
|
property: showFooter
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
showFooter: false
});
```
|
property: showTodayButton
```ts
let datepickerObject: DatePicker = new DatePicker({
showTodayButton: false
});
datepickerObject.appendTo('#element');
```
|
|
Show/Hide the other month dates
|
property: showOtherMonths
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
showOtherMonths: false
});
```
|
Can be achieved by
```ts
let datepickerObject: DatePicker = new DatePicker();
datepickerObject.appendTo('#element');
```
```
.e-datepicker .e-calendar .e-content tr.e-month-hide,
.e-datepicker .e-calendar .e-content td.e-other-month > .e-day {
visibility: none;
}
.e-datepicker .e-calendar .e-content td.e-month-hide,
.e-datepicker .e-calendar .e-content td.e-other-month {
pointer-events: none;
touch-action: none;
}
```
|
|
Show/Hide the disabled range
|
property: showDisabledRange
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
showDisabledRange: false,
blackoutDates: [new Date(2016, 4, 10), new Date(2016, 4, 15), new Date(2016, 4, 20), new Date(2016, 4, 22), new Date(2016, 5, 12), new Date(2016, 5, 24)]
});
```
|
Not Applicable
|
|
Show/Hide the popup button
|
property: showPopupButton
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
showPopupButton: false
});
```
|
Can be achieved by
```ts
let datepickerObject: DatePicker = new DatePicker({
focus: onFocus
});
datepickerObject.appendTo('#element');
function onFocus(args: FocusEventArgs) {
datepickerObject.show();
}
```
```
.e-datepicker .e-control-wrapper .e-input-group-icon.e-date-icon{
display: none;
}
```
|
|
Enable /Disable the rounded corner
|
property: showRoundedCorner
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
showRoundedCorner: true
});
```
|
Can be achieved by
```ts
let datepickerObject: DatePicker = new DatePicker({
cssClass: 'e-custom-style'
});
datepickerObject.appendTo('#element');
```
```
.e-control-wrapper.e-custom-style.e-date-wrapper.e-input-group{
border-radius: 4px;
}
```
|
|
Skip a month
|
property: stepMonths
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
stepMonths: 2
});
```
|
Can be achieved by
```ts
let datepickerObject: DatePicker = new DatePicker({
value: new Date("09/04/2019"),
open:onOpen
});
datepickerObject.appendTo('#element');
function onOpen(args:any){
datepickerObject.navigateTo('Year', new Date("03/18/2018"));
}
```
|
|
Show/Hide the tooltip
|
property: showTooltip
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
showTooltip: false
});
```
|
Not Applicable
|
|
Button text
|
property: buttonText
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
buttonText : "Now"
});
```
|
Can be achieved by
```ts
L10n.load({ 'en': {'datepicker': {today:'Now' }}});
let datepickerObject: DatePicker = new DatePicker({
locale: 'en'
});
datepickerObject.appendTo('#element');
```
|
|
Display inline
|
property: displayInline
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
displayInline: true
});
```
|
Not Applicable
|
|
Enable/Disable the animation
|
property: enableAnimation
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
enableAnimation : false
});
```
|
Not Applicable
|
|
Highlight dates
|
property: highlightSection
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
highlightSection: "week"
});
```
|
Can be achieved by
```ts
let datepickerObject: DatePicker = new DatePicker({
renderDayCell: highlightDate
});
datepickerObject.appendTo('#element');
function highlightDate(args: RenderDayCellEventArgs): void {
if (args.date.getDate() === 10) {
args.element.classList.add('e-highlightweekend');
}
}
```
```
.e-highlightweekend {
background-color: #cfe9f3;
}
```
|
|
Highlight weekend
|
property: highlightWeekend
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
highlightWeekend : true
});
```
|
Can be achieved by
```ts
let datepickerObject: DatePicker = new DatePicker({
renderDayCell: highlightDate
});
datepickerObject.appendTo('#element');
function highlightDate(args: RenderDayCellEventArgs): void {
if (args.date.getDay() === 0 || args.date.getDay() === 6) {
args.element.classList.add('e-highlightweekend');
}
}
```
```
.e-highlightweekend {
background-color: #cfe9f3;
}
```
|
|
Tooltip format
|
property: tooltipFormat
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
tooltipFormat : "dd/MM/yyyy"
});
```
|
Not Applicable
|
|
Special dates
|
property: specialDates
```ts
specialDays = [ { date: new Date(2018, 09, 08), tooltip: "In Australia", iconClass: "flags sprite-Australia" },{ date: new Date(2018, 09, 21), tooltip: "In France", iconClass: "flags sprite-France" }]
var dateObj = new ej.DatePicker($("#datepicker"), {
specialDates : specialDays
});
```
|
Can be achieved by
```ts
let datepickerObject: DatePicker = new DatePicker({
renderDayCell: customDates,
value: new Date('5/5/2017')
});
datepickerObject.appendTo('#element');
function customDates(args: RenderDayCellEventArgs) {
if (args.date.getDate() === 10) {
let span: HTMLElement;
span = document.createElement('span');
span.setAttribute('class', 'e-icons highlight');
args.element.firstElementChild.setAttribute('title', 'Birthday !');
args.element.setAttribute('title', 'Birthday !');
args.element.setAttribute('data-val', 'Birthday !');
args.element.appendChild(span);
}
}
```
|
|
FocusIn event
|
Event: focusIn
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
focusIn: function (args) {/*code block*/}
});
```
|
Event: focus
```ts
let datepickerObject: DatePicker = new DatePicker({
focus: onFocus
});
datepickerObject.appendTo('#element');
function onFocus(args: FocusEventArgs): void {
/*code block*/
}
```
|
|
FocusOut event
|
Event: focusOut
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
focusOut: function (args) {/*code block*/}
});
```
|
Event: blur
```ts
let datepickerObject: DatePicker = new DatePicker({
blur: onBlur
});
datepickerObject.appendTo('#element');
function onBlur(args: BlurEventArgs): void {
/*code block*/
}
```
|
|
FocusIn method
|
Not Applicable
|
Method: focusIn()
```ts
let datepickerObject: DatePicker = new DatePicker({
placeholder: 'Enter date'
});
datepickerObject.appendTo('#element');
datepickerObject.focusIn();
```
|
|
FocusOut method
|
Not Applicable
|
Method: focusOut()
```ts
let datepickerObject: DatePicker = new DatePicker({
placeholder: 'Enter date'
});
datepickerObject.appendTo('#element');
datepickerObject.focusOut();
```
|
|
Prevent popup close
|
Not Applicable
|
Event: close
```ts
let datepickerObject: DatePicker = new DatePicker({
close: function (args: PreventableEventArgs) {
args.preventDefault();
}
});
datepickerObject.appendTo('#element');
datepickerObject.show();
```
|
|
Prevent popup open
|
Not Applicable
|
Event: close
```ts
let datepickerObject: DatePicker = new DatePicker({
open: function (args: PreventableEventArgs) {
args.preventDefault();
}
});
datepickerObject.appendTo('#element');
datepickerObject.show();
```
|
|
Behavior
|
API in Essential JS 1
|
API in Essential JS 2
|
|
Validation rules
|
property: validationRules
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
validationRules : {required : true}
});
```
|
Can be achieved by
```ts
let datepickerObject: DatePicker = new DatePicker({
placeholder: 'Enter date',
value: new Date()
});
datepickerObject.appendTo('#element');
let options: FormValidatorModel = {
rules: {
'datevalue': { required: true }
}
}
let formObject: FormValidator = new FormValidator('#form-element', options);
```
|
|
Validation message
|
property: validationMessage
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
validationRules : {required : true},
validationMessage : {required: "Required Date value" }
});
```
|
Can be achieved by
```ts
let datepickerObject: DatePicker = new DatePicker({
placeholder: 'Enter date',
value: new Date()
});
datepickerObject.appendTo('#element');
let options: FormValidatorModel = {
rules: {
'datevalue': { required: [true, 'Date value required'] }
},
customPlacement: function (inputElement, errorElement) {
(inputElement).parentElement.parentElement.appendChild(errorElement);
}
}
let formObject: FormValidator = new FormValidator('#form-element', options);
```
</td>
</tr>
</table>
## Common
|
Behavior
|
API in Essential JS 1
|
API in Essential JS 2
|
|
Width
|
property: width
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
width: 200
});
```
|
property: width
```ts
let datepickerObject: DatePicker = new DatePicker({
width: '200px'
});
datepickerObject.appendTo('#element');
```
|
|
Readonly
|
property: readOnly
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
readOnly : true
});
```
|
property: readonly
```ts
let datepickerObject: DatePicker = new DatePicker({
readonly:true,
value:new Date()
});
datepickerObject.appendTo('#element');
```
|
|
Show/Hide the clear button
|
Not Applicable
|
property: showClearButton
```ts
let datepickerObject: DatePicker = new DatePicker({
showClearButton: false
});
datepickerObject.appendTo('#element');
```
|
|
Height
|
property: height
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
height: 35
});
```
|
Can be achieved by
```ts
let datepickerObject: DatePicker = new DatePicker({
cssClass: 'e-custom-style'
});
datepickerObject.appendTo('#element');
```
```
.e-control-wrapper.e-custom-style.e-date-wrapper.e-input-group {
height: 35px;
}
```
|
|
Html attributes
|
property: htmlAttributes
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
htmlAttributes : {required:"required"}
});
```
|
Not Applicable
|
|
Shoe/Hide the Week Number
|
property: weekNumber
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
weekNumber : true
});
```
|
property: weekNumber
```ts
let datepickerObject: DatePicker = new DatePicker({
weekNumber:true
});
datepickerObject.appendTo('#element');
```
|
|
Watermark text
|
property: watermarkText
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
watermarkText: "Enter date"
});
```
|
property: placeholder
```ts
let datepickerObject: DatePicker = new DatePicker({
placeholder: 'Enter date'
});
datepickerObject.appendTo('#element');
```
|
|
Disable/Enable
|
property: enabled
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
enabled: false
});
```
|
property: enabled
```ts
let datepickerObject: DatePicker = new DatePicker({
enabled:false
});
datepickerObject.appendTo('#element');
```
|
|
Disable the DatePicker
|
Method: disable()
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
});
dateObj.disable();
```
|
Not Applicable
|
|
Enable the DatePicker
|
Method: enable()
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
});
dateObj.enable();
```
|
Not Applicable
|
|
Enable/Disable the textbox editing
|
property: allowEdit
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
allowEdit : false
});
```
|
property: allowEdit
```ts
let datepickerObject: DatePicker = new DatePicker({
allowEdit : false
});
datepickerObject.appendTo('#element');
```
|
|
zIndex
|
Not Applicable
|
property: zIndex
```ts
let datepickerObject: DatePicker = new DatePicker({
zIndex: 100
});
datepickerObject.appendTo('#element');
```
|
|
Specify the placeholder text behavior
|
Not Applicable
|
property: floatLabelType
```ts
let datepickerObject: DatePicker = new DatePicker({
placeholder: 'Enter date',
floatLabelType: 'Auto'
});
datepickerObject.appendTo('#element');
```
|
## Globalization
|
Behavior
|
API in Essential JS 1
|
API in Essential JS 2
|
|
Locale
|
property: locale
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
locale: "en-US"
});
```
|
property: locale
```ts
let datepickerObject: DatePicker = new DatePicker({
locale: 'en'
});
datepickerObject.appendTo('#element');
```
|
|
First day of week
|
property: startDay
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
startDay: 2
});
```
|
property: firstDayOfWeek
```ts
let datepickerObject: DatePicker = new DatePicker({
firstDayOfWeek: 2
});
datepickerObject.appendTo('#element');
```
|
## Strict Mode
|
Behavior
|
API in Essential JS 1
|
API in Essential JS 2
|
|
Strict mode
|
property: enableStrictMode
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
enableStrictMode : true
});
```
|
property: strictMode
```ts
let datepickerObject: DatePicker = new DatePicker({
strictMode: true,
value: new Date('5/28/2017'),
min: new Date('5/5/2017'),
max: new Date('5/25/2017')
});
datepickerObject.appendTo('#element');
```
|
## Open and Close
|
Behavior
|
API in Essential JS 1
|
API in Essential JS 2
|
|
Close
|
Event: close
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
close: function (args) {/* code block*/}
});
```
|
Event: close
```ts
let datepickerObject: DatePicker = new DatePicker({
close: function (args: PreventableEventArgs) {/*code block*/}
});
datepickerObject.appendTo('#element');
```
|
|
Hide
|
Method: hide()
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
});
dateObj.hide();
```
|
Method: hide()
```ts
let datepickerObject: DatePicker = new DatePicker({
value: new Date("05/11/2017")
});
datepickerObject.appendTo('#element');
datepickerObject.hide();
```
|
|
Open
|
Event: open
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
open: function (args) {/* code block*/}
});
```
|
Event: open
```ts
let datepickerObject: DatePicker = new DatePicker({
open: function (args: PreventableEventArgs) {
/*code block*/
}
});
datepickerObject.appendTo('#element');
```
|
|
Show
|
Method: show()
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
});
dateObj.show();
```
|
Method: show()
```ts
let datepickerObject: DatePicker = new DatePicker({
value: new Date("05/11/2017")
});
datepickerObject.appendTo('#element');
datepickerObject.show();
```
|
## View Navigation
|
Behavior
|
API in Essential JS 1
|
API in Essential JS 2
|
|
Navigate to specific month
|
Not Applicable
|
Method: navigateTo()
```ts
let datepickerObject: DatePicker = new DatePicker({
value: new Date("09/04/2019"),
open:onOpen
});
datepickerObject.appendTo('#element');
function onOpen(args:any){
datepickerObject.navigateTo('Year', new Date("03/18/2018"));
}
```
|
|
Navigation callback
|
Event: navigate
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
navigate: function (args) {/*code block*/}
});
```
|
Event: navigated
```ts
let datepickerObject: DatePicker = new DatePicker({
navigated: onNavigate
});
datepickerObject.appendTo('#element');
function onNavigate(args: NavigatedEventArgs) {/*code block*/}
```
|
</tr>
|
Drill down
|
property: allowDrillDown
```ts
var dateObj = new ej.DatePicker($("#datepicker"), {
allowDrillDown : true
});
```
|
Not Applicable
|
</table>
|