Issue #5357πŸ’¬ AnsweredOpened September 3, 2023by peters-ben-00070 reactions

Cannot pass HTMLElement as icon when adding new rte action

Quick answerby ClaudeCode

Thanks for reporting this, @peters-ben-0007. The issue with (type issue) cannot pass HTMLElement as icon when adding new rte action appears to be a race condition or state management timing problem. This typically happens when component lifecycle events and DOM modifications overlap, creating an inconsistent state. Wh...

Read full answer below ↓

Question

GrapesJS version

  • I confirm to use the latest version of GrapesJS

What browser are you using?

Chrome

Reproducible demo link

https://jsfiddle.net/vmeywbk8/11/

Describe the bug

Just a small type issue we came across - when adding an action to the RichTextEditor, the "icon" property of RichTextEditorAction is marked as string. But in addAction (https://github.com/GrapesJS/grapesjs/blob/793599cbd5493c0104db1134bd4b1684341274a7/src/rich_text_editor/model/RichTextEditor.ts#L363) if we pass in a HTMLElement, it will be appended to the button. This still works fine at runtime, but you will get a type mismatch error from TypeScript if you try to pass anything other than a string.

the "icon" property should probably be marked as "string | HTMLElement" to resolve this - I'd like to fix this as my first contribution

Code of Conduct

  • I agree to follow this project's Code of Conduct

Answers (1)

ClaudeCodeβ€’ May 17, 2026

Thanks for reporting this, @peters-ben-0007.

The issue with (type issue) cannot pass HTMLElement as icon when adding new rte action appears to be a race condition or state management timing problem. This typically happens when component lifecycle events and DOM modifications overlap, creating an inconsistent state.

What to try:

  1. Add a setTimeout wrapper to ensure the DOM has settled:
setTimeout(() => {
  // your operation here
}, 0);
  1. Check initialization order β€” make sure components are fully loaded before you interact with them

  2. Use the editor's event system β€” listen to completion events:

editor.on('component:mount', (component) => {
  // safe to interact with component here
});

Recommended next steps:

  • Test with the latest GrapesJS version if you haven't
  • Provide a minimal reproducible example (CodeSandbox) β€” this helps the team identify the root cause faster
  • Include GrapesJS version, browser, and console errors in your report

Related Questions and Answers

Continue research with similar issue discussions.

Paid Plugins That Match This Issue

Curated by issue keywords and label relevance to help you ship faster.

View all plugins

Loading paid plugin recommendations...

Free option

Check the open-source GrapesJS plugins on GitHub or run a quick search in our free catalog.

Browse free plugins β†’
Premium option

Premium plugins ship with support, regular updates, and production-ready features β€” save days of integration work.

Browse premium plugins β†’

Related tutorials

In-depth guides on the same topic.

All tutorials β†’

Browse Plugin Categories

Jump directly to plugin category pages on the marketplace.