Skip to content

Commit 247ba84

Browse files
authored
refactor: handle user-selected date properly (#3530)
1 parent 4be73e8 commit 247ba84

6 files changed

Lines changed: 70 additions & 25 deletions

File tree

‎packages/date-picker/src/vaadin-date-picker-light.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ class DatePickerLight extends ThemableMixin(DatePickerMixin(PolymerElement)) {
8383
i18n="[[i18n]]"
8484
fullscreen$="[[_fullscreen]]"
8585
label="[[label]]"
86-
selected-date="{{_selectedDate}}"
86+
selected-date="[[_selectedDate]]"
8787
slot="dropdown-content"
8888
focused-date="{{_focusedDate}}"
8989
show-week-numbers="[[showWeekNumbers]]"

‎packages/date-picker/src/vaadin-date-picker-mixin.js‎

Lines changed: 44 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ export const DatePickerMixin = (subclass) =>
394394
if (this.autoOpenDisabled) {
395395
const parsedDate = this._getParsedDate();
396396
if (this._isValidDate(parsedDate)) {
397-
this._selectedDate = parsedDate;
397+
this._selectDate(parsedDate);
398398
}
399399
}
400400

@@ -462,6 +462,20 @@ export const DatePickerMixin = (subclass) =>
462462
this._overlayContent.addEventListener('close', this._close.bind(this));
463463
this._overlayContent.addEventListener('focus-input', this._focusAndSelect.bind(this));
464464

465+
// User confirmed selected date by clicking the calendar.
466+
this._overlayContent.addEventListener('date-tap', (e) => {
467+
this.__userConfirmedDate = true;
468+
469+
this._selectDate(e.detail.date);
470+
});
471+
472+
// User confirmed selected date by pressing Enter or Today.
473+
this._overlayContent.addEventListener('date-selected', (e) => {
474+
this.__userConfirmedDate = true;
475+
476+
this._selectDate(e.detail.date);
477+
});
478+
465479
// Keep focus attribute in focusElement for styling
466480
this._overlayContent.addEventListener('focus', () => {
467481
this._setFocused(true);
@@ -508,6 +522,24 @@ export const DatePickerMixin = (subclass) =>
508522
return inputValid && minMaxValid && inputValidity;
509523
}
510524

525+
/**
526+
* Select date on user interaction and set the flag
527+
* to fire change event if necessary.
528+
*
529+
* @param {Date} dateToSelect
530+
* @protected
531+
*/
532+
_selectDate(dateToSelect) {
533+
const value = this._formatISO(dateToSelect);
534+
535+
// Only set flag if the value will change.
536+
if (this.value !== value) {
537+
this.__dispatchChange = true;
538+
}
539+
540+
this._selectedDate = dateToSelect;
541+
}
542+
511543
/** @private */
512544
_close(e) {
513545
if (e) {
@@ -609,9 +641,6 @@ export const DatePickerMixin = (subclass) =>
609641
if (selectedDate === undefined || formatDate === undefined) {
610642
return;
611643
}
612-
if (this.__userInputOccurred) {
613-
this.__dispatchChange = true;
614-
}
615644
const value = this._formatISO(selectedDate);
616645

617646
this.__keepInputValue || this._applyInputValue(selectedDate);
@@ -620,8 +649,6 @@ export const DatePickerMixin = (subclass) =>
620649
this.validate();
621650
this.value = value;
622651
}
623-
this.__userInputOccurred = false;
624-
this.__dispatchChange = false;
625652
this._ignoreFocusedDateChange = true;
626653
this._focusedDate = selectedDate;
627654
this._ignoreFocusedDateChange = false;
@@ -632,7 +659,6 @@ export const DatePickerMixin = (subclass) =>
632659
if (focusedDate === undefined || formatDate === undefined) {
633660
return;
634661
}
635-
this.__userInputOccurred = true;
636662
if (!this._ignoreFocusedDateChange && !this._noInput) {
637663
this._applyInputValue(focusedDate);
638664
}
@@ -751,14 +777,15 @@ export const DatePickerMixin = (subclass) =>
751777
const parsedDate = this._getParsedDate(inputValue);
752778

753779
if (this._isValidDate(parsedDate)) {
754-
this._selectedDate = parsedDate;
780+
this._selectDate(parsedDate);
755781
} else {
756782
this.__keepInputValue = true;
783+
this._selectDate(null);
757784
this._selectedDate = null;
758785
this.__keepInputValue = false;
759786
}
760787
} else if (this._focusedDate) {
761-
this._selectedDate = this._focusedDate;
788+
this._selectDate(this._focusedDate);
762789
}
763790
this._ignoreFocusedDateChange = false;
764791
}
@@ -774,7 +801,12 @@ export const DatePickerMixin = (subclass) =>
774801
this._touchPrevented = [];
775802
}
776803

777-
this._selectParsedOrFocusedDate();
804+
// No need to select date on close if it was confirmed by the user.
805+
if (this.__userConfirmedDate) {
806+
this.__userConfirmedDate = false;
807+
} else {
808+
this._selectParsedOrFocusedDate();
809+
}
778810

779811
if (this._nativeInput && this._nativeInput.selectionStart) {
780812
this._nativeInput.selectionStart = this._nativeInput.selectionEnd;
@@ -903,7 +935,7 @@ export const DatePickerMixin = (subclass) =>
903935
const isValidDate = this._isValidDate(parsedDate);
904936
if (this.opened) {
905937
if (this._overlayInitialized && this._overlayContent.focusedDate && isValidDate) {
906-
this._selectedDate = this._overlayContent.focusedDate;
938+
this._selectDate(this._overlayContent.focusedDate);
907939
}
908940
this.close();
909941
} else if (!isValidDate && this.inputElement.value !== '') {
@@ -926,7 +958,7 @@ export const DatePickerMixin = (subclass) =>
926958
} else if (this.autoOpenDisabled) {
927959
// Do not restore selected date if Esc was pressed after clearing input field
928960
if (this.inputElement.value === '') {
929-
this._selectedDate = null;
961+
this._selectDate(null);
930962
}
931963
this._applyInputValue(this._selectedDate);
932964
} else {

‎packages/date-picker/src/vaadin-date-picker-overlay-content.js‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -237,8 +237,7 @@ class DatePickerOverlayContent extends ControllerMixin(ThemableMixin(DirMixin(Po
237237
* The value for this element.
238238
*/
239239
selectedDate: {
240-
type: Date,
241-
notify: true
240+
type: Date
242241
},
243242

244243
/**
@@ -370,6 +369,17 @@ class DatePickerOverlayContent extends ControllerMixin(ThemableMixin(DirMixin(Po
370369
this._scrollToPosition(this._differenceInMonths(date, this._originDate), animate);
371370
}
372371

372+
/**
373+
* Select a date and fire event indicating user interaction.
374+
* @protected
375+
*/
376+
_selectDate(dateToSelect) {
377+
this.selectedDate = dateToSelect;
378+
this.dispatchEvent(
379+
new CustomEvent('date-selected', { detail: { date: dateToSelect }, bubbles: true, composed: true })
380+
);
381+
}
382+
373383
_focusedDateChanged(focusedDate) {
374384
this.revealDate(focusedDate);
375385
}
@@ -460,7 +470,7 @@ class DatePickerOverlayContent extends ControllerMixin(ThemableMixin(DirMixin(Po
460470
if (Math.abs(this.$.monthScroller.position - this._differenceInMonths(today, this._originDate)) < 0.001) {
461471
// Select today only if the month scroller is positioned approximately
462472
// at the beginning of the current month
463-
this.selectedDate = today;
473+
this._selectDate(today);
464474
this._close();
465475
} else {
466476
this._scrollToCurrentMonth();
@@ -659,7 +669,7 @@ class DatePickerOverlayContent extends ControllerMixin(ThemableMixin(DirMixin(Po
659669
}
660670

661671
_clear() {
662-
this.selectedDate = '';
672+
this._selectDate('');
663673
}
664674

665675
_close() {
@@ -683,10 +693,10 @@ class DatePickerOverlayContent extends ControllerMixin(ThemableMixin(DirMixin(Po
683693

684694
__toggleDate(date) {
685695
if (dateEquals(date, this.selectedDate)) {
686-
this.selectedDate = '';
696+
this._clear();
687697
this.focusedDate = date;
688698
} else {
689-
this.selectedDate = date;
699+
this._selectDate(date);
690700
}
691701
}
692702

@@ -711,7 +721,7 @@ class DatePickerOverlayContent extends ControllerMixin(ThemableMixin(DirMixin(Po
711721
handled = true;
712722
break;
713723
case 'Enter':
714-
this.selectedDate = this.focusedDate;
724+
this._selectDate(this.focusedDate);
715725
this._close();
716726
handled = true;
717727
break;

‎packages/date-picker/src/vaadin-date-picker.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ class DatePicker extends DatePickerMixin(InputControlMixin(ThemableMixin(Element
171171
i18n="[[i18n]]"
172172
fullscreen$="[[_fullscreen]]"
173173
label="[[label]]"
174-
selected-date="{{_selectedDate}}"
174+
selected-date="[[_selectedDate]]"
175175
slot="dropdown-content"
176176
focused-date="{{_focusedDate}}"
177177
show-week-numbers="[[showWeekNumbers]]"

‎packages/date-picker/src/vaadin-month-calendar.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,9 @@ class MonthCalendar extends FocusMixin(ThemableMixin(PolymerElement)) {
369369
_handleTap(e) {
370370
if (!this.ignoreTaps && !this._notTapping && e.target.date && !e.target.hasAttribute('disabled')) {
371371
this.selectedDate = e.target.date;
372-
this.dispatchEvent(new CustomEvent('date-tap', { bubbles: true, composed: true }));
372+
this.dispatchEvent(
373+
new CustomEvent('date-tap', { detail: { date: e.target.date }, bubbles: true, composed: true })
374+
);
373375
}
374376
}
375377

‎packages/date-picker/test/basic.test.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,8 @@ describe('basic features', () => {
190190
it('should close on overlay date tap', async () => {
191191
await open(datepicker);
192192
const spy = sinon.spy(datepicker, 'close');
193-
getOverlayContent(datepicker).dispatchEvent(new CustomEvent('date-tap', { bubbles: true, composed: true }));
193+
const evt = new CustomEvent('date-tap', { detail: { date: new Date() }, bubbles: true, composed: true });
194+
getOverlayContent(datepicker).dispatchEvent(evt);
194195
expect(spy.called).to.be.true;
195196
});
196197

@@ -424,7 +425,7 @@ describe('basic features', () => {
424425
});
425426

426427
datepicker.open();
427-
getOverlayContent(datepicker).selectedDate = new Date('2017-01-01'); // invalid
428+
getOverlayContent(datepicker)._selectDate(new Date('2017-01-01')); // invalid
428429
});
429430

430431
it('should change invalid state only once', (done) => {
@@ -436,7 +437,7 @@ describe('basic features', () => {
436437
const invalidChangedSpy = sinon.spy();
437438
datepicker.addEventListener('invalid-changed', invalidChangedSpy);
438439
datepicker.open();
439-
getOverlayContent(datepicker).selectedDate = new Date('2017-01-01');
440+
getOverlayContent(datepicker)._selectDate(new Date('2017-01-01'));
440441
});
441442

442443
it('should scroll to min date when today is not allowed', (done) => {

0 commit comments

Comments
 (0)