discourse/app/assets/javascripts/wizard/addon/components/wizard-step.js
Dan Gebhardt ba27ee1637
DEV: Remove usage of {{action}} modifiers (#18333)
This PR enables the [`no-action-modifiers`](https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-action-modifiers.md) template lint rule and removes all usages of the `{{action}}` modifier in core.

In general, instances of `{{action "x"}}` have been replaced with `{{on "click" (action "x")}}`. 

In many cases, such as for `a` elements, we also need to prevent default event handling to avoid unwanted side effects. While the `{{action}}` modifier internally calls `event.preventDefault()`, we need to handle these cases more explicitly. For this purpose, this PR also adds the [ember-event-helpers](https://github.com/buschtoens/ember-event-helpers) dependency so we can use the `prevent-default` handler. For instance:

```
<a href {{on "click" (prevent-default (action "x"))}}>Do X</a>
```

Note that `action` has not in general been refactored away as a helper yet. In general, all event handlers should be methods on the corresponding component and referenced directly (e.g. `{{on "click" this.doSomething}}`). However, the `action` helper is used extensively throughout the codebase and often references methods in the `actions` hash on controllers or routes. Thus this refactor will also be extensive and probably deserves a separate PR.

Note: This work was done to complement #17767 by minimizing the potential impact of the `action` modifier override, which uses private API and arguably should be replaced with an AST transform.

Commits:
* Enable `no-action-modifiers` template lint rule
* Replace {{action "x"}} with {{on "click" (action "x")}}
* Remove unnecessary action helper usage
* Remove ctl+click tests for user-menu
   These tests now break in Chrome when used with addEventListener. As per the comment, they can probably be safely removed.
* Prevent default event handlers to avoid unwanted side effects
   Uses `event.preventDefault()` in event handlers to prevent default event handling. This had been done automatically by the `action` modifier, but is not always desirable or necessary.
* Restore UserCardContents#showUser action to avoid regression
   By keeping the `showUser` action, we can avoid a breaking change for plugins that rely upon it, while not interfering with the `showUser` argument that's been passed.
* Revert EditCategoryTab#selectTab -> EditCategoryTab#select
   Avoid potential breaking change in themes / plugins
* Restore GroupCardContents#showGroup action to avoid regression
   By keeping the `showGroup` action, we can avoid a breaking change for plugins that rely upon it, while not interfering with the `showGroup` argument that's been passed.
* Restore SecondFactorAddTotp#showSecondFactorKey action to avoid regression
   By keeping the `showSecondFactorKey` action, we can avoid a breaking change for plugins that rely upon it, while not interfering with the `showSecondFactorKey` property that's maintained on the controller.
* Refactor away from `actions` hash in ChooseMessage component
* Modernize EmojiPicker#onCategorySelection usage
* Modernize SearchResultEntry#logClick usage
* Modernize Discovery::Categories#showInserted usage
* Modernize Preferences::Account#resendConfirmationEmail usage
* Modernize MultiSelect::SelectedCategory#onSelectedNameClick usage
* Favor fn over action in SelectedChoice component
* Modernize WizardStep event handlers
* Favor fn over action usage in buttons
* Restore Login#forgotPassword action to avoid possible regression
2022-10-04 10:42:46 +02:00

202 lines
4.2 KiB
JavaScript

import discourseComputed, { observes } from "discourse-common/utils/decorators";
import Component from "@ember/component";
import I18n from "I18n";
import { htmlSafe } from "@ember/template";
import { schedule } from "@ember/runloop";
import { action } from "@ember/object";
import { inject as service } from "@ember/service";
const alreadyWarned = {};
export default Component.extend({
router: service(),
dialog: service(),
classNameBindings: [":wizard-container__step", "stepClass"],
saving: null,
didInsertElement() {
this._super(...arguments);
this.autoFocus();
},
@discourseComputed("step.index")
showBackButton(index) {
return index > 0;
},
@discourseComputed("step.displayIndex", "wizard.totalSteps")
showNextButton(current, total) {
return current < total;
},
@discourseComputed("step.id")
nextButtonLabel(step) {
return `wizard.${step === "ready" ? "configure_more" : "next"}`;
},
@discourseComputed("step.id")
nextButtonClass(step) {
return step === "ready" ? "configure-more" : "next";
},
@discourseComputed("step.id")
showJumpInButton(step) {
return ["ready", "styling", "branding"].includes(step);
},
@discourseComputed("step.id")
jumpInButtonLabel(step) {
return `wizard.${step === "ready" ? "jump_in" : "finish"}`;
},
@discourseComputed("step.id")
jumpInButtonClass(step) {
return step === "ready" ? "jump-in" : "finish";
},
@discourseComputed("step.id")
showFinishButton(step) {
return step === "corporate";
},
@discourseComputed("step.id")
stepClass(step) {
return step;
},
@discourseComputed("step.banner")
bannerImage(bannerName) {
if (!bannerName) {
return;
}
return bannerName;
},
@discourseComputed()
bannerAndDescriptionClass() {
return `wizard-container__step-banner`;
},
@observes("step.id")
_stepChanged() {
this.set("saving", false);
this.autoFocus();
},
keyPress(event) {
if (event.key === "Enter") {
if (this.showJumpInButton) {
this.send("quit");
} else {
this.send("nextStep");
}
}
},
@discourseComputed("step.index", "wizard.totalSteps")
barStyle(displayIndex, totalSteps) {
let ratio = parseFloat(displayIndex) / parseFloat(totalSteps - 1);
if (ratio < 0) {
ratio = 0;
}
if (ratio > 1) {
ratio = 1;
}
return htmlSafe(`width: ${ratio * 200}px`);
},
@discourseComputed("step.fields")
includeSidebar(fields) {
return !!fields.findBy("show_in_sidebar");
},
autoFocus() {
schedule("afterRender", () => {
const $invalid = $(
".wizard-container__input.invalid:nth-of-type(1) .wizard-focusable"
);
if ($invalid.length) {
return $invalid.focus();
}
$(".wizard-focusable:nth-of-type(1)").focus();
});
},
advance() {
this.set("saving", true);
this.step
.save()
.then((response) => this.goNext(response))
.finally(() => this.set("saving", false));
},
@action
quit(event) {
event?.preventDefault();
this.router.transitionTo("discovery.latest");
},
@action
exitEarly(event) {
event?.preventDefault();
const step = this.step;
step.validate();
if (step.get("valid")) {
this.set("saving", true);
step
.save()
.then((response) => this.goNext(response))
.finally(() => this.set("saving", false));
} else {
this.autoFocus();
}
},
@action
backStep(event) {
event?.preventDefault();
if (this.saving) {
return;
}
this.goBack();
},
@action
nextStep(event) {
event?.preventDefault();
if (this.saving) {
return;
}
const step = this.step;
const result = step.validate();
if (result.warnings.length) {
const unwarned = result.warnings.filter((w) => !alreadyWarned[w]);
if (unwarned.length) {
unwarned.forEach((w) => (alreadyWarned[w] = true));
return this.dialog.confirm({
message: unwarned.map((w) => I18n.t(`wizard.${w}`)).join("\n"),
didConfirm: () => this.advance(),
});
}
}
if (step.get("valid")) {
this.advance();
} else {
this.autoFocus();
}
},
});