Skip to content

fix(datepicker): make date range aria-live and fix active date logic #11144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 7, 2018
Merged

fix(datepicker): make date range aria-live and fix active date logic #11144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
197ba5e
fix(datepicker): make date range aria-live and fix active date logic
mmalerba May 3, 2018
432c662
switch to cdkAriaLive
mmalerba May 24, 2018
5884f40
fix tests
mmalerba Jun 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/lib/datepicker/calendar-header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
<div class="mat-calendar-header">
<div class="mat-calendar-controls">
<button mat-button type="button" class="mat-calendar-period-button"
(click)="currentPeriodClicked()" [attr.aria-label]="periodButtonLabel">
(click)="currentPeriodClicked()" [attr.aria-label]="periodButtonLabel"
cdkAriaLive="polite">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noticed this now, but we should make cdkAriaLive default to polite in a separate PR

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

created #11618 so we don't forget

{{periodButtonText}}
<div class="mat-calendar-arrow" [class.mat-calendar-invert]="calendar.currentView != 'month'"></div>
<div class="mat-calendar-arrow"
[class.mat-calendar-invert]="calendar.currentView != 'month'"></div>
</button>

<div class="mat-calendar-spacer"></div>
Expand Down
4 changes: 2 additions & 2 deletions src/lib/datepicker/calendar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

<mat-year-view
*ngSwitchCase="'year'"
[activeDate]="activeDate"
[(activeDate)]="activeDate"
[selected]="selected"
[dateFilter]="dateFilter"
[maxDate]="maxDate"
Expand All @@ -26,7 +26,7 @@

<mat-multi-year-view
*ngSwitchCase="'multi-year'"
[activeDate]="activeDate"
[(activeDate)]="activeDate"
[selected]="selected"
[dateFilter]="dateFilter"
[maxDate]="maxDate"
Expand Down
2 changes: 1 addition & 1 deletion src/lib/datepicker/month-view.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,8 @@ export class MatMonthView<D> implements AfterContentInit {
// navigation should skip over disabled dates, and if so, how to implement that efficiently.

const oldActiveDate = this._activeDate;

const isRtl = this._isRtl();

switch (event.keyCode) {
case LEFT_ARROW:
this.activeDate = this._dateAdapter.addCalendarDays(this._activeDate, isRtl ? 1 : -1);
Expand Down
34 changes: 17 additions & 17 deletions src/lib/datepicker/multi-year-view.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,103 +118,103 @@ describe('MatMultiYearView', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', LEFT_ARROW);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate).toEqual(new Date(2016, JAN, 1));
expect(calendarInstance.date).toEqual(new Date(2016, JAN, 1));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', LEFT_ARROW);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate).toEqual(new Date(2015, JAN, 1));
expect(calendarInstance.date).toEqual(new Date(2015, JAN, 1));
});

it('should increment year on right arrow press', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', RIGHT_ARROW);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate).toEqual(new Date(2018, JAN, 1));
expect(calendarInstance.date).toEqual(new Date(2018, JAN, 1));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', RIGHT_ARROW);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate).toEqual(new Date(2019, JAN, 1));
expect(calendarInstance.date).toEqual(new Date(2019, JAN, 1));
});

it('should go up a row on up arrow press', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', UP_ARROW);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate)
expect(calendarInstance.date)
.toEqual(new Date(2017 - yearsPerRow, JAN, 1));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', UP_ARROW);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate)
expect(calendarInstance.date)
.toEqual(new Date(2017 - yearsPerRow * 2, JAN, 1));
});

it('should go down a row on down arrow press', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', DOWN_ARROW);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate)
expect(calendarInstance.date)
.toEqual(new Date(2017 + yearsPerRow, JAN, 1));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', DOWN_ARROW);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate)
expect(calendarInstance.date)
.toEqual(new Date(2017 + yearsPerRow * 2, JAN, 1));
});

it('should go to first year in current range on home press', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', HOME);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate).toEqual(new Date(2016, JAN, 1));
expect(calendarInstance.date).toEqual(new Date(2016, JAN, 1));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', HOME);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate).toEqual(new Date(2016, JAN, 1));
expect(calendarInstance.date).toEqual(new Date(2016, JAN, 1));
});

it('should go to last year in current range on end press', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', END);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate).toEqual(new Date(2039, JAN, 1));
expect(calendarInstance.date).toEqual(new Date(2039, JAN, 1));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', END);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate).toEqual(new Date(2039, JAN, 1));
expect(calendarInstance.date).toEqual(new Date(2039, JAN, 1));
});

it('should go to same index in previous year range page up press', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', PAGE_UP);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate)
expect(calendarInstance.date)
.toEqual(new Date(2017 - yearsPerPage, JAN, 1));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', PAGE_UP);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate)
expect(calendarInstance.date)
.toEqual(new Date(2017 - yearsPerPage * 2, JAN, 1));
});

it('should go to same index in next year range on page down press', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', PAGE_DOWN);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate)
expect(calendarInstance.date)
.toEqual(new Date(2017 + yearsPerPage, JAN, 1));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', PAGE_DOWN);
fixture.detectChanges();

expect(calendarInstance.multiYearView.activeDate)
expect(calendarInstance.date)
.toEqual(new Date(2017 + yearsPerPage * 2, JAN, 1));
});

Expand Down Expand Up @@ -246,7 +246,7 @@ describe('MatMultiYearView', () => {

@Component({
template: `
<mat-multi-year-view [activeDate]="date" [(selected)]="selected"
<mat-multi-year-view [(activeDate)]="date" [(selected)]="selected"
(yearSelected)="selectedYear=$event"></mat-multi-year-view>`
})
class StandardMultiYearView {
Expand Down
8 changes: 8 additions & 0 deletions src/lib/datepicker/multi-year-view.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ export class MatMultiYearView<D> implements AfterContentInit {
/** Emits the selected year. This doesn't imply a change on the selected date */
@Output() readonly yearSelected: EventEmitter<D> = new EventEmitter<D>();

/** Emits when any date is activated. */
@Output() readonly activeDateChange: EventEmitter<D> = new EventEmitter<D>();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add unit test for these new outputs?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the tests to work the same way as month-view tests, which test the @Output()


/** The body of calendar table */
@ViewChild(MatCalendarBody) _matCalendarBody: MatCalendarBody;

Expand Down Expand Up @@ -159,6 +162,7 @@ export class MatMultiYearView<D> implements AfterContentInit {
// disabled ones from being selected. This may not be ideal, we should look into whether
// navigation should skip over disabled dates, and if so, how to implement that efficiently.

const oldActiveDate = this._activeDate;
const isRtl = this._isRtl();

switch (event.keyCode) {
Expand Down Expand Up @@ -200,6 +204,10 @@ export class MatMultiYearView<D> implements AfterContentInit {
return;
}

if (this._dateAdapter.compareDate(oldActiveDate, this.activeDate)) {
this.activeDateChange.emit(this.activeDate);
}

this._focusActiveCell();
// Prevent unexpected default actions such as form submission.
event.preventDefault();
Expand Down
62 changes: 31 additions & 31 deletions src/lib/datepicker/year-view.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,12 +147,12 @@ describe('MatYearView', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', LEFT_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2016, DEC, 5));
expect(calendarInstance.date).toEqual(new Date(2016, DEC, 5));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', LEFT_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2016, NOV, 5));
expect(calendarInstance.date).toEqual(new Date(2016, NOV, 5));
});

it('should increment month on left arrow press in rtl', () => {
Expand All @@ -161,24 +161,24 @@ describe('MatYearView', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', LEFT_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, FEB, 5));
expect(calendarInstance.date).toEqual(new Date(2017, FEB, 5));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', LEFT_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, MAR, 5));
expect(calendarInstance.date).toEqual(new Date(2017, MAR, 5));
});

it('should increment month on right arrow press', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', RIGHT_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, FEB, 5));
expect(calendarInstance.date).toEqual(new Date(2017, FEB, 5));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', RIGHT_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, MAR, 5));
expect(calendarInstance.date).toEqual(new Date(2017, MAR, 5));
});

it('should decrement month on right arrow press in rtl', () => {
Expand All @@ -187,118 +187,118 @@ describe('MatYearView', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', RIGHT_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2016, DEC, 5));
expect(calendarInstance.date).toEqual(new Date(2016, DEC, 5));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', RIGHT_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2016, NOV, 5));
expect(calendarInstance.date).toEqual(new Date(2016, NOV, 5));
});

it('should go up a row on up arrow press', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', UP_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2016, SEP, 5));
expect(calendarInstance.date).toEqual(new Date(2016, SEP, 5));

calendarInstance.yearView.activeDate = new Date(2017, JUL, 1);
calendarInstance.date = new Date(2017, JUL, 1);
fixture.detectChanges();

dispatchKeyboardEvent(calendarBodyEl, 'keydown', UP_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, MAR, 1));
expect(calendarInstance.date).toEqual(new Date(2017, MAR, 1));

calendarInstance.yearView.activeDate = new Date(2017, DEC, 10);
calendarInstance.date = new Date(2017, DEC, 10);
fixture.detectChanges();

dispatchKeyboardEvent(calendarBodyEl, 'keydown', UP_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, AUG, 10));
expect(calendarInstance.date).toEqual(new Date(2017, AUG, 10));
});

it('should go down a row on down arrow press', () => {
dispatchKeyboardEvent(calendarBodyEl, 'keydown', DOWN_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, MAY, 5));
expect(calendarInstance.date).toEqual(new Date(2017, MAY, 5));

calendarInstance.yearView.activeDate = new Date(2017, JUN, 1);
calendarInstance.date = new Date(2017, JUN, 1);
fixture.detectChanges();

dispatchKeyboardEvent(calendarBodyEl, 'keydown', DOWN_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, OCT, 1));
expect(calendarInstance.date).toEqual(new Date(2017, OCT, 1));

calendarInstance.yearView.activeDate = new Date(2017, SEP, 30);
calendarInstance.date = new Date(2017, SEP, 30);
fixture.detectChanges();

dispatchKeyboardEvent(calendarBodyEl, 'keydown', DOWN_ARROW);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2018, JAN, 30));
expect(calendarInstance.date).toEqual(new Date(2018, JAN, 30));
});

it('should go to first month of the year on home press', () => {
calendarInstance.yearView.activeDate = new Date(2017, SEP, 30);
calendarInstance.date = new Date(2017, SEP, 30);
fixture.detectChanges();

dispatchKeyboardEvent(calendarBodyEl, 'keydown', HOME);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, JAN, 30));
expect(calendarInstance.date).toEqual(new Date(2017, JAN, 30));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', HOME);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, JAN, 30));
expect(calendarInstance.date).toEqual(new Date(2017, JAN, 30));
});

it('should go to last month of the year on end press', () => {
calendarInstance.yearView.activeDate = new Date(2017, OCT, 31);
calendarInstance.date = new Date(2017, OCT, 31);
fixture.detectChanges();

dispatchKeyboardEvent(calendarBodyEl, 'keydown', END);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, DEC, 31));
expect(calendarInstance.date).toEqual(new Date(2017, DEC, 31));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', END);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, DEC, 31));
expect(calendarInstance.date).toEqual(new Date(2017, DEC, 31));
});

it('should go back one year on page up press', () => {
calendarInstance.yearView.activeDate = new Date(2016, FEB, 29);
calendarInstance.date = new Date(2016, FEB, 29);
fixture.detectChanges();

dispatchKeyboardEvent(calendarBodyEl, 'keydown', PAGE_UP);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2015, FEB, 28));
expect(calendarInstance.date).toEqual(new Date(2015, FEB, 28));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', PAGE_UP);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2014, FEB, 28));
expect(calendarInstance.date).toEqual(new Date(2014, FEB, 28));
});

it('should go forward one year on page down press', () => {
calendarInstance.yearView.activeDate = new Date(2016, FEB, 29);
calendarInstance.date = new Date(2016, FEB, 29);
fixture.detectChanges();

dispatchKeyboardEvent(calendarBodyEl, 'keydown', PAGE_DOWN);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2017, FEB, 28));
expect(calendarInstance.date).toEqual(new Date(2017, FEB, 28));

dispatchKeyboardEvent(calendarBodyEl, 'keydown', PAGE_DOWN);
fixture.detectChanges();

expect(calendarInstance.yearView.activeDate).toEqual(new Date(2018, FEB, 28));
expect(calendarInstance.date).toEqual(new Date(2018, FEB, 28));
});
});
});
Expand Down Expand Up @@ -327,7 +327,7 @@ describe('MatYearView', () => {

@Component({
template: `
<mat-year-view [activeDate]="date" [(selected)]="selected"
<mat-year-view [(activeDate)]="date" [(selected)]="selected"
(monthSelected)="selectedMonth=$event"></mat-year-view>`
})
class StandardYearView {
Expand Down
Loading