mirror of
https://github.com/discourse/discourse.git
synced 2024-12-16 15:43:44 +08:00
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
142 lines
3.7 KiB
JavaScript
142 lines
3.7 KiB
JavaScript
import Component from "@ember/component";
|
|
import I18n from "I18n";
|
|
import discourseComputed from "discourse-common/utils/decorators";
|
|
import { fmt } from "discourse/lib/computed";
|
|
import { isDocumentRTL } from "discourse/lib/text-direction";
|
|
import { action } from "@ember/object";
|
|
import { next } from "@ember/runloop";
|
|
|
|
export default Component.extend({
|
|
warning: null,
|
|
|
|
@discourseComputed("theme.targets", "onlyOverridden", "showAdvanced")
|
|
visibleTargets(targets, onlyOverridden, showAdvanced) {
|
|
return targets.filter((target) => {
|
|
if (target.advanced && !showAdvanced) {
|
|
return false;
|
|
}
|
|
if (!onlyOverridden) {
|
|
return true;
|
|
}
|
|
return target.edited;
|
|
});
|
|
},
|
|
|
|
@discourseComputed("currentTargetName", "onlyOverridden", "theme.fields")
|
|
visibleFields(targetName, onlyOverridden, fields) {
|
|
fields = fields[targetName];
|
|
if (onlyOverridden) {
|
|
fields = fields.filter((field) => field.edited);
|
|
}
|
|
return fields;
|
|
},
|
|
|
|
@discourseComputed("currentTargetName", "fieldName")
|
|
activeSectionMode(targetName, fieldName) {
|
|
if (["settings", "translations"].includes(targetName)) {
|
|
return "yaml";
|
|
}
|
|
if (["extra_scss"].includes(targetName)) {
|
|
return "scss";
|
|
}
|
|
if (["color_definitions"].includes(fieldName)) {
|
|
return "scss";
|
|
}
|
|
return fieldName && fieldName.includes("scss") ? "scss" : "html";
|
|
},
|
|
|
|
@discourseComputed("currentTargetName", "fieldName")
|
|
placeholder(targetName, fieldName) {
|
|
if (fieldName && fieldName === "color_definitions") {
|
|
const example =
|
|
":root {\n" +
|
|
" --mytheme-tertiary-or-quaternary: #{dark-light-choose($tertiary, $quaternary)};\n" +
|
|
"}";
|
|
|
|
return I18n.t("admin.customize.theme.color_definitions.placeholder", {
|
|
example: isDocumentRTL() ? `<div dir="ltr">${example}</div>` : example,
|
|
});
|
|
}
|
|
return "";
|
|
},
|
|
|
|
@discourseComputed("fieldName", "currentTargetName", "theme")
|
|
activeSection: {
|
|
get(fieldName, target, model) {
|
|
return model.getField(target, fieldName);
|
|
},
|
|
set(value, fieldName, target, model) {
|
|
model.setField(target, fieldName, value);
|
|
return value;
|
|
},
|
|
},
|
|
|
|
editorId: fmt("fieldName", "currentTargetName", "%@|%@"),
|
|
|
|
@discourseComputed("maximized")
|
|
maximizeIcon(maximized) {
|
|
return maximized ? "discourse-compress" : "discourse-expand";
|
|
},
|
|
|
|
@discourseComputed("currentTargetName", "theme.targets")
|
|
showAddField(currentTargetName, targets) {
|
|
return targets.find((t) => t.name === currentTargetName).customNames;
|
|
},
|
|
|
|
@discourseComputed(
|
|
"currentTargetName",
|
|
"fieldName",
|
|
"theme.theme_fields.@each.error"
|
|
)
|
|
error(target, fieldName) {
|
|
return this.theme.getError(target, fieldName);
|
|
},
|
|
|
|
@action
|
|
toggleShowAdvanced(event) {
|
|
event?.preventDefault();
|
|
this.toggleProperty("showAdvanced");
|
|
},
|
|
|
|
@action
|
|
toggleAddField(event) {
|
|
event?.preventDefault();
|
|
this.toggleProperty("addingField");
|
|
},
|
|
|
|
@action
|
|
toggleMaximize(event) {
|
|
event?.preventDefault();
|
|
this.toggleProperty("maximized");
|
|
next(() => this.appEvents.trigger("ace:resize"));
|
|
},
|
|
|
|
actions: {
|
|
cancelAddField() {
|
|
this.set("addingField", false);
|
|
},
|
|
|
|
addField(name) {
|
|
if (!name) {
|
|
return;
|
|
}
|
|
name = name.replace(/[^a-zA-Z0-9-_/]/g, "");
|
|
this.theme.setField(this.currentTargetName, name, "");
|
|
this.setProperties({ newFieldName: "", addingField: false });
|
|
this.fieldAdded(this.currentTargetName, name);
|
|
},
|
|
|
|
onlyOverriddenChanged(value) {
|
|
this.onlyOverriddenChanged(value);
|
|
},
|
|
|
|
save() {
|
|
this.attrs.save();
|
|
},
|
|
|
|
setWarning(message) {
|
|
this.set("warning", message);
|
|
},
|
|
},
|
|
});
|