feat(core): deprecate passing immutable attr to formly-form component (…

…#1827)
ngx-formly · Oct 9, 2019 · 61f9391 · 61f9391
1 parent 0f168f7
commit 61f9391
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -146,6 +146,24 @@ After:
 <button type="submit">Submit</button>
 ```
 
+* Passing 'immutable' attribute to 'formly-form' component is deprecated since v5.5, enable immutable mode through NgModule declaration instead.
+
+Before:
+```html
+<formly-form immutable></formly-form>
+```
+
+After:
+```ts
+@NgModule({
+  imports: [
+    FormlyModule.forRoot({
+      extras: { immutable: true }
+    }),
+  ],
+})
+```
+
 @ngx-formly/material
 --------------------
 **Note**: this only affect the user's who import sub-modules of `@ngx-formly/material` instead of main module `FormlyMaterialModule`.

diff --git a/demo/src/app/examples/introduction/app.module.ts b/demo/src/app/examples/introduction/app.module.ts
@@ -13,6 +13,7 @@ import { FormlyFieldCustomInput } from './custom-input.component';
     ReactiveFormsModule,
     FormlyBootstrapModule,
     FormlyModule.forRoot({
+      extras: { immutable: true },
       validationMessages: [
         { name: 'required', message: 'This field is required' },
       ],

diff --git a/src/core/src/lib/components/formly.form.ts b/src/core/src/lib/components/formly.form.ts
@@ -68,6 +68,10 @@ export class FormlyForm implements DoCheck, OnChanges, OnDestroy {
     @Attribute('immutable') immutable,
     @Optional() private parentFormGroup: FormGroupDirective,
   ) {
+    if (immutable !== null) {
+      console.warn(`NgxFormly: passing 'immutable' attribute to 'formly-form' component is deprecated since v5.5, enable immutable mode through NgModule declaration instead.`);
+    }
+
     this.immutable = (immutable !== null) || !!formlyConfig.extras.immutable;
   }