Editor.Css.setRule API not working as expected, it is not updating the rule existing rule.
Hi @FaisalShaikhHA this is expected behaviour but I guess the documentation of setRule is a bit misleading. The rule is actually updated (it doesn't create a new one with the same selector) but styles are simply replaced. This is what you should do if you need to add new styles instead of replacing them I guess I can...
Read full answer below βQuestion
GrapesJS version
- I confirm to use the latest version of GrapesJS
What browser are you using?
Version 112.0.5615.137 (Official Build) (arm64)
Reproducible demo link
https://jsfiddle.net/yhj6qa1u/6/
Describe the bug
How to reproduce the bug?
- Select a component and add some style using Style Manager.
- Use
editor.Css.setRuleto set some style for that particular component, notice the previous styles are removed but as per the documentation it should update the CSS rule.
What is the expected behavior? It should update the existing rule.
What is the current behavior? It removes the existing rule rather than updating the existing rule.
https://github.com/GrapesJS/grapesjs/assets/102785785/28560d08-156a-46da-b901-3aec0636a62a
Code of Conduct
- I agree to follow this project's Code of Conduct
Answers (3)
Hi @FaisalShaikhHA this is expected behaviour but I guess the documentation of setRule is a bit misleading. The rule is actually updated (it doesn't create a new one with the same selector) but styles are simply replaced.
This is what you should do if you need to add new styles instead of replacing them
const selector = `#${this.getId()}`;
const rule = editor.Css.getRule(selector);
editor.Css.setRule(selector, {
...rule?.getStyle(),
background: 'black'
});
I guess I can add a new addStyles?: boolean option to handle similar use cases.
Thanks @artf for the clarification
Thanks for reporting this, @FaisalShaikhHA.
Great question about editor.Css.setRule API not working as expected, it is not updating the rule existing rule.. The recommended approach with StyleManager 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 #6458
sector.setName doesn't work
GrapesJS version [x] I confirm to use the latest version of GrapesJS What browser are you using? Chrome Reproducible demo link https://jsfi...
Issue #5460
Loading `component` and `styles` from `pageManager`
GrapesJS version[X] I confirm to use the latest version of GrapesJSWhat browser are you using? Chrome v117.0.5938.149Reproducible demo link...
Issue #4356
selector:remove event does not exist
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome 101 Reproducible demo link https://...
Issue #5982
Component styles such as md:flex-row(tailwind) are removed
GrapesJS version[x] I confirm to use the latest version of GrapesJSWhat browser are you using? Chrome 126.0.6478.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 βBrowse Plugin Categories
Jump directly to plugin category pages on the marketplace.