fix(datepicker): Create a new injection token to avoid overriding LOCALE_ID #6708
Conversation
googlebot
added
the
cla: yes
| @@ -334,13 +333,13 @@ describe('NativeDateAdapter', () => { | |||
| }); | |||
|
|
|||
|
|
|||
| describe('NativeDateAdapter with LOCALE_ID override', () => { | |||
| describe('NativeDateAdapter with MAT_DATE_LOCALE override', () => { | |||
There was a problem hiding this comment.
can we also have tests for LOCAL_ID override? this should still cascade to MAT_DATE_LOCALE
src/lib/core/datetime/index.ts
Outdated
| providers: [{provide: DateAdapter, useClass: NativeDateAdapter}], | ||
| providers: [ | ||
| {provide: DateAdapter, useClass: NativeDateAdapter}, | ||
| {provide: MAT_DATE_LOCALE, useExisting: LOCALE_ID} |
There was a problem hiding this comment.
I think this should go in the MdDatepickerModule
There was a problem hiding this comment.
@jelbourn can you think of a good way to avoid putting this in NativeDateModule, MomentDateModule, etc? I was thinking maybe we could put it in MdCommonModule and have this module import that?
There was a problem hiding this comment.
I think it doesn't really belong in MdCommonModule since it is only used in a few components. You could create a separate MdCommonDateModule, but that also seems like overkill. Easier thing would probably be just to make a common provider, e.g.
export const MAT_DATE_LOCALE_PROVIDER = {provide: MAT_DATE_LOCALE, useExisting: LOCALE_ID};Adding that is about the same as importing another module.
| @@ -48,13 +47,15 @@ function range<T>(length: number, valueFunction: (index: number) => T): T[] { | |||
| return valuesArray; | |||
| } | |||
|
|
|||
| /** InjectionToken for datepicker that can be used to override default locale code. */ | |||
| export const MAT_DATE_LOCALE = new InjectionToken<string>('MdDateLocale'); | |||
There was a problem hiding this comment.
I would just make the string value of the token the same as the name 'MAT_DATE_LOCALE'
|
|
||
| /** Adapts the native JS Date for use with cdk-based components that work with dates. */ | ||
| @Injectable() | ||
| export class NativeDateAdapter extends DateAdapter<Date> { | ||
| constructor(@Optional() @Inject(LOCALE_ID) localeId: any) { | ||
| constructor(@Optional() @Inject(MAT_DATE_LOCALE) matDateLocale: any) { |
|
Comments addressed. Ready for review again 👍 |
src/lib/datepicker/datepicker.md
Outdated
| By default the datepicker will use the locale code from the `LOCALE_ID` injection token from | ||
| `@angular/core`. If you want to override it, you can provide a new value for the token: | ||
|
|
||
| By default `MAT_DATE_LOCALE` injection token will use the existing `LOCALE_ID` locale code from |
There was a problem hiding this comment.
Nit: By default MAT_DATE_LOCALE injection token -> By default, the MAT_DATE_LOCALE injection token
| @@ -48,13 +47,15 @@ function range<T>(length: number, valueFunction: (index: number) => T): T[] { | |||
| return valuesArray; | |||
| } | |||
|
|
|||
| /** InjectionToken for datepicker that can be used to override default locale code. */ | |||
| export const MAT_DATE_LOCALE = new InjectionToken<string>('MAT_DATE_LOCALE'); | |||
There was a problem hiding this comment.
can we move this to DateAdapter since we expect all adapters to use it not just NativeDateAdapter?
|
Changes have been made 😃 Ready for review |
|
LGTM |
|
Added |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
New injection token
MAT_DATE_LOCALEis added to allow overriding locale code, while avoiding overridingLOCALE_ID.