Skip to content

feat(datepicker): @Output for year and month selected in multiyear/year #9678

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.

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 11 commits into from
Feb 6, 2018
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

35 changes: 33 additions & 2 deletions src/demo-app/datepicker/datepicker-demo.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h2>Input disabled datepicker</h2>
[matDatepickerFilter]="filterOdd ? dateFilter : null" disabled
placeholder="Input disabled">
<mat-datepicker #datePicker1 [touchUi]="touch" [startAt]="startAt"
[startView]="yearView ? 'year' : 'month'"></mat-datepicker>
[startView]="yearView ? 'year' : 'month'"></mat-datepicker>
</mat-form-field>
</p>

Expand Down Expand Up @@ -118,7 +118,7 @@ <h2>Input disabled, datepicker popup enabled</h2>
[max]="maxDate" [matDatepickerFilter]="filterOdd ? dateFilter : null"
placeholder="Input disabled, datepicker enabled">
<mat-datepicker #datePicker3 [touchUi]="touch" [disabled]="false" [startAt]="startAt"
[startView]="yearView ? 'year' : 'month'"></mat-datepicker>
[startView]="yearView ? 'year' : 'month'"></mat-datepicker>
</mat-form-field>
</p>

Expand All @@ -133,3 +133,34 @@ <h2>Datepicker with value property binding</h2>
[startView]="yearView ? 'year' : 'month'"></mat-datepicker>
</mat-form-field>
</p>

<h2>Datepicker emulating year picker</h2>
<div demo-moment-year>
<mat-form-field>
<input matInput [matDatepicker]="datePicker5" placeholder="Choose an year"
[formControl]="yearDateControl">
<mat-datepicker-toggle matSuffix [for]="datePicker5"></mat-datepicker-toggle>
<mat-datepicker
#datePicker5
[touchUi]="true"
startView="multi-year"
(yearSelected)="chosenYearHandler($event, datePicker5)">
</mat-datepicker>
</mat-form-field>
</div>

<h2>Datepicker emulating month/year picker</h2>
<div demo-moment-month-year>
<mat-form-field>
<input matInput [matDatepicker]="datePicker6" placeholder="Choose a date (year and month)"
[formControl]="monthYearDateControl">
<mat-datepicker-toggle matSuffix [for]="datePicker6"></mat-datepicker-toggle>
<mat-datepicker
#datePicker6
[touchUi]="true"
startView="multi-year"
(yearSelected)="chosenYearFromYearMonthHandler($event)"
(monthSelected)="chosenMonthFromYearMonthHandler($event, datePicker6)">
</mat-datepicker>
</mat-form-field>
</div>
1 change: 1 addition & 0 deletions src/demo-app/datepicker/datepicker-demo.scss
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
mat-calendar {
width: 300px;
}

76 changes: 73 additions & 3 deletions src/demo-app/datepicker/datepicker-demo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,15 @@
* found in the LICENSE file at https://angular.io/license
*/

import {ChangeDetectionStrategy, Component} from '@angular/core';
import {ChangeDetectionStrategy, Component, Directive} from '@angular/core';
import {FormControl} from '@angular/forms';
import {MatDatepickerInputEvent} from '@angular/material/datepicker';
import {MatDatepicker, MatDatepickerInputEvent} from '@angular/material';
import {MomentDateAdapter} from '@angular/material-moment-adapter';
import {DateAdapter, MAT_DATE_FORMATS, MAT_DATE_LOCALE} from '@angular/material/core';

import * as _moment from 'moment';
import {default as _rollupMoment, Moment} from 'moment';
const moment = _rollupMoment || _moment;

@Component({
moduleId: module.id,
Expand All @@ -31,11 +36,76 @@ export class DatepickerDemo {
lastDateInput: Date | null;
lastDateChange: Date | null;

monthYearDateControl = new FormControl(moment([2017, 10, 25]));
yearDateControl = new FormControl(moment([2017, 10, 25]));

dateCtrl = new FormControl();

dateFilter =
(date: Date) => !(date.getFullYear() % 2) && (date.getMonth() % 2) && !(date.getDate() % 2)

onDateInput = (e: MatDatepickerInputEvent<Date>) => this.lastDateInput = e.value;
onDateChange = (e: MatDatepickerInputEvent<Date>) => this.lastDateChange = e.value;

dateCtrl = new FormControl();
chosenYearHandler(year: number, datepicker: MatDatepicker<Moment>) {
const actualDate = this.yearDateControl.value;
actualDate.year(year);
this.yearDateControl.setValue(actualDate);
datepicker.close();
}

chosenYearFromYearMonthHandler(year: number) {
const actualDate = this.monthYearDateControl.value;
actualDate.year(year);
this.monthYearDateControl.setValue(actualDate);
}

chosenMonthFromYearMonthHandler(month: number, datepicker: MatDatepicker<Moment>) {
const actualDate = this.monthYearDateControl.value;
actualDate.month(month);
this.monthYearDateControl.setValue(actualDate);
datepicker.close();
}
}

export const DEMO_MOMENT_MONTH_YEAR_FORMATS = {
parse: {
dateInput: 'MM/YYYY',
},
display: {
dateInput: 'MM/YYYY',
monthYearLabel: 'MMM YYYY',
dateA11yLabel: 'LL',
monthYearA11yLabel: 'MMMM YYYY',
},
};

@Directive({
selector: '[demo-moment-month-year]',
providers: [
{provide: DateAdapter, useClass: MomentDateAdapter, deps: [MAT_DATE_LOCALE]},
{provide: MAT_DATE_FORMATS, useValue: DEMO_MOMENT_MONTH_YEAR_FORMATS},
]
})
export class DemoMomentMonthYearDirective { }

export const DEMO_MOMENT_YEAR_FORMATS = {
parse: {
dateInput: 'YYYY',
},
display: {
dateInput: 'YYYY',
monthYearLabel: 'MMM YYYY',
dateA11yLabel: 'LL',
monthYearA11yLabel: 'MMMM YYYY',
},
};

@Directive({
selector: '[demo-moment-year]',
providers: [
{provide: DateAdapter, useClass: MomentDateAdapter, deps: [MAT_DATE_LOCALE]},
{provide: MAT_DATE_FORMATS, useValue: DEMO_MOMENT_YEAR_FORMATS},
]
})
export class DemoMomentYearDirective { }
2 changes: 1 addition & 1 deletion src/demo-app/demo-app-module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import {AccessibilityDemoModule} from './a11y/a11y-module';
],
entryComponents: [
EntryApp,
],
]
})
export class DemoAppModule {
constructor(private _appRef: ApplicationRef) { }
Expand Down
8 changes: 7 additions & 1 deletion src/demo-app/demo-app/demo-module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ import {ButtonDemo} from '../button/button-demo';
import {CardDemo} from '../card/card-demo';
import {CheckboxDemo, MatCheckboxDemoNestedChecklist} from '../checkbox/checkbox-demo';
import {ChipsDemo} from '../chips/chips-demo';
import {DatepickerDemo} from '../datepicker/datepicker-demo';
import {
DatepickerDemo,
DemoMomentMonthYearDirective,
DemoMomentYearDirective
} from '../datepicker/datepicker-demo';
import {DemoMaterialModule} from '../demo-material-module';
import {ContentElementDialog, DialogDemo, IFrameDialog, JazzDialog} from '../dialog/dialog-demo';
import {DrawerDemo} from '../drawer/drawer-demo';
Expand Down Expand Up @@ -79,6 +83,8 @@ import {TableDemoModule} from '../table/table-demo-module';
ChipsDemo,
ContentElementDialog,
DatepickerDemo,
DemoMomentMonthYearDirective,
DemoMomentYearDirective,
DemoApp,
DialogDemo,
DrawerDemo,
Expand Down
2 changes: 2 additions & 0 deletions src/demo-app/demo-material-module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ import {OverlayModule} from '@angular/cdk/overlay';
import {PlatformModule} from '@angular/cdk/platform';
import {ObserversModule} from '@angular/cdk/observers';
import {PortalModule} from '@angular/cdk/portal';
import {MatMomentDateModule} from '@angular/material-moment-adapter';

/**
* NgModule that includes all Material modules that are required to serve the demo-app.
Expand Down Expand Up @@ -88,6 +89,7 @@ import {PortalModule} from '@angular/cdk/portal';
MatToolbarModule,
MatTooltipModule,
MatNativeDateModule,
MatMomentDateModule,
CdkTableModule,
A11yModule,
BidiModule,
Expand Down
2 changes: 2 additions & 0 deletions src/lib/datepicker/calendar.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
[activeDate]="_activeDate"
[selected]="selected"
[dateFilter]="_dateFilterForViews"
(monthSelected)="_monthSelectedInYearView($event)"
(selectedChange)="_goToDateInView($event, 'month')">
</mat-year-view>

Expand All @@ -44,6 +45,7 @@
[activeDate]="_activeDate"
[selected]="selected"
[dateFilter]="_dateFilterForViews"
(yearSelected)="_yearSelectedInMultiYearView($event)"
(selectedChange)="_goToDateInView($event, 'year')">
</mat-multi-year-view>
</div>
42 changes: 41 additions & 1 deletion src/lib/datepicker/calendar.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,38 @@ describe('MatCalendar', () => {
expect(testComponent.selected).toEqual(new Date(2017, JAN, 31));
});

it('should emit the selected month on cell clicked in year view', () => {
periodButton.click();
fixture.detectChanges();

expect(calendarInstance._currentView).toBe('multi-year');
expect(calendarInstance._activeDate).toEqual(new Date(2017, JAN, 31));

(calendarElement.querySelector('.mat-calendar-body-active') as HTMLElement).click();

fixture.detectChanges();

expect(calendarInstance._currentView).toBe('year');

(calendarElement.querySelector('.mat-calendar-body-active') as HTMLElement).click();

expect(fixture.componentInstance.selectedMonth).toEqual(0);
});

it('should emit the selected year on cell clicked in multiyear view', () => {
periodButton.click();
fixture.detectChanges();

expect(calendarInstance._currentView).toBe('multi-year');
expect(calendarInstance._activeDate).toEqual(new Date(2017, JAN, 31));

(calendarElement.querySelector('.mat-calendar-body-active') as HTMLElement).click();

fixture.detectChanges();

expect(fixture.componentInstance.selectedYear).toEqual(2017);
});

it('should re-render when the i18n labels have changed',
inject([MatDatepickerIntl], (intl: MatDatepickerIntl) => {
const button = fixture.debugElement.nativeElement
Expand Down Expand Up @@ -916,10 +948,18 @@ describe('MatCalendar', () => {


@Component({
template: `<mat-calendar [startAt]="startDate" [(selected)]="selected"></mat-calendar>`
template: `
<mat-calendar
[startAt]="startDate"
[(selected)]="selected"
(yearSelected)="selectedYear=$event"
(monthSelected)="selectedMonth=$event">
</mat-calendar>`
})
class StandardCalendar {
selected: Date;
selectedYear: number;
selectedMonth: number;
startDate = new Date(2017, JAN, 31);
}

Expand Down
22 changes: 22 additions & 0 deletions src/lib/datepicker/calendar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,18 @@ export class MatCalendar<D> implements AfterContentInit, OnDestroy, OnChanges {
/** Emits when the currently selected date changes. */
@Output() readonly selectedChange: EventEmitter<D> = new EventEmitter<D>();

/**
* Emits the year chosen in multiyear view.
* This doesn't imply a change on the selected date.
*/
@Output() readonly yearSelected: EventEmitter<number> = new EventEmitter<number>();

/**
* Emits the month chosen in year view.
* This doesn't imply a change on the selected date.
*/
@Output() readonly monthSelected: EventEmitter<number> = new EventEmitter<number>();

/** Emits when any date is selected. */
@Output() readonly _userSelection: EventEmitter<void> = new EventEmitter<void>();

Expand Down Expand Up @@ -228,6 +240,16 @@ export class MatCalendar<D> implements AfterContentInit, OnDestroy, OnChanges {
}
}

/** Handles year selection in the multiyear view. */
_yearSelectedInMultiYearView(year: number) {
this.yearSelected.emit(year);
}

/** Handles month selection in the year view. */
_monthSelectedInYearView(month: number) {
this.monthSelected.emit(month);
}

_userSelected(): void {
this._userSelection.emit();
}
Expand Down
2 changes: 2 additions & 0 deletions src/lib/datepicker/datepicker-content.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@
[dateFilter]="datepicker._dateFilter"
[selected]="datepicker._selected"
(selectedChange)="datepicker._select($event)"
(yearSelected)="datepicker._selectYear($event)"
(monthSelected)="datepicker._selectMonth($event)"
(_userSelection)="datepicker.close()">
</mat-calendar>
17 changes: 17 additions & 0 deletions src/lib/datepicker/datepicker.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,23 @@ year containing the `startAt` date.

<!-- example(datepicker-start-view) -->

#### Watching the views for changes on selected years and months

When a year or a month is selected in **multi-year and year views** respecively, the `yearSelected`
Copy link
Contributor

Choose a reason for hiding this comment

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

...in the multi-year and year views...

and `monthSelected` outputs emit the chosen year (full year) and month (0 - 11).
Copy link
Contributor

Choose a reason for hiding this comment

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

now that I think about this some more, wouldn't it make sense to emit normalized dates
(e.g. new Date(year, 0, 1) and new Date(year, month, 1))? especially for the month case, the month number alone doesn't give you all the info you need

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok, I'm gonna update this and push it tonight.


Notice that the emitted value does not affect the current value in the connected `<input>`, which
is only bound to the selection made in the `month` view. So if the end user closes the calendar
after choosing a year in `multi-view` mode (by pressing the `ESC` key, for example) , the selected
year, emitted by `yearSelected` output, will not reflect any change in the value of the date in the
associated `<input>`.

The following example uses `yearSelected` and `monthSelected` outputs to emulate a month and year
picker (if you're not familiar with the usage of `MomentDateAdapter` and `formats customization`
Copy link
Contributor

Choose a reason for hiding this comment

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

formats customization ---> MAT_DATE_FORMATS

you can read more about them below in this document to fully understand the example).
Copy link
Contributor

Choose a reason for hiding this comment

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

link the words "read more about them" to the correct header in this document.


<!-- example(datepicker-views-selection) -->

### Setting the selected date

The type of values that the datepicker expects depends on the type of `DateAdapter` provided in your
Expand Down
Loading