docs: enable and document feature flag

adfinis · Jan 31, 2022 · c8c11da · c8c11da
1 parent cee9f2e
commit c8c11da
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 2 deletions.
diff --git a/addon/components/validated-form.js b/addon/components/validated-form.js
@@ -49,7 +49,7 @@ export default class ValidatedFormComponent extends Component {
     await model.validate();
 
     if (model.get("isInvalid")) {
-      if (this.config?.scrollErrorIntoView && model.errors[0]?.key) {
+      if (this.config?.features?.scrollErrorIntoView && model.errors[0]?.key) {
         document
           .querySelector(`[name=${model.errors[0].key}]`)
           ?.scrollIntoView();

diff --git a/tests/dummy/app/snippets/config-features.js b/tests/dummy/app/snippets/config-features.js
@@ -0,0 +1,10 @@
+var ENV = {
+  // ...
+  "ember-validated-form": {
+    theme: "bootstrap",
+    features: {
+      scrollErrorIntoView: true,
+    }
+  },
+  // ...
+};
diff --git a/tests/dummy/app/templates/docs/configuration.md b/tests/dummy/app/templates/docs/configuration.md
@@ -33,3 +33,10 @@ For instance:
   {{demo.snippet 'permanent-custom-hint-component-template.hbs' label='permanent-custom-hint.hbs'}}
 {{/docs-demo}}
 <!-- prettier-ignore-end -->
+
+## Other features
+
+If you want to scroll the first invalid field into view, you can set the
+`scrollErrorIntoView` property to `true` (default: false).
+
+{{docs-snippet name='config-features.js' title='config/environment.js'}}
diff --git a/tests/dummy/config/environment.js b/tests/dummy/config/environment.js
@@ -9,10 +9,12 @@ module.exports = function (environment) {
     historySupportMiddleware: true,
     "ember-validated-form": {
       theme: "bootstrap",
-      scrollErrorIntoView: false,
       defaults: {
         hint: "permanent-custom-hint",
       },
+      features: {
+        scrollErrorIntoView: false,
+      },
     },
     EmberENV: {
       FEATURES: {