Issue #5131πŸ’¬ AnsweredOpened May 20, 2023by sdimitrenco0 reactions

After JSON.stringify Components have not all fields

Quick answerby artf

If the property is of the same value as the default definition, it's skipped. This is controlled by avoidDefaults config option and it's highly recommended to keep it true to have small JSONs as possible.

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://jsfiddle.net/sdimitrenco/rn8u4pc0/7/

Describe the bug

I'm not sure it's a bug or not, but for me, behavior look strange

I have a component List that includes, component ol and component li.

That code for block

{
      id: 'list',
      label: 'List',
      category: 'Typography',
      media: `<svg ....
              </svg>
              `,
      content: {
        type: 'list'
      }

That model for the component list

grapes.DomComponents.addType('list', {
        model: {
          defaults: {
            type: "list",
            tagName: 'div',
            editable: true,
            droppable: false,
            components: [
              {
                type: "ol",
                tagName: 'ol',
                droppable: false,
              }
            ]
          }
        }
      })

That model for the ol component

grapes.DomComponents.addType('ol', {
        model: {
          defaults: {
            type: "ol",
            tagName: 'ol',
            components: [
              {
                type: 'li',
            tagName: 'li',
              }
            ]
          }
        }
      })

And the model for the li component

grapes.DomComponents.addType('li', {
        model: {
          defaults: {
            type: 'li',
            tagName: 'li',
            droppable: true,
            attributes: {},
            toolbar: [
              // these are the default toolbar elements
              {
                attributes: {class: 'fas fa-list-ul'},
                command: 'change-style-list'
              },
              {
                attributes: {class: 'fa fa-arrow-up'},
                command: 'select-parent'
              },
              {
                attributes: {class: 'fas fa-arrows-alt'},
                command: 'tlb-move'
              },
              {
                attributes: {
                  class: 'far fa-clone',
                },
                command: 'tlb-clone',
              },
              {
                attributes: {class: 'fa fa-trash'},
                command: 'tlb-delete'
              }
            ],
            components: [
              {
                tagName: "span",
                droppable: false,
                type: "text",
                components: [
                  {
                    type: "textnode",
                    content: "Type your text"
                  }
                ]
              }
            ]
          }
        }
      })

As you can see all models include types and tag Names, and inside grapes it work correct, but if I try convert it to json, like JSON.stringify(this.grapesInstance.getComponents()) I have json where missed all field with tagName, and it will looks like that

[
  {
    "type": "list",
    "components": [
      {
        "type": "ol",
        "droppable": false,
        "components": [
          {
            "type": "li",
            "components": [
              {
                "tagName": "span",
                "type": "text",
                "components": [
                  {
                    "type": "textnode",
                    "content": "Type your text"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
]

I can't catch why it "tagName" lost. If I delete the custom type, the "tagName" serialized to json. I can't understand this rule.

Code of Conduct

  • I agree to follow this project's Code of Conduct

Answers (2)

artfβ€’ May 22, 2023

If the property is of the same value as the default definition, it's skipped. This is controlled by avoidDefaults config option and it's highly recommended to keep it true to have small JSONs as possible.

ClaudeCodeβ€’ May 17, 2026

Thanks for reporting this, @sdimitrenco.

The issue with After JSON.stringify Components have not all fields 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:

  1. Add a setTimeout wrapper to ensure the DOM has settled:
setTimeout(() => {
  // your operation here
}, 0);
  1. Check initialization order β€” make sure components are fully loaded before you interact with them

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

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

Free option

Check the open-source GrapesJS plugins on GitHub or run a quick search in our free catalog.

Browse free plugins β†’
Premium option

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.

All tutorials β†’

Browse Plugin Categories

Jump directly to plugin category pages on the marketplace.