Clicking 'wrap for style' button affects the inner components of other components inside the same text box
RTE relies on the DOM content during the editing so if you remove it deliberately with something like inner components will be removed once the editing is finished.
Read full answer below ↓Question
GrapesJS version
- I confirm to use the latest version of GrapesJS
What browser are you using?
Chrome 104.0.5112.101
Reproducible demo link
https://jsfiddle.net/7cLr0xt2/3/
Describe the bug
How to reproduce the bug?
For some reason I'm unable to reproduce the bug inside the fiddle linked above, since line 34 selectedComponent.components('<span liquid="if contact.id">jhbjhhgjjh</span> <span liquid="else">qwewqeqwe</span>') doesn't replace the inner components of the component, so I'll have to share a video of what happens with my project instead, but the steps are as follows:
- Double click on the
Hello World!!!text box and select the word 'World' - Click on the paintbrush button in the RTE editor to wrap that word for styling
- Click the circled 'if' button on the far left of the component toolbar and click 'ok' on the dialog that pops up to convert this to a 'conditional-text' component
- Double click on the newly created
Open conditionals to choosecomponent (normally this would bring up a dialog but I've simplified for the sake of this bug, so now it just applies some dummy information to the component, including adding an attribute and changing the inner components of the component. Changing the inner components doesn't work in this fiddle though, not sure why) - Click the 'view code' button to see the changes that this has made to the code - as you can see it has inserted the attribute
liquidtag="if", but the inner components do not appear. In my project, the inner components of this span would be<span liquid="if contact.id">jhbjhhgjjh</span> <span liquid="else">qwewqeqwe</span> - Close the 'view code' dialog and double click the word
Helloto select it - Click the paintbrush button in the RTE editor to wrap that word for styling
- Click the 'view code' button again - in my project, the inner components ( i.e.
<span liquid="if contact.id">jhbjhhgjjh</span> <span liquid="else">qwewqeqwe</span>) of the first component that we created in step (4) now disappear (the attributes remain though)
What is the expected behavior? Wrapping a word for styling shouldn't change the inner components of other components in that div. Presumably this is because of the way that 'wrap for style' works - perhaps it sets the inner HTML of that component to the same as the inner HTML of the component's view?
What is the current behavior?
The inner components <span liquid="if contact.id">jhbjhhgjjh</span> <span liquid="else">qwewqeqwe</span> set in step 5 disappear and are replaced with the 'displayedText' property when another word in the original text box is wrapped for styling. I'm thinking it could be something to do with lines 85 - 87 in the fiddle, but as far as I understand this should only affect the view and therefore how it appears inside the canvas, not the underlying HTML of the component.
Here is a video showing what happens in my project:
Code of Conduct
- I agree to follow this project's Code of Conduct
Answers (4)
RTE relies on the DOM content during the editing so if you remove it deliberately with something like
onRender() {
this.el.innerHTML = this.model.get("displayedText")
},
inner components will be removed once the editing is finished.
Ok thanks @artf, that makes sense.
However, those lines of code, along with
init() {
this.listenTo(this.model, "change:displayedText", this.render)
},
are required to render the correct selected state inside the canvas as follows (both upon the component initially being rendered and when the user selects a different 'if' state, thus changing displayedText):
Can you think of a way to retain the inner components after editing via RTE? Perhaps I could store these inner components inside a property of the conditional-text component itself and assign these during onRender() also? If that's possible, how can I set the component's components property within the onRender() hook?
Thanks for your help!
I need to do some more testing but it looks like I've got around this behaviour by saving the inner components inside the component itself when first creating it / editing it, then using the rte:disable hook as follows:
editor.on('rte:disable', () => {
const conditionalComponents = (editor.getSelected().components().filter((component) => {
return component.attributes.type == 'conditional-text'
}))
conditionalComponents.forEach((component) => {
component.components(component.attributes.conditionCode)
})
});
It seems a bit hacky so if you can think of a better way then please let me know.
Thanks for reporting this, @benryanwilliams.
Great question about Clicking 'wrap for style' button affects the inner components of other components inside the same text box. The recommended approach with ProseMirror is to use the event-driven API.
Start here:
- Check the GrapesJS documentation for your specific module
- Look for the
on()event listener method - Most operations can be achieved by listening to editor and component events
Common patterns:
// Listen for changes
editor.on('change', () => console.log('something changed'));
// Component lifecycle
editor.on('component:mount', (c) => console.log('component ready', c));
editor.on('component:update', (c) => console.log('component updated', c));
If you're still stuck:
- Share a minimal CodeSandbox reproduction
- Include what you've already tried
- Mention your GrapesJS version
- The community is here to help!
Related Questions and Answers
Continue research with similar issue discussions.
Issue #6706
TypeError: e.getRoot is not a function (Race condition in Style Manager)
GrapesJS version [x] I confirm to use the latest version of GrapesJS What browser are you using? All browsers (Chrome, Safari, Firefox, Edg...
Issue #5086
Style:property:update and Property onChange trigger excessively
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome Version 112.0.5615.137 (Official Bu...
Issue #5990
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 #4350
Style Manager don't update background when component is selected
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Brave Browser V1.39.111 Reproducible demo...
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
Find the Right GrapesJS Plugin in Seconds: Smarter Discovery Is Live
We're shipping a set of discovery upgrades. New label filters, a proper compatibility switch for GrapesJS vs Studio, one-click and a smarter sort bar.
Tutorial
GrapesJS vs Webflow vs Tilda: What to Choose for Your Business in 2026
Choosing the right website platform in 2026 is no longer just about building a site
Tutorial
GJS Market 2.0 - Donations, Tracking, Labels and Better Product Discovery
We’ve rolled out a new set of GrapesJS marketplace updates across GJS Market, focused on improving how creators distribute products
Browse Plugin Categories
Jump directly to plugin category pages on the marketplace.