Plugin Custom Editor localized text

Technical Questions CMS
1

I am creating a custom editor with our plugin. My understanding is that the two main props are value and onChange. In our scenario, we’re pushing localized text, which as I understand it should look something like this:

{
  @type: "@builder.io/core:LocalizedValue",
  Default: "Welcome Back",
  de: "Schön, dass du wieder bei",
  en: "Welcome Back",
  es: "¡Qué bueno volver a verte!"
  fr: "Ravis de vous revoir "
  pt: "Que bom que você voltou"
}

When we submit that to onChange, the value in the next render of the component is just the basic string “Welcome Back”.

My question is do the custom editors not allow the underlying type to be anything other than a simple string? Or is there some other reason I can’t submit a localized text value?

2

Hello there!

We are working on this. I will let you know once I have an update from the team.

Thanks,

3

Hello @pasquej,

When you create a custom editor plugin to handle inputs such as localized text, it is vital to ensure that the value prop you pass can handle the type as an object or localized value, rather than converting it to a simple string.

The value and onChange props in your custom editor component should be designed to work with deeply nested objects, such as the @type: "@builder.io/core:LocalizedValue" configuration you mentioned. The value you set should indeed be serializable to JSON, which means complex objects like localized values should work.

There could be two potential issues:

  1. Handling of onChange: Ensure that your onChange function properly sets the whole localized object to maintain all language variations rather than only updating the default or active language.
  2. Rendering the Value: It is also crucial that your component supports rendering this object format correctly and does not default to rendering just one property, like the simple string. This often involves making sure that your component’s internal logic explicitly accounts for localization mapping.

If these suggestions don’t resolve the problem, could you share a minimal repo of your plugin code? That way, we can attempt to reproduce the issue and assist you further.

Thanks,