03b7b7d1bc
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
104 lines
2.8 KiB
JavaScript
104 lines
2.8 KiB
JavaScript
import {
|
|
acceptance,
|
|
count,
|
|
exists,
|
|
query,
|
|
} from "discourse/tests/helpers/qunit-helpers";
|
|
import { click, visit } from "@ember/test-helpers";
|
|
import { action } from "@ember/object";
|
|
import { extraConnectorClass } from "discourse/lib/plugin-connectors";
|
|
import { hbs } from "ember-cli-htmlbars";
|
|
import { test } from "qunit";
|
|
|
|
const PREFIX = "javascripts/single-test/connectors";
|
|
|
|
acceptance("Plugin Outlet - Connector Class", function (needs) {
|
|
needs.hooks.beforeEach(() => {
|
|
extraConnectorClass("user-profile-primary/hello", {
|
|
actions: {
|
|
sayHello() {
|
|
this.set("hello", "hello!");
|
|
},
|
|
},
|
|
});
|
|
|
|
extraConnectorClass("user-profile-primary/hi", {
|
|
setupComponent() {
|
|
this.appEvents.on("hi:sayHi", this, this.say);
|
|
},
|
|
|
|
teardownComponent() {
|
|
this.appEvents.off("hi:sayHi", this, this.say);
|
|
},
|
|
|
|
@action
|
|
say() {
|
|
this.set("hi", "hi!");
|
|
},
|
|
|
|
@action
|
|
sayHi() {
|
|
this.appEvents.trigger("hi:sayHi");
|
|
},
|
|
});
|
|
|
|
extraConnectorClass("user-profile-primary/dont-render", {
|
|
shouldRender(args) {
|
|
return args.model.get("username") !== "eviltrout";
|
|
},
|
|
});
|
|
|
|
// eslint-disable-next-line no-undef
|
|
Ember.TEMPLATES[
|
|
`${PREFIX}/user-profile-primary/hello`
|
|
] = hbs`<span class='hello-username'>{{model.username}}</span>
|
|
<button class='say-hello' {{on "click" (action "sayHello")}}></button>
|
|
<span class='hello-result'>{{hello}}</span>`;
|
|
// eslint-disable-next-line no-undef
|
|
Ember.TEMPLATES[
|
|
`${PREFIX}/user-profile-primary/hi`
|
|
] = hbs`<button class='say-hi' {{on "click" (action "sayHi")}}></button>
|
|
<span class='hi-result'>{{hi}}</span>`;
|
|
// eslint-disable-next-line no-undef
|
|
Ember.TEMPLATES[
|
|
`${PREFIX}/user-profile-primary/dont-render`
|
|
] = hbs`I'm not rendered!`;
|
|
});
|
|
|
|
needs.hooks.afterEach(() => {
|
|
// eslint-disable-next-line no-undef
|
|
delete Ember.TEMPLATES[`${PREFIX}/user-profile-primary/hello`];
|
|
// eslint-disable-next-line no-undef
|
|
delete Ember.TEMPLATES[`${PREFIX}/user-profile-primary/hi`];
|
|
// eslint-disable-next-line no-undef
|
|
delete Ember.TEMPLATES[`${PREFIX}/user-profile-primary/dont-render`];
|
|
});
|
|
|
|
test("Renders a template into the outlet", async function (assert) {
|
|
await visit("/u/eviltrout");
|
|
assert.strictEqual(
|
|
count(".user-profile-primary-outlet.hello"),
|
|
1,
|
|
"it has class names"
|
|
);
|
|
assert.ok(
|
|
!exists(".user-profile-primary-outlet.dont-render"),
|
|
"doesn't render"
|
|
);
|
|
|
|
await click(".say-hello");
|
|
assert.strictEqual(
|
|
query(".hello-result").innerText,
|
|
"hello!",
|
|
"actions delegate properly"
|
|
);
|
|
|
|
await click(".say-hi");
|
|
assert.strictEqual(
|
|
query(".hi-result").innerText,
|
|
"hi!",
|
|
"actions delegate properly"
|
|
);
|
|
});
|
|
});
|