feat(forms): Allow a FormControl to use initial value as default. by dylhunn · Pull Request #44434 · angular/angular

dylhunn · 2021-12-10T22:02:00Z

Allow a FormControl to be reset to its initial value. Provide this feature via a new option in a FormControlOptions interface, based on AbstractControlOptions.

Also, expose the default value as part of the public API. This is part of a feature that has been requested elsewhere (e.g. in #19747).

This was originally proposed as part of typed forms. As discussed in the GDE session (and after with akushnir/alxhub), it is likely better to just reuse the initial value rather than accepting an additional default.

It is desirable to land this separately in order to reduce the scope of the typed forms PR, and make it a types-only change.

Edit: This change will also help us in a long-term shift to reduce the use of null in Forms, and adopt safer defaults.

Pertains to issue #13721.

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/master/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?

It is impossible to specify the value to which a control will reset ahead of time.

Issue Number: #13721

What is the new behavior?

It is now possible to cause a control to reset to its initial value. This will be useful for simplifying the types in strongly typed reactive forms.

Does this PR introduce a breaking change?

Yes
No

Other information

dylhunn · 2021-12-11T22:24:31Z

Presubmit is green: http://test/OCL:415607582:BASE:415607613:1639173976883:195d84c6

goldens/public-api/forms/forms.md

jessicajaniuk

LGTM 🍪

reviewed-for: public-api

packages/forms/src/model.ts

dylhunn · 2021-12-13T19:37:52Z

@alxhub I renamed the key to initialValueIsDefault as you suggested on our call, as well as exporting the defaultValue field for public usage.

packages/forms/src/model.ts

AndrewKushnir · 2021-12-14T20:45:29Z

packages/forms/src/model.ts

Great catch 👍 I didn't mention this since there is a handling for the "boxed value" in the reset function (within _applyFormState code), but it would also update the disabled status, which is something we need to avoid (so special handling makes sense here).

packages/forms/test/form_control_spec.ts

The aio application expects `FormControl` to have no properties for the purposes of its own internal tests, but this is no longer true after #44434. PR Close #44479

dylhunn · 2021-12-14T21:18:01Z

(Rebased and all comments addressed)

dylhunn · 2021-12-14T21:47:42Z

@alxhub I just did one last push with all the comments addressed!

mary-poppins · 2021-12-14T21:55:51Z

You can preview 2a1cd13 at https://pr44434-2a1cd13.ngbuilds.io/.

mary-poppins · 2021-12-14T22:06:17Z

You can preview 3ab141c at https://pr44434-3ab141c.ngbuilds.io/.

All changes are applied.

Allow a FormControl to be reset to its initial value. Provide this feature via a new option in a FormControlOptions interface, based on AbstractControlOptions. Also, expose the default value as part of the public API. This is part of a feature that has been requested elsewhere (e.g. in angular#19747). This was originally proposed as part of typed forms. As discussed in the GDE session (and after with akushnir/alxhub), it is likely better to just reuse the initial value rather than accepting an additional default. It is desirable to land this separately in order to reduce the scope of the typed forms PR, and make it a types-only change. Pertains to issue angular#13721.

mary-poppins · 2021-12-15T04:20:07Z

You can preview 831a87f at https://pr44434-831a87f.ngbuilds.io/.

alxhub · 2021-12-15T15:36:15Z

This PR was merged into the repository by commit 72092eb.

angular-automatic-lock-bot · 2022-01-15T16:05:58Z

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.}

dylhunn added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews area: forms cross-cutting: types target: minor This PR is targeted for the next minor release labels Dec 10, 2021

ngbot bot modified the milestone: Backlog Dec 10, 2021

dylhunn force-pushed the reset-to-initial branch 3 times, most recently from 276172d to 2a1062e Compare December 10, 2021 22:12

dylhunn marked this pull request as ready for review December 10, 2021 22:13

pullapprove bot requested review from AndrewKushnir, alxhub, jelbourn and jessicajaniuk December 10, 2021 22:13

dylhunn added action: review The PR is still awaiting reviews from at least one requested reviewer and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Dec 10, 2021

dylhunn force-pushed the reset-to-initial branch 3 times, most recently from a10c14e to 6f2c319 Compare December 10, 2021 22:17

JoostK reviewed Dec 11, 2021

View reviewed changes

goldens/public-api/forms/forms.md Outdated Show resolved Hide resolved

jessicajaniuk approved these changes Dec 13, 2021

View reviewed changes

dylhunn force-pushed the reset-to-initial branch from 6f2c319 to a6e6f84 Compare December 13, 2021 19:37

dylhunn changed the title ~~feat(forms): Allow a FormControl to be reset to its initial value.~~ feat(forms): Allow a FormControl to use initial value as default. Dec 13, 2021

AndrewKushnir reviewed Dec 13, 2021

View reviewed changes

packages/forms/src/model.ts Outdated Show resolved Hide resolved

packages/forms/src/model.ts Outdated Show resolved Hide resolved

pullapprove bot requested a review from AndrewKushnir December 13, 2021 19:37

dylhunn force-pushed the reset-to-initial branch from a6e6f84 to 0c70f88 Compare December 13, 2021 19:39

dylhunn force-pushed the reset-to-initial branch 2 times, most recently from df3a1e7 to 685b8af Compare December 14, 2021 20:34

This comment has been minimized.

Sign in to view

AndrewKushnir approved these changes Dec 14, 2021

View reviewed changes

dylhunn force-pushed the reset-to-initial branch 2 times, most recently from 33335fe to 6940b5e Compare December 14, 2021 21:00

dylhunn force-pushed the reset-to-initial branch from 6940b5e to 98a9335 Compare December 14, 2021 21:17

dylhunn force-pushed the reset-to-initial branch from 98a9335 to 2a1cd13 Compare December 14, 2021 21:47

dylhunn force-pushed the reset-to-initial branch from 2a1cd13 to 3ab141c Compare December 14, 2021 21:57

dylhunn added the action: merge The PR is ready for merge by the caretaker label Dec 14, 2021

angular deleted a comment from ngbot bot Dec 14, 2021

dylhunn force-pushed the reset-to-initial branch from 3ab141c to 831a87f Compare December 15, 2021 04:11

alxhub closed this in 72092eb Dec 15, 2021

angular-automatic-lock-bot bot locked and limited conversation to collaborators Jan 15, 2022

dylhunn deleted the reset-to-initial branch April 12, 2022 17:46

Conversation

dylhunn commented Dec 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

Uh oh!

dylhunn commented Dec 11, 2021

Uh oh!

Uh oh!

jessicajaniuk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dylhunn commented Dec 13, 2021

Uh oh!

This comment has been minimized.

Uh oh!

AndrewKushnir Dec 14, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dylhunn commented Dec 14, 2021

Uh oh!

dylhunn commented Dec 14, 2021

Uh oh!

mary-poppins commented Dec 14, 2021

Uh oh!

mary-poppins commented Dec 14, 2021

Uh oh!

mary-poppins commented Dec 15, 2021

Uh oh!

alxhub commented Dec 15, 2021

Uh oh!

angular-automatic-lock-bot bot commented Jan 15, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

dylhunn commented Dec 10, 2021 •

edited

Loading