Issue #4384Opened June 15, 2022by froodian0 reactions

BUG: index.d.ts says that components must be Backbone.Collection<Component> but the docs say Component[] is also accepted

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?

  1. https://github.com/artf/grapesjs/blob/dev/index.d.ts#L2055 shows components as Backbone.Collection<Component>
  2. 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 (0)

No answers yet.

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...

Browse Plugin Categories

Jump directly to plugin category pages on the marketplace.