Issue #5144💬 AnsweredOpened May 25, 2023by duclet1 reactions

Incorrect type definition for PanelManager.addPanel

Quick answerby duclet1

@artf - You didn't read the full sentence. You can clearly see in the code itself, it requires the argument given as the full Panel object. In your docs (as linked), you are not giving it the full Panel object in the example, but rather just an object with those projects. Your example is the following: Which TypeScrip...

Read full answer below ↓

Question

GrapesJS version

  • I confirm to use the latest version of GrapesJS

What browser are you using?

All

Reproducible demo link

None

Describe the bug

The definition of the function located here: https://github.com/GrapesJS/grapesjs/blob/v0.21.1/src/panels/index.ts#L82 requires the data given as the full panel instance itself or an array of properties. The documentation on the site (https://grapesjs.com/docs/getting-started.html#panels-buttons) says the parameters given can be only an object with the properties (essentially a partial of the attributes of a panel).

Code of Conduct

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

Answers (3)

ducletJune 13, 2023

@artf - You didn't read the full sentence. You can clearly see in the code itself, it requires the argument given as the full Panel object. In your docs (as linked), you are not giving it the full Panel object in the example, but rather just an object with those projects. Your example is the following:

editor.Panels.addPanel({
  id: 'panel-top',
  el: '.panel__top',
});

Which TypeScript will complain about because the object given to it isn't an instance of a Panel nor is it an array of the object's properties.

artfMay 27, 2023

The documentation on the site says the parameters given can be only an object with the properties

Sorry, where exactly do you read that statement?

ClaudeCodeMay 17, 2026

Thanks for reporting this, @duclet.

The issue with Incorrect type definition for PanelManager.addPanel 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.