BUG/[QUESTION]: How to correctly wrap a Component on add/mount?
Question
GrapesJS version
- I confirm to use the latest version of GrapesJS
What browser are you using?
Chrome v128
Reproducible demo link
https://jsfiddle.net/fjyk6n4a/2/
Describe the bug
Hi @artf, I am currently trying to wrap a component in a section component if its has not been wrapped yet. I am hooking into the component:mount event and replacing the added component with the section component (which has the added one as child). My Code looks something like this:
editor.on('component:mount', (component) => {
if (component.parent().attributes.tagName !== 'body')
return;
if (component.is('section'))
return;
component.replaceWith({
type: 'section',
components: component
});
})
The issue I'm facing is that the UndoManager stack is not completely aligned with what is happening. After the add and wrap the stack has 3 Entries: remove of original component, add of section and add of original component. When clicking undo the section is removed and the original component stays. But it is buggy in means of it is not removable and not really there because the stack entries do not reflect the changes correctly (maybe missing the initial add).
How to reproduce what I described:
- open reproducable demo link
- add text component (is wrapped in section as visible in layers)
- click ctrl+z to undo
- text is still in canvas and layers, section is gone. text is not removable
My Question: Ideally I would like to change the UndoManager stack in that on undo either the section and original component are both removed at the same time and without bugs (currently the problem) or the original component is removed and if you click undo again then the section is removed (as if the section was added first). In component:mount event the stack does not have the newest entry of the add yet so I cant manipulate it at that time. What is the best way to wrap the Component without having problems with the UndoManager or how can I manipulate the stack to fix it?
Code of Conduct
- I agree to follow this project's Code of Conduct
Answers (1)
Hi @artf,
I’m also hitting a crash when using component.replaceWith() together with UndoManager.
This only happens when replaceWith() is triggered during editor lifecycle events
(e.g. change:status, component:selected, component:deselected).
On undo, GrapesJS tries to restore selection/state for the old component, but it no longer exists in the parent collection, which leads to errors like:
Cannot read properties of undefined (reading 'indexOf')
The same replaceWith() logic works fine when executed from Trait.
Is there a recommended, undo-safe way to replace a component during selection changes.
Thanks.
Related Questions and Answers
Continue research with similar issue discussions.
Issue #4323
BUG: Performance issue while dragging component to canvas when you have 2k component on canvas
GrapesJS version[X] I confirm to use the latest version of GrapesJSWhat browser are you using? Google Chrome Version 101.0.4951.41 (Officia...
Issue #5990
BUG: When you delete a component, duplicate classes between components will be deleted.
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome 126.0.6478.127(Windows) Reproducibl...
Issue #5334
BUG: Selection of custom component type not working in the canvas
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome, Opera, Edge, etc Reproducible demo...
Issue #4411
BUG: XSS when add class name to Selector Manager
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome v102 Reproducible demo link https:/...
Paid Plugins That Match This Issue
Curated by issue keywords and label relevance to help you ship faster.
Loading paid plugin recommendations...
Browse Plugin Categories
Jump directly to plugin category pages on the marketplace.