Skip to content

A platform for community discussion. Free, open, simple.

FEATURE: Add a per post localization toggle (#40785)

Natalie Tay7d46c5ef295c
diff --git a/app/assets/stylesheets/common/components/post-translations.scss b/app/assets/stylesheets/common/components/post-translations.scss
index b21c483c164..1a1e9320c0d 100644
--- a/app/assets/stylesheets/common/components/post-translations.scss
+++ b/app/assets/stylesheets/common/components/post-translations.scss
@@ -18,6 +18,16 @@
flex-direction: column;
align-items: flex-start;
+ .post-language__original-language {
+ appearance: none;
+ border: 0;
+ background: transparent;
+ color: inherit;
+ font: inherit;
+ padding: 0;
+ text-align: start;
+ }
+
.post-language__disclaimer {
color: var(--primary-medium);
font-size: var(--font-down-2);
diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml
index 31a40247454..2942c0f9e25 100644
--- a/config/locales/client.en.yml
+++ b/config/locales/client.en.yml
@@ -4965,6 +4965,10 @@ en:
original_language: "This post was originally written in %{language}"
original_language_and_outdated: "This post was originally written in %{language}. Translation may be outdated"
+ # This is a loose key to be used beside the post-info post-language icon
+ originally_written_in: "Originally %{language}"
+ click_to_translate: "Click to translate"
+ tap_to_translate: "Tap here to translate"
ai_translation_disclaimer: "AI-generated translations may be inaccurate."
category:
diff --git a/frontend/discourse/app/components/post/meta-data/language.gjs b/frontend/discourse/app/components/post/meta-data/language.gjs
index 4063bcee808..03e3d95ddf1 100644
--- a/frontend/discourse/app/components/post/meta-data/language.gjs
+++ b/frontend/discourse/app/components/post/meta-data/language.gjs
@@ -1,10 +1,17 @@
import Component from "@glimmer/component";
+import { on } from "@ember/modifier";
+import { action } from "@ember/object";
import { service } from "@ember/service";
+import PluginOutlet from "discourse/components/plugin-outlet";
import DTooltip from "discourse/float-kit/components/d-tooltip";
+import lazyHash from "discourse/helpers/lazy-hash";
+import { popupAjaxError } from "discourse/lib/ajax-error";
import { i18n } from "discourse-i18n";
export default class PostMetaDataLanguage extends Component {
@service languageNameLookup;
+ @service site;
+ @service tooltip;
get language() {
const lang = this.args.post?.language;
@@ -15,28 +22,74 @@ export default class PostMetaDataLanguage extends Component {
return this.args.post?.localization_outdated;
}
- get tooltip() {
+ get tooltipText() {
const i18nKey = this.outdated
? "post.original_language_and_outdated"
: "post.original_language";
- return i18n(i18nKey, { language: this.language });
+ return `${i18n(i18nKey, {
+ language: this.language,
+ })}. ${this.translatePrompt}`;
+ }
+
+ get translatePrompt() {
+ return this.site.mobileView
+ ? i18n("post.tap_to_translate")
+ : i18n("post.click_to_translate");
+ }
+
+ @action
+ translateOnDesktop(event) {
+ if (this.site.mobileView) {
+ return;
+ }
+
+ return this.translate(event);
+ }
+
+ @action
+ async translate(event) {
+ event?.preventDefault();
+
+ await this.tooltip.close("post-language");
+
+ try {
+ await this.args.post?.toggleLocalizedContent();
+ } catch (error) {
+ popupAjaxError(error);
+ }
}
<template>
<div class="post-info post-language">
- <DTooltip
- class={{if this.outdated "heatmap-low"}}
- @identifier="post-language"
- @icon="language"
+ <PluginOutlet
+ @name="post-language-indicator"
+ @outletArgs={{lazyHash
+ post=@post
+ language=this.language
+ outdated=this.outdated
+ tooltipText=this.tooltipText
+ translate=this.translate
+ }}
>
- <:content>
- <div>{{this.tooltip}}</div>
- <div class="post-language__disclaimer">{{i18n
- "post.ai_translation_disclaimer"
- }}</div>
- </:content>
- </DTooltip>
+ <DTooltip
+ class={{if this.outdated "heatmap-low"}}
+ @identifier="post-language"
+ @icon="language"
+ {{on "click" this.translateOnDesktop}}
+ >
+ <:content>
+ <button
+ type="button"
+ class="post-language__original-language"
+ {{on "click" this.translate}}
+ >{{this.tooltipText}}</button>
+ <div class="post-language__disclaimer">{{i18n
+ "post.ai_translation_disclaimer"
+ }}</div>
+ </:content>
+ </DTooltip>
+ </PluginOutlet>
</div>
</template>
}
diff --git a/frontend/discourse/app/models/post.js b/frontend/discourse/app/models/post.js
index 56e1f88bef4..33ac2e970e5 100644
--- a/frontend/discourse/app/models/post.js
+++ b/frontend/discourse/app/models/post.js
@@ -169,6 +169,7 @@ export default class Post extends RestModel {
@tracked likeAction;
@tracked link_counts;
@tracked localization_outdated;
+ @tracked localizedCooked;
@tracked localized_oneboxes;
@tracked locked;
@tracked moderator;
@@ -723,6 +724,22 @@ export default class Post extends RestModel {
});
}
+ async toggleLocalizedContent() {
+ if (this.localizedCooked) {
+ this.setProperties({
+ cooked: this.localizedCooked,
+ localizedCooked: null,
+ });
+ } else {
+ const result = await ajax(`/posts/${this.id}/cooked.json`);
+
+ this.setProperties({
+ localizedCooked: this.cooked,
+ cooked: result.cooked,
+ });
+ }
+ }
+
rebake() {
return ajax(`/posts/${this.id}/rebake`, { type: "PUT" }).catch(
popupAjaxError
diff --git a/frontend/discourse/tests/integration/components/post/post-test.gjs b/frontend/discourse/tests/integration/components/post/post-test.gjs
index 16626e55796..0c8fdd4bd8f 100644
--- a/frontend/discourse/tests/integration/components/post/post-test.gjs
+++ b/frontend/discourse/tests/integration/components/post/post-test.gjs
@@ -1,11 +1,15 @@
import { getOwner } from "@ember/owner";
import { click, render, settled, triggerEvent } from "@ember/test-helpers";
+import hbs from "htmlbars-inline-precompile";
import { module, test } from "qunit";
import Post from "discourse/components/post";
import DMenus from "discourse/float-kit/components/d-menus";
+import { forceMobile, resetMobile } from "discourse/lib/mobile";
import { withPluginApi } from "discourse/lib/plugin-api";
import { setupRenderingTest } from "discourse/tests/helpers/component-test";
+import pretender, { response } from "discourse/tests/helpers/create-pretender";
import { queryAll } from "discourse/tests/helpers/qunit-helpers";
+import { registerTemporaryModule } from "discourse/tests/helpers/temporary-module-helper";
import { i18n } from "discourse-i18n";
function renderComponent(
@@ -46,6 +50,10 @@ function renderComponent(
module("Integration | Component | Post", function (hooks) {
setupRenderingTest(hooks);
+ hooks.afterEach(function () {
+ resetMobile();
+ });
+
hooks.beforeEach(function () {
this.siteSettings.post_menu_hidden_items = "";
@@ -299,15 +307,120 @@ module("Integration | Component | Post", function (hooks) {
await triggerEvent(".fk-d-tooltip__trigger", "pointermove");
assert.dom(".post-language").includesText(
- i18n("post.original_language", {
+ `${i18n("post.original_language", {
language: "English (US)",
- })
+ })}. ${i18n("post.click_to_translate")}`
);
assert
.dom(".post-language")
.includesText(i18n("post.ai_translation_disclaimer"));
});
+ test("language click translates content on desktop", async function (assert) {
+ this.post.is_localized = true;
+ this.post.language = "en";
+ this.post.cooked = "<p>Translated post</p>";
+ this.siteSettings.available_locales = [
+ { value: "en", name: "English (US)" },
+ ];
+
+ pretender.get(`/posts/${this.post.id}/cooked.json`, () =>
+ response({ cooked: "<p>Original post</p>" })
+ );
+
+ await renderComponent(this.post);
+ await click(".fk-d-tooltip__trigger");
+
+ assert.strictEqual(
+ this.post.cooked,
+ "<p>Original post</p>",
+ "content is switched to original"
+ );
+
+ await click(".fk-d-tooltip__trigger");
+
+ assert.strictEqual(
+ this.post.cooked,
+ "<p>Translated post</p>",
+ "content is switched back to translated"
+ );
+ });
+
+ test("language indicator plugin outlet can render content before and after the icon", async function (assert) {
+ registerTemporaryModule(
+ "discourse/plugins/test-plugin/templates/connectors/post-language-indicator__before/label-before",
+ hbs`<span class="language-before">Before {{@outletArgs.language}}</span>`
+ );
+ registerTemporaryModule(
+ "discourse/plugins/test-plugin/templates/connectors/post-language-indicator__after/label-after",
+ hbs`<span class="language-after">After {{@outletArgs.language}}</span>`
+ );
+
+ this.post.is_localized = true;
+ this.post.language = "en";
+ this.siteSettings.available_locales = [
+ { value: "en", name: "English (US)" },
+ ];
+
+ await renderComponent(this.post);
+
+ const before = document.querySelector(".language-before");
+ const trigger = document.querySelector(".fk-d-tooltip__trigger");
+ const after = document.querySelector(".language-after");
+
+ assert.dom(before).hasText("Before English (US)");
+ assert.dom(trigger).exists("core language icon renders");
+ assert.dom(after).hasText("After English (US)");
+ assert.deepEqual(
+ Array.from(
+ document.querySelectorAll(
+ ".language-before, .fk-d-tooltip__trigger, .language-after"
+ )
+ ).map((element) => element.classList[0]),
+ ["language-before", "fk-d-tooltip__trigger", "language-after"],
+ "connectors render around the icon"
+ );
+ });
+
+ test("language tooltip on mobile translates when tapping the tooltip text", async function (assert) {
+ forceMobile();
+
+ this.post.is_localized = true;
+ this.post.language = "en";
+ this.post.cooked = "<p>Translated post</p>";
+ this.siteSettings.available_locales = [
+ { value: "en", name: "English (US)" },
+ ];
+
+ pretender.get(`/posts/${this.post.id}/cooked.json`, () =>
+ response({ cooked: "<p>Original post</p>" })
+ );
+
+ await renderComponent(this.post);
+
+ await click(".fk-d-tooltip__trigger");
+
+ assert.dom(".post-language").includesText(
+ `${i18n("post.original_language", {
+ language: "English (US)",
+ })}. ${i18n("post.tap_to_translate")}`,
+ "mobile tooltip uses tap copy"
+ );
+ assert.strictEqual(
+ this.post.cooked,
+ "<p>Translated post</p>",
+ "tapping the icon only opens the tooltip"
+ );
+
+ await click(".post-language__original-language");
+
+ assert.strictEqual(
+ this.post.cooked,
+ "<p>Original post</p>",
+ "content is switched after tapping tooltip text"
+ );
+ });
+
test("outdated localization", async function (assert) {
this.post.is_localized = true;
this.post.language = "en";
@@ -320,9 +433,9 @@ module("Integration | Component | Post", function (hooks) {
await triggerEvent(".fk-d-tooltip__trigger", "pointermove");
assert.dom(".post-language").includesText(
- i18n("post.original_language_and_outdated", {
+ `${i18n("post.original_language_and_outdated", {
language: "English (US)",
- })
+ })}. ${i18n("post.click_to_translate")}`
);
assert
.dom(".post-language")