`getDirtyCount()` returns `1` after loading
Hi @padcom this is an expected behavior as the load itself updates the state of the editor. You can simply clear the dirty counter via editor.clearDirtyCount() right after your manual load.
Read full answer below βQuestion
GrapesJS version
- I confirm to use the latest version of GrapesJS
What browser are you using?
Chrome latest
Reproducible demo link
https://github.com/padcom/grapes-bug-dirty-after-loading/blob/master/src/App.vue#L37
Describe the bug
- Clone and start the project
git clone https://github.com/padcom/grapes-bug-dirty-after-loading
cd grapes-bug-dirty-after-loading
npm i
npm start
- Open console
Current behavior: number of changes is 1 Expected behavior: number of changes is 0
Additional note: when using autoload number of changes stays at 0
Code of Conduct
- I agree to follow this project's Code of Conduct
Answers (4)
Hi @padcom this is an expected behavior as the load itself updates the state of the editor.
You can simply clear the dirty counter via editor.clearDirtyCount() right after your manual load.
Please note, that if you enable autoload:
storageManager: {
type: 'example',
autoload: true,
autosave: false,
},
and disable loading:
// console.log('App.vue - before load', editor.getDirtyCount())
// const result = await editor.load({})
// console.log('App.vue - after load', editor.getDirtyCount(), result)
number of changes is 0, even though the result is the same - the page is loaded. Since in my project I desperately need to be able to load the page at a specific time this is messing everything up. I also tried clearing the number of changes after loading, but since the code that sets it does so in a setTimeout() callback it's not possible to do it deterministically.
I beg your pardon? Are you quite serious that it is the "expected" behavior? Have you seen that in any other editor out there that the project is automatically modified upon loading and then automatically saved? I find that hard to believe.
Thanks for reporting this, @padcom.
The issue with getDirtyCount() returns 1 after loading 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 #5385
getDirtyCount() non deterministic after load
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome Reproducible demo link https://gith...
Issue #3860
blocks not working after upgrading from 0.16.27 to 0.17.27
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Firefox 93.0, Chrome 94.0.4606.71 Reproduc...
Issue #5442
After applying the text color not able to set the background color
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? chrome Reproducible demo link https://jsfi...
Issue #4006
Background color automatically changes to black
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome Reproducible demo link https://grap...
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
GrapesJS Inline RTE Plugins Update: CKEditor 5 v0.1.4 and Froala Inline Text Editor
CKEditor 5 Inline for GrapesJS v0.1.4 fixes Studio SDK toolbar clipping, iframe injection and link balloon bugs. Compare with Froala Inline β both $69.
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.
Browse Plugin Categories
Jump directly to plugin category pages on the marketplace.