Move method is not working as expected
Fix for this issue: https://github.com/GrapesJS/grapesjs/pull/5176
Read full answer below βQuestion
GrapesJS version
- I confirm to use the latest version of GrapesJS
What browser are you using?
Chrome
Reproducible demo link
https://codesandbox.io/s/adoring-margulis-873kdv
Describe the bug
Context
Move component method doesn't work as expected.
if (component) {
const { at } = opts;
const index = this.index();
const sameParent = component === this.parent();
const sameIndex = index === at || index === at! - 1;
if (!sameParent || !sameIndex) {
if (sameParent && at && at > index) {
opts.at = at - 1;
}
this.remove({ temporary: 1 });
component.append(this, opts);
this.emitUpdate();
}
}
return this;
This piece of code doesn't work as expected.
if (component) {
const { at } = opts;
const index = this.index();
const sameParent = component === this.parent();
const sameIndex = index === at;
if (!sameParent || !sameIndex) {
this.remove({ temporary: 1 });
component.append(this, opts);
this.emitUpdate();
}
}
return this;
this piece of code should work. When sameParent is false and target index is 1, then it won't move to 0 to 1 position for example
Code of Conduct
- I agree to follow this project's Code of Conduct
Answers (4)
Fix for this issue: https://github.com/GrapesJS/grapesjs/pull/5176
Thanks @krishnaeverestengineering but this is actually the expected behaviour for moving the component inside the same parent. This is because the at should account also for the index of the component itself.
- index: 0
{ Component 1 }
- index: 1
{ Component 2 }
- index: 2
So, if you try to move "Component 1" at index 0 or 1, nothing will happen. If you need to move it below "Component 2" you have to indicate index 2
Thanks @krishnaeverestengineering but this is actually the expected behaviour for moving the component inside the same parent. This is because the
atshould account also for the index of the component itself.- index: 0 { Component 1 } - index: 1 { Component 2 } - index: 2So, if you try to move "Component 1" at index 0 or 1, nothing will happen. If you need to move it below "Component 2" you have to indicate index 2
But I don't understand the use case there. Usually at should account for index in the last versions. How to move a component from 0 to index 1 then?
Thanks for reporting this, @krishnaeverestengineering.
The issue with Move method is not working as expected 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 #5503
replaceWith method doesn't have string type
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome Reproducible demo link none Describ...
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 #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 #4285
[Component's toolbar] Toolbar width not resizing correctly
GrapesJS version[X] I confirm to use the latest version of GrapesJSWhat browser are you using? Chrome v100.0.4896.127Reproducible demo link...
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
How to Build a Production GrapesJS Editor: The Complete Walkthrough of Brief, Preset, Plugins, and Services
A complete walkthrough of building a production GrapesJS editor: how to choose a preset, pick plugins, and scope setup services without burning a sprint.
Tutorial
Embed GrapesJS in Your SaaS: A Weekend Guide
Embed GrapesJS in your SaaS and ship a white-label page builder over a weekend. Honest tradeoffs, real code, and the plugins that close the UX gap.
Tutorial
Big Updates: TinyMCE 8 and Placeholder 2.0 for GrapesJS
In May we shipped major updates to two of our most popular GrapesJS plugins β TinyMCE Inline Text Editor and Placeholder.
Browse Plugin Categories
Jump directly to plugin category pages on the marketplace.