Topol Plugin Guide

Appearance

Changelog - May, 2025 ​

New Features ​

Custom UI Labels ​

You can now fine‑tune every string in the Topol Email Editor with the new textOverride option, replacing the default localisation wherever necessary so the interface speaks in your brand’s voice.

Why It Matters ​

This capability allows you to use terminology that resonates with your audience while ensuring brand consistency. You can clarify features by renaming them, such as changing Merge Tags to Placeholders or modifying the locked-section alert messages. Since you can instantly override any label, you can address translation gaps without the need to wait for a full release.

How To Enable ​

Add the new textOverride object within the TOPOL_OPTIONS configuration object. There, enter the path to any string using dot‑notation and assign your replacement text.

ts
textOverride: {
   "editor.personalisations": "New Label for Merge Tags",
   "forms.section_locked": "New Message for Locked Sections",
// "path to any original string using dot-notation": "Your Custom String"
},

For full list of editable strings, along with further details for this feature, see our documentation.

Improvements ​

More Theme Customization Options ​

You can now customize the background color (and opacity) of any locked structure or content block via your theme’s colors settings, aligning them with your brand identity or your editor’s custom color theme. For full details, see our documentation.

New Endpoint for Deleting Custom Templates ​

The new Remove Template endpoint allows you to delete templates from your custom library through an API call, ensuring the editor’s premade picker only has access to the templates you choose to display. For full details, see our documentation.

Conditional Syntax Support for Sparkpost ​

You can now leverage familiar conditional syntax from SparkPost directly in your templates. By setting emailServiceProvider to sparkpost in your TOPOL_OPTIONS, you can write conditional chaining with AND/OR operators. For full details, see our documentation.

Bugfixes ​

  • Corrected a typo in the default text of newly inserted Text blocks.
  • Color of the AI Assistant button now matches other Structure controls when using a Custom Theme.
  • Resolved an issue where calling TopolPlugin.togglePreview() from a custom button would unexpectedly hide the editor’s Top bar.
  • Resolved an issue causing HTML blocks to render with zero height in preview.