Help with Translation/displaying labels correctly

Dev
1

I’m trying to create a theme component that adds underlining to the composer toolbar.

I’m able to get it working, the button label is working, however when it’s used it returns

[en.composer.underline_text]

not the expected

Example Text

I’ve been going around in circles but unable to workout why, anyone got any idea what i’m missing?

Thanks

api-setup.js

import { apiInitializer } from "discourse/lib/api";
import I18n from "I18n";
import { iconNode } from "discourse-common/lib/icon-library";

export default apiInitializer("0.11.1", (api) => {
  const currentLocale = I18n.currentLocale();

  I18n.translations[currentLocale].js.underline_button_title = settings.underline_button;
  I18n.translations[currentLocale].js.underline_text = settings.underline_text;

  api.onToolbarCreate((toolbar) => {
    const buttons = [
      {
        id: "underline_button",
        group: "fontStyles",
        icon: "underline",
        shortcut: "U",
        title: "underline_button_title",
        perform: (e) => e.applySurround("[u]", "[/u]", "underline_text"),
      },
    ];

    buttons.forEach((button) => toolbar.addButton(button));
  });

  api.decorateCookedElement(
    async (elem, helper) => {
      const id = helper ? `post_${helper.getModel().id}` : "composer";
      applyHighlight(elem, id);
    },
    { id: "wrap-mark" }
  );
});

settings.yml

underline_button:
  default: "Underline"
  description:
    en: Enter the text for the title of the button in the composer.
underline_text:
  default: "Example Text"
  description:
    en: Enter the placeholder text that appears in the composer after the user clicks the button.

Svg_icons: 
  type: 'list'
  list_type: 'compact'
  default: 'underline'
  description: 
    en: "Include FontAwesome 6 icon classes for each icon used in the list."

en.yml

en:
  js:
    underline_button_title: settings.underline_button
    underline_text: settings.underline_text
2

Why do you create the texts as settings instead of putting them directly in en.yml?

I think Composer Footnote Button is a helpful example

3 Likes
3

Thanks for pointing me in the right direction

Turned out

I18n.translations[currentLocale].js.underline_text = settings.underline_text;

should be

I18n.translations[currentLocale].js.composer.underline_text = settings.underline_text;

3 Likes