Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: scroll first invalid element into view #733

Merged
merged 3 commits into from
Feb 3, 2022
Merged

feat: scroll first invalid element into view #733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
171fdad
feat: scroll first invalid element into view
derrabauke Jan 27, 2022
52bc19f
fix: hide this feature behind a config flag
derrabauke Jan 31, 2022
87ec3a2
docs: enable and document feature flag
derrabauke Jan 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions addon/components/validated-form.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { getOwner } from "@ember/application";
import { action } from "@ember/object";
import { scheduleOnce } from "@ember/runloop";
import Component from "@glimmer/component";
Expand All @@ -14,6 +15,10 @@ export default class ValidatedFormComponent extends Component {

constructor(...args) {
super(...args);
this.config =
getOwner(this).resolveRegistration("config:environment")[
"ember-validated-form"
];

if (this.args.model && this.args.model.validate) {
scheduleOnce("actions", this, "validateModel", this.args.model);
Expand Down Expand Up @@ -44,6 +49,11 @@ export default class ValidatedFormComponent extends Component {
await model.validate();

if (model.get("isInvalid")) {
if (this.config?.features?.scrollErrorIntoView && model.errors[0]?.key) {
document
.querySelector(`[name=${model.errors[0].key}]`)
?.scrollIntoView();
}
this.runCallback(PROP_ON_INVALID_SUBMIT);
} else {
this.runCallback(PROP_ON_SUBMIT);
Expand Down
10 changes: 10 additions & 0 deletions tests/dummy/app/snippets/config-features.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
var ENV = {
// ...
"ember-validated-form": {
theme: "bootstrap",
features: {
scrollErrorIntoView: true,
}
},
// ...
};
7 changes: 7 additions & 0 deletions tests/dummy/app/templates/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'}}
3 changes: 3 additions & 0 deletions tests/dummy/config/environment.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ module.exports = function (environment) {
defaults: {
hint: "permanent-custom-hint",
},
features: {
scrollErrorIntoView: false,
},
},
EmberENV: {
FEATURES: {
Expand Down