BUG: Incorrect type definition for PanelManager.addPanel

[duclet]

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

[artf]

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?

[duclet]

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