Index.d.ts says that components must be Backbone.Collection<Component> but the docs say Component[] is also accepted
Thanks for reporting this, @froodian. Great question about index.d.ts says that components must be Backbone.Collection<Component> but the docs say Component[] is also accepted. The recommended approach with Components is to use the event-driven API. Start here: Check the GrapesJS documentation for your specific module...
Read full answer below ↓Question
GrapesJS version
- I confirm to use the latest version of GrapesJS
What browser are you using?
Any
Reproducible demo link
https://grapesjs.com/docs/modules/Components.html#component-definition
Describe the bug
How to reproduce the bug?
- https://github.com/artf/grapesjs/blob/dev/index.d.ts#L2055 shows components as
Backbone.Collection<Component> - https://grapesjs.com/docs/modules/Components.html#component-definition shows an array of Components being provided
What is the expected behavior?
js implementation examples more or less work in typescript (possibly with explicit typing added)
What is the current behavior?
(property) grapesjs.ComponentProperties.components?: Backbone.Collection<grapesjs.Component>
Type '({ type: string; name: string; attributes: { class: string; }; components: { type: string; name: string; }[]; } | { type: string; name: string; components: { type: string; name: string; attributes: { class: string; alt: string; }; }[]; } | { ...; } | { ...; })[]' is missing the following properties from type 'Collection<Component>': models, add, remove, reset ts(2739)
index.d.ts(2055, 5): The expected type comes from property 'components' which is declared here on type 'ComponentProperties'
Should https://github.com/artf/grapesjs/blob/dev/index.d.ts#L2055 be changed from
components?: Backbone.Collection<Component>;
to
components?: Component[] | Backbone.Collection<Component>;
?
Code of Conduct
- I agree to follow this project's Code of Conduct
Answers (1)
Thanks for reporting this, @froodian.
Great question about index.d.ts says that components must be Backbone.Collection<Component> but the docs say Component[] is also accepted. The recommended approach with Components is to use the event-driven API.
Start here:
- Check the GrapesJS documentation for your specific module
- Look for the
on()event listener method - Most operations can be achieved by listening to editor and component events
Common patterns:
// Listen for changes
editor.on('change', () => console.log('something changed'));
// Component lifecycle
editor.on('component:mount', (c) => console.log('component ready', c));
editor.on('component:update', (c) => console.log('component updated', c));
If you're still stuck:
- Share a minimal CodeSandbox reproduction
- Include what you've already tried
- Mention your GrapesJS version
- The community is here to help!
Related Questions and Answers
Continue research with similar issue discussions.
Issue #4385
index.d.ts says that run commands should return void but docs say their return value may be used
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Any Reproducible demo link https://grapesj...
Issue #6250
Clone page prompt 'Converting circular structure to JSON'
GrapesJS version[X] I confirm to use the latest version of GrapesJSWhat browser are you using? Chrome 129.0.6668.101Reproducible demo link...
Issue #5175
Move method is not working as expected
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome Reproducible demo link https://code...
Issue #4735
resetId types mismatch
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? n/a Reproducible demo link n/a Describe th...
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
Find the Right GrapesJS Plugin in Seconds: Smarter Discovery Is Live
We're shipping a set of discovery upgrades. New label filters, a proper compatibility switch for GrapesJS vs Studio, one-click and a smarter sort bar.
Tutorial
GrapesJS vs Webflow vs Tilda: What to Choose for Your Business in 2026
Choosing the right website platform in 2026 is no longer just about building a site
Tutorial
GJS Market 2.0 - Donations, Tracking, Labels and Better Product Discovery
We’ve rolled out a new set of GrapesJS marketplace updates across GJS Market, focused on improving how creators distribute products
Browse Plugin Categories
Jump directly to plugin category pages on the marketplace.