feat(common): add injection token for default `DatePipe` configuration #47157

matthiasweiss · 2022-08-15T18:02:25Z

In order to globally change the default format of the Angular date pipe, a new injection token called "DATE_PIPE_DEFAULT_FORMAT" is added and used in the date pipe

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

Bugfix
Feature
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Documentation content changes
angular.io application / infrastructure changes
Other... Please describe:

What is the current behavior?

Currently the date pipe defaults to the mediumDate format and there is no way to override this behavior with an injection token. If it is not present, the behavior is identical.

What is the new behavior?

The DATE_PIPE_DEFAULT_FORMAT injection token can be used to override the default format that the Angular date pipe uses.

Does this PR introduce a breaking change?

Yes
No

Other information

Since there exist no tests for the DATE_PIPE_DEFAULT_TIMEZONE injection token, which behaves alomst identically to the DATE_PIPE_DEFAULT_FORMAT, there are also no tests for DATE_PIPE_DEFAULT_FORMAT.

AndrewKushnir

@matthiasweiss thanks for the PR. It looks like this feature was requested in #39194, but the ticket was closed with the proposal to add a custom pipe based on DatePipe.

However, since we've added the DATE_PIPE_DEFAULT_TIMEZONE later in #43611, I think adding a token to configure date format makes sense and makes the DatePipe API more consistent.

We'll discuss it further with the team and I'll post an update.

Since there exist no tests for the DATE_PIPE_DEFAULT_TIMEZONE injection token, which behaves alomst identically to the DATE_PIPE_DEFAULT_FORMAT, there are also no tests for DATE_PIPE_DEFAULT_FORMAT.

PR #43611 (where the DATE_PIPE_DEFAULT_TIMEZONE was implemented) has some relevant tests. Could you please add similar ones? I think it'd be also great to have a test where a component is created via TestBed and uses DatePipe in a template, so that the DATE_PIPE_DEFAULT_FORMAT token behavior is tested additionally.

matthiasweiss · 2022-09-05T15:12:07Z

@AndrewKushnir thanks for the note on the existing tests, I just globally searched for the token and there was nothing there so I thought there are none, my bad. I'll try to add tests sometime this week, should not take too long anyway!

packages/common/src/pipes/date_pipe.ts

AndrewKushnir

@matthiasweiss thanks for additional updates, I've left a few more comments. Thank you.

packages/common/src/pipes/date_pipe.ts

packages/common/src/pipes/date_pipe_config.ts

packages/common/src/pipes/index.ts

packages/common/src/pipes/date_pipe.ts

mary-poppins · 2022-10-03T19:11:50Z

You can preview f60fa78 at https://pr47157-f60fa78.ngbuilds.io/.

AndrewKushnir

@matthiasweiss thanks again for all the changes 👍

I've just left a minor comment, but overall the change looks good.

The next steps for this change:

could you please address that small comment?
we'll need a couple more approvals from the public-api group (there might be additional feedback/comments)
we'll run the necessary tests in Google's codebase and let you know the result

Thank you.

packages/common/src/pipes/date_pipe.ts

This commit introduces a new `DATE_PIPE_DEFAULT_OPTIONS` token, which can be used to configure default DatePipe options, such as date format and timezone. DEPRECATED: The `DATE_PIPE_DEFAULT_TIMEZONE` token is now deprecated in favor of the `DATE_PIPE_DEFAULT_OPTIONS` token, which accepts an object as a value and the timezone can be defined as a field (called `timezone`) on that object.

matthiasweiss · 2022-10-04T04:57:11Z

@AndrewKushnir should be ready now! Looking forward to the feedback

mary-poppins · 2022-10-04T05:01:33Z

You can preview 9269a54 at https://pr47157-9269a54.ngbuilds.io/.

pkozlowski-opensource

LGTM

Reviewed-for: public-api
Reviewed-for: fw-common

jessicajaniuk

reviewed-for: public-api, size-tracking

jessicajaniuk · 2022-10-07T16:16:02Z

This PR was merged into the repository by commit bdb5371.

AndrewKushnir · 2022-10-08T18:32:59Z

@matthiasweiss thanks again for all your help with this feature 👍

The PR was merged and this feature will be available to all Angular users as a part of upcoming v15 release 🎉

Thanks for contributing to Angular!

AndrewKushnir · 2022-10-26T18:40:37Z

@matthiasweiss thanks again for contributing this feature to Angular 👍

We want to mention this feature and yourself as an author in an upcoming blog post (about v15 release). Please let us know if that's ok or you'd prefer not to be mentioned in the blog post.

// cc @mgechev

matthiasweiss · 2022-11-17T07:16:20Z

@AndrewKushnir @mgechev Unfortunately I did not see your comment in time 😢 (a co-worker just showed me now)

If there is a chance that the blog post could be updated, then I'd love to be mentioned!

angular-automatic-lock-bot · 2022-12-18T16:07:26Z

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

_{This action has been performed automatically by a bot.}

pullapprove bot requested review from alxhub and AndrewKushnir August 15, 2022 18:02

jessicajaniuk added the area: common Issues related to APIs in the @angular/common package label Aug 15, 2022

ngbot bot added this to the Backlog milestone Aug 15, 2022

jessicajaniuk added action: review The PR is still awaiting reviews from at least one requested reviewer target: minor This PR is targeted for the next minor release labels Aug 15, 2022

matthiasweiss force-pushed the add_default_format_date_pipe branch 3 times, most recently from 7a63913 to 7342bc8 Compare August 15, 2022 18:34

AndrewKushnir reviewed Aug 30, 2022

View reviewed changes

matthiasweiss force-pushed the add_default_format_date_pipe branch 2 times, most recently from 8e6740d to e6fe1ae Compare September 5, 2022 15:53

matthiasweiss requested review from AndrewKushnir and removed request for alxhub September 5, 2022 15:55

matthiasweiss force-pushed the add_default_format_date_pipe branch from e6fe1ae to d3c8803 Compare September 10, 2022 12:22

AndrewKushnir reviewed Sep 12, 2022

View reviewed changes

packages/common/src/pipes/date_pipe.ts Outdated Show resolved Hide resolved

matthiasweiss force-pushed the add_default_format_date_pipe branch 10 times, most recently from 01bfd02 to 09fb9a7 Compare September 15, 2022 14:03

AndrewKushnir mentioned this pull request Sep 19, 2022

feat(common): add <link> preload tag on server for priority img #47343

Closed

14 tasks

AndrewKushnir reviewed Sep 19, 2022

View reviewed changes

matthiasweiss force-pushed the add_default_format_date_pipe branch from 09fb9a7 to 90ef52d Compare September 20, 2022 18:12

matthiasweiss force-pushed the add_default_format_date_pipe branch from 53679b0 to f60fa78 Compare October 3, 2022 19:02

AndrewKushnir approved these changes Oct 4, 2022

View reviewed changes

packages/common/src/pipes/date_pipe.ts Outdated Show resolved Hide resolved

pullapprove bot requested review from alxhub, AndrewKushnir and pkozlowski-opensource October 4, 2022 00:46

matthiasweiss force-pushed the add_default_format_date_pipe branch from f60fa78 to 9269a54 Compare October 4, 2022 04:51

pkozlowski-opensource approved these changes Oct 6, 2022

View reviewed changes

pullapprove bot requested a review from atscott October 6, 2022 07:56

jessicajaniuk approved these changes Oct 7, 2022

View reviewed changes

pullapprove bot removed the request for review from atscott October 7, 2022 16:13

jessicajaniuk removed request for alxhub and AndrewKushnir October 7, 2022 16:13

jessicajaniuk added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Oct 7, 2022

pullapprove bot requested review from alxhub and pkozlowski-opensource October 7, 2022 16:14

jessicajaniuk removed request for alxhub and pkozlowski-opensource October 7, 2022 16:14

jessicajaniuk closed this in bdb5371 Oct 7, 2022

misha98857 mentioned this pull request Nov 19, 2022

Ability to customize the default format for DatePipe #44456

Closed

angular-automatic-lock-bot bot locked and limited conversation to collaborators Dec 18, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(common): add injection token for default `DatePipe` configuration #47157

feat(common): add injection token for default `DatePipe` configuration #47157

matthiasweiss commented Aug 15, 2022 •

edited

AndrewKushnir left a comment

matthiasweiss commented Sep 5, 2022

AndrewKushnir left a comment

mary-poppins commented Oct 3, 2022

AndrewKushnir left a comment

matthiasweiss commented Oct 4, 2022

mary-poppins commented Oct 4, 2022

pkozlowski-opensource left a comment

jessicajaniuk left a comment •

edited

jessicajaniuk commented Oct 7, 2022

AndrewKushnir commented Oct 8, 2022

AndrewKushnir commented Oct 26, 2022

matthiasweiss commented Nov 17, 2022

angular-automatic-lock-bot bot commented Dec 18, 2022

feat(common): add injection token for default DatePipe configuration #47157

feat(common): add injection token for default DatePipe configuration #47157

Conversation

matthiasweiss commented Aug 15, 2022 • edited

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

AndrewKushnir left a comment

Choose a reason for hiding this comment

matthiasweiss commented Sep 5, 2022

AndrewKushnir left a comment

Choose a reason for hiding this comment

mary-poppins commented Oct 3, 2022

AndrewKushnir left a comment

Choose a reason for hiding this comment

matthiasweiss commented Oct 4, 2022

mary-poppins commented Oct 4, 2022

pkozlowski-opensource left a comment

Choose a reason for hiding this comment

jessicajaniuk left a comment • edited

Choose a reason for hiding this comment

jessicajaniuk commented Oct 7, 2022

AndrewKushnir commented Oct 8, 2022

AndrewKushnir commented Oct 26, 2022

matthiasweiss commented Nov 17, 2022

angular-automatic-lock-bot bot commented Dec 18, 2022

feat(common): add injection token for default `DatePipe` configuration #47157

feat(common): add injection token for default `DatePipe` configuration #47157

matthiasweiss commented Aug 15, 2022 •

edited

jessicajaniuk left a comment •

edited