angular-cn/tools/public_api_guard
Kara Erickson 8fb34bcd43 refactor(forms): deprecate ngModel usage on same field as formControl (#22633)
Support for using the `ngModel` input property and `ngModelChange`
event with reactive form directives has been deprecated in
Angular v6 and will be removed in Angular v7.

Now deprecated:
```html
<input [formControl]="control" [(ngModel)]="value">
```

```ts
this.value = 'some value';
```

This has been deprecated for a few reasons. First, developers have
found this pattern confusing. It seems like the actual `ngModel`
directive is being used, but in fact it's an input/output property
named `ngModel` on the reactive form directive that simply approximates
(some of) its behavior. Specifically, it allows getting/setting the
value and intercepting value events. However, some of `ngModel`'s other
features - like delaying updates with`ngModelOptions` or exporting the
directive - simply don't work, which has understandably caused some
confusion.

In addition, this pattern mixes template-driven and reactive forms
strategies, which we generally don't recommend because it doesn't take
advantage of the full benefits of either strategy. Setting the value in
the template violates the template-agnostic principles behind reactive
forms, whereas adding a FormControl/FormGroup layer in the class removes
the convenience of defining forms in the template.

To update your code before v7, you'll want to decide whether to stick
with reactive form directives (and get/set values using reactive forms
patterns) or switch over to template-driven directives.

After (choice 1 - use reactive forms):

```html
<input [formControl]="control">
```

```ts
this.control.setValue('some value');
```

After (choice 2 - use template-driven forms):

```html
<input [(ngModel)]="value">
```

```ts
this.value = 'some value';
```

You can also choose to silence this warning by providing a config for
`ReactiveFormsModule` at import time:

```ts
imports: [
  ReactiveFormsModule.withConfig({warnOnNgModelWithFormControl: 'never'});
]
```

Alternatively, you can choose to surface a separate warning for each
instance of this pattern with a config value of `"always"`. This may
help to track down where in the code the pattern is being used as the
code is being updated.

Note: `warnOnNgModelWithFormControl` is set up as deprecated so that it
can be removed in v7 when it is no longer needed. This will not display
properly in API docs yet because dgeni doesn't yet support deprecating
properties in object literals, but we have an open issue to resolve the
discrepancy here: https://github.com/angular/angular/issues/22640.

PR Close #22633
2018-03-07 20:47:53 -08:00
..
animations fix(animations): only use the WA-polyfill alongside AnimationBuilder (#22143) 2018-02-22 16:07:53 -08:00
common feat(common): export functions to format numbers, percents, currencies & dates (#22423) 2018-02-23 15:27:10 -08:00
compiler build: update public api file names (#19190) 2017-09-19 16:59:18 -07:00
core fix(core): export inject() from @angular/core (#22389) 2018-02-28 10:44:37 -08:00
forms refactor(forms): deprecate ngModel usage on same field as formControl (#22633) 2018-03-07 20:47:53 -08:00
http build: update public api file names (#19190) 2017-09-19 16:59:18 -07:00
platform-browser build: update api golden files (#22402) 2018-02-28 09:29:29 -08:00
platform-browser-dynamic feat(platform-browser-dynamic): export `JitCompilerFactory` (#20478) 2017-11-22 08:56:11 -06:00
platform-server feat(platform-server): add an API to transfer state from server (#19134) 2017-09-21 13:56:13 -07:00
platform-webworker fix: Update test code to type-check under TS 2.5 (#20175) 2017-11-15 18:12:16 -06:00
platform-webworker-dynamic build: update public api file names (#19190) 2017-09-19 16:59:18 -07:00
router feat(router): add navigationSource and restoredState to NavigationStart event (#21728) 2018-01-29 10:22:59 -08:00
service-worker fix(service-worker): don't crash if SW not supported 2017-12-01 14:18:16 -08:00
upgrade fix(upgrade): replaces get/setAngularLib with get/setAngularJSGlobal 2017-12-18 12:10:01 -08:00
BUILD.bazel test: include router in public_api_guard tests (#22628) 2018-03-07 10:56:27 -08:00