Incorrect type definition for PanelManager.addPanel
@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)
@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.
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?
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:
- Add a setTimeout wrapper to ensure the DOM has settled:
setTimeout(() => {
// your operation here
}, 0);
-
Check initialization order — make sure components are fully loaded before you interact with them
-
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.
Issue #5135
Incorrect type definition for StyleManager.addProperty
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? All Reproducible demo link None Describe t...
Issue #4384
index.d.ts says that components must be Backbone.Collection<Component> but the docs say Component[] is also accepted
GrapesJS version[X] I confirm to use the latest version of GrapesJSWhat browser are you using? AnyReproducible demo link https://grapesjs.c...
Issue #5148
none of the official GrapesJS plugins works with the new index.d.ts
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? all and none, the bug is during the build...
Issue #5613
Incorrect type definition for StyleManagerConfig.sectors.properties
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome Reproducible demo link None Describ...
Paid Plugins That Match This Issue
Curated by issue keywords and label relevance to help you ship faster.
Loading paid plugin recommendations...
Check the open-source GrapesJS plugins on GitHub or run a quick search in our free catalog.
Browse free plugins →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.
Tutorial
GrapesJS vs Webflow vs Builder.io vs Puck: Which Visual Builder to Choose in 2026
A practitioner's 2026 comparison of GrapesJS, Webflow, Builder.io, and Puck — pricing, AI features, lock-in, and a one-line rule for picking the right one
Tutorial
Integrating GrapesJS into a Next.js 13+ App with the @grapesjs/react Wrapper
Seamlessly integrate GrapesJS with React, TypeScript, and Next.js using the official @grapesjs/react package for modern app development.
Tutorial
How to Build a GrapesJS Plugin From Scratch Using GrapesJS CLI
Step-by-step tutorial on creating a GrapesJS plugin with CLI. Scaffold, develop, test, and publish plugins easily with this complete guide
Browse Plugin Categories
Jump directly to plugin category pages on the marketplace.