2019-10-24 00:30:52 +08:00
|
|
|
import Component from "@ember/component";
|
2022-06-05 01:19:49 +08:00
|
|
|
import { action } from "@ember/object";
|
2023-10-11 02:38:59 +08:00
|
|
|
import { schedule } from "@ember/runloop";
|
2022-08-02 16:43:25 +08:00
|
|
|
import { inject as service } from "@ember/service";
|
2023-10-11 02:38:59 +08:00
|
|
|
import discourseComputed, { observes } from "discourse-common/utils/decorators";
|
|
|
|
import I18n from "I18n";
|
2016-08-26 01:14:56 +08:00
|
|
|
|
2016-09-21 00:28:22 +08:00
|
|
|
const alreadyWarned = {};
|
|
|
|
|
2019-10-24 00:30:52 +08:00
|
|
|
export default Component.extend({
|
2022-08-02 16:43:25 +08:00
|
|
|
router: service(),
|
2022-09-14 23:06:56 +08:00
|
|
|
dialog: service(),
|
2022-07-27 09:23:01 +08:00
|
|
|
classNameBindings: [":wizard-container__step", "stepClass"],
|
2016-08-26 01:14:56 +08:00
|
|
|
saving: null,
|
|
|
|
|
|
|
|
didInsertElement() {
|
2019-01-19 17:05:51 +08:00
|
|
|
this._super(...arguments);
|
2016-08-26 01:14:56 +08:00
|
|
|
this.autoFocus();
|
|
|
|
},
|
|
|
|
|
2022-08-01 17:19:09 +08:00
|
|
|
@discourseComputed("step.index")
|
|
|
|
showBackButton(index) {
|
|
|
|
return index > 0;
|
|
|
|
},
|
|
|
|
|
2019-11-08 05:38:28 +08:00
|
|
|
@discourseComputed("step.displayIndex", "wizard.totalSteps")
|
2022-07-27 09:23:01 +08:00
|
|
|
showNextButton(current, total) {
|
2022-12-20 08:24:09 +08:00
|
|
|
if (this.showConfigureMore === true) {
|
|
|
|
return false;
|
|
|
|
}
|
2022-07-27 09:23:01 +08:00
|
|
|
return current < total;
|
|
|
|
},
|
2016-08-26 01:14:56 +08:00
|
|
|
|
2022-08-01 17:19:09 +08:00
|
|
|
@discourseComputed("step.id")
|
|
|
|
nextButtonLabel(step) {
|
|
|
|
return `wizard.${step === "ready" ? "configure_more" : "next"}`;
|
2022-07-27 09:23:01 +08:00
|
|
|
},
|
2016-09-01 01:35:49 +08:00
|
|
|
|
2022-07-27 09:23:01 +08:00
|
|
|
@discourseComputed("step.id")
|
2022-08-01 17:19:09 +08:00
|
|
|
nextButtonClass(step) {
|
|
|
|
return step === "ready" ? "configure-more" : "next";
|
2018-11-16 03:44:19 +08:00
|
|
|
},
|
|
|
|
|
2022-12-20 08:24:09 +08:00
|
|
|
@discourseComputed("step.id")
|
|
|
|
showConfigureMore(step) {
|
|
|
|
return step === "ready";
|
|
|
|
},
|
|
|
|
|
2022-08-01 17:19:09 +08:00
|
|
|
@discourseComputed("step.id")
|
|
|
|
showJumpInButton(step) {
|
2022-09-05 19:51:41 +08:00
|
|
|
return ["ready", "styling", "branding"].includes(step);
|
2022-07-27 09:23:01 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
@discourseComputed("step.id")
|
2022-09-05 19:51:41 +08:00
|
|
|
jumpInButtonLabel(step) {
|
|
|
|
return `wizard.${step === "ready" ? "jump_in" : "finish"}`;
|
2022-07-27 09:23:01 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
@discourseComputed("step.id")
|
2022-09-05 19:51:41 +08:00
|
|
|
jumpInButtonClass(step) {
|
|
|
|
return step === "ready" ? "jump-in" : "finish";
|
2022-08-01 17:19:09 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
@discourseComputed("step.id")
|
2022-09-05 19:51:41 +08:00
|
|
|
showFinishButton(step) {
|
|
|
|
return step === "corporate";
|
2022-07-27 09:23:01 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
@discourseComputed("step.id")
|
|
|
|
stepClass(step) {
|
|
|
|
return step;
|
|
|
|
},
|
2016-08-26 01:14:56 +08:00
|
|
|
|
|
|
|
@observes("step.id")
|
|
|
|
_stepChanged() {
|
|
|
|
this.set("saving", false);
|
|
|
|
this.autoFocus();
|
|
|
|
},
|
|
|
|
|
2021-08-09 17:41:36 +08:00
|
|
|
keyPress(event) {
|
|
|
|
if (event.key === "Enter") {
|
2022-08-01 17:19:09 +08:00
|
|
|
if (this.showJumpInButton) {
|
2016-09-23 01:38:40 +08:00
|
|
|
this.send("quit");
|
|
|
|
} else {
|
|
|
|
this.send("nextStep");
|
|
|
|
}
|
2016-08-26 01:14:56 +08:00
|
|
|
}
|
|
|
|
},
|
|
|
|
|
2021-08-26 05:10:12 +08:00
|
|
|
@discourseComputed("step.fields")
|
|
|
|
includeSidebar(fields) {
|
|
|
|
return !!fields.findBy("show_in_sidebar");
|
|
|
|
},
|
|
|
|
|
2016-08-26 01:14:56 +08:00
|
|
|
autoFocus() {
|
2020-04-16 13:58:04 +08:00
|
|
|
schedule("afterRender", () => {
|
2020-11-21 05:48:39 +08:00
|
|
|
const $invalid = $(
|
2022-07-27 09:23:01 +08:00
|
|
|
".wizard-container__input.invalid:nth-of-type(1) .wizard-focusable"
|
2020-11-21 05:48:39 +08:00
|
|
|
);
|
2016-08-26 01:14:56 +08:00
|
|
|
|
|
|
|
if ($invalid.length) {
|
|
|
|
return $invalid.focus();
|
|
|
|
}
|
|
|
|
|
2020-11-21 05:48:39 +08:00
|
|
|
$(".wizard-focusable:nth-of-type(1)").focus();
|
2016-08-26 01:14:56 +08:00
|
|
|
});
|
|
|
|
},
|
|
|
|
|
2016-09-21 00:28:22 +08:00
|
|
|
advance() {
|
|
|
|
this.set("saving", true);
|
2019-05-27 16:15:39 +08:00
|
|
|
this.step
|
2016-09-21 00:28:22 +08:00
|
|
|
.save()
|
2019-01-10 18:06:01 +08:00
|
|
|
.then((response) => this.goNext(response))
|
2016-09-21 00:28:22 +08:00
|
|
|
.finally(() => this.set("saving", false));
|
|
|
|
},
|
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
@action
|
DEV: Remove usage of {{action}} modifiers - Take 2 (#18476)
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.
This is a followup to #18333, which had to be reverted because it did not account for the default treatment of modifier keys by the {{action}} modifier.
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
* Introduce modKeysPressed utility
Returns an array of modifier keys that are pressed during a given `MouseEvent` or `KeyboardEvent`.
* Don't interfere with click events on links with `href` values when modifier keys are pressed
2022-10-05 20:08:54 +08:00
|
|
|
quit(event) {
|
|
|
|
event?.preventDefault();
|
2022-08-02 16:43:25 +08:00
|
|
|
this.router.transitionTo("discovery.latest");
|
2022-06-05 01:19:49 +08:00
|
|
|
},
|
2016-09-15 04:36:08 +08:00
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
@action
|
DEV: Remove usage of {{action}} modifiers - Take 2 (#18476)
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.
This is a followup to #18333, which had to be reverted because it did not account for the default treatment of modifier keys by the {{action}} modifier.
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
* Introduce modKeysPressed utility
Returns an array of modifier keys that are pressed during a given `MouseEvent` or `KeyboardEvent`.
* Don't interfere with click events on links with `href` values when modifier keys are pressed
2022-10-05 20:08:54 +08:00
|
|
|
exitEarly(event) {
|
|
|
|
event?.preventDefault();
|
2022-06-05 01:19:49 +08:00
|
|
|
const step = this.step;
|
|
|
|
step.validate();
|
2018-11-16 03:44:19 +08:00
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
if (step.get("valid")) {
|
|
|
|
this.set("saving", true);
|
2018-11-16 03:44:19 +08:00
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
step
|
|
|
|
.save()
|
2022-08-02 16:43:25 +08:00
|
|
|
.then((response) => this.goNext(response))
|
2022-06-05 01:19:49 +08:00
|
|
|
.finally(() => this.set("saving", false));
|
|
|
|
} else {
|
|
|
|
this.autoFocus();
|
|
|
|
}
|
|
|
|
},
|
2018-11-16 03:44:19 +08:00
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
@action
|
DEV: Remove usage of {{action}} modifiers - Take 2 (#18476)
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.
This is a followup to #18333, which had to be reverted because it did not account for the default treatment of modifier keys by the {{action}} modifier.
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
* Introduce modKeysPressed utility
Returns an array of modifier keys that are pressed during a given `MouseEvent` or `KeyboardEvent`.
* Don't interfere with click events on links with `href` values when modifier keys are pressed
2022-10-05 20:08:54 +08:00
|
|
|
backStep(event) {
|
|
|
|
event?.preventDefault();
|
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
if (this.saving) {
|
|
|
|
return;
|
|
|
|
}
|
2019-01-10 18:06:01 +08:00
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
this.goBack();
|
|
|
|
},
|
2016-08-26 01:14:56 +08:00
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
@action
|
DEV: Remove usage of {{action}} modifiers - Take 2 (#18476)
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.
This is a followup to #18333, which had to be reverted because it did not account for the default treatment of modifier keys by the {{action}} modifier.
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
* Introduce modKeysPressed utility
Returns an array of modifier keys that are pressed during a given `MouseEvent` or `KeyboardEvent`.
* Don't interfere with click events on links with `href` values when modifier keys are pressed
2022-10-05 20:08:54 +08:00
|
|
|
nextStep(event) {
|
|
|
|
event?.preventDefault();
|
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
if (this.saving) {
|
|
|
|
return;
|
|
|
|
}
|
2016-08-26 01:14:56 +08:00
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
const step = this.step;
|
|
|
|
const result = step.validate();
|
|
|
|
|
|
|
|
if (result.warnings.length) {
|
|
|
|
const unwarned = result.warnings.filter((w) => !alreadyWarned[w]);
|
2022-06-17 20:50:21 +08:00
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
if (unwarned.length) {
|
|
|
|
unwarned.forEach((w) => (alreadyWarned[w] = true));
|
2022-06-17 20:50:21 +08:00
|
|
|
|
2022-09-14 23:06:56 +08:00
|
|
|
return this.dialog.confirm({
|
|
|
|
message: unwarned.map((w) => I18n.t(`wizard.${w}`)).join("\n"),
|
|
|
|
didConfirm: () => this.advance(),
|
|
|
|
});
|
2016-09-21 00:28:22 +08:00
|
|
|
}
|
2022-06-05 01:19:49 +08:00
|
|
|
}
|
2016-08-26 01:14:56 +08:00
|
|
|
|
2022-06-05 01:19:49 +08:00
|
|
|
if (step.get("valid")) {
|
|
|
|
this.advance();
|
|
|
|
} else {
|
|
|
|
this.autoFocus();
|
|
|
|
}
|
2016-08-26 01:14:56 +08:00
|
|
|
},
|
|
|
|
});
|