Lists not working with default RTE
I've tried to find a fix for this but failing. Problem occurs with: onKeydown(event) { if (event.key === 'Enter') { this.doc.execCommand('insertLineBreak'); event.preventDefault(); } } Which, when creating a list is not the desired behaviour. Only thing I can think of is adding another property to the RichTextEditor c...
Read full answer below ↓Question
GrapesJS version
- I confirm to use the latest version of GrapesJS
What browser are you using?
Chrome Version 102.0.5005.115 (Official Build) (64-bit)
Reproducible demo link
https://jsfiddle.net/6Ldn124x/3/
Describe the bug
How to reproduce the bug?
- Click on text block to open RTE
- Try and add a list
What is the expected behavior? Lists work
What is the current behavior? Lists do not work
I've been trying to track down the exact issue all day. Between v0.18.2 > v0.18.3 and the issue stems from changes made in src/RichTextEditor/model/RichTextEditor.js but I'm struggling to pin it down for a PR.
Anyone more knowledgeable know what's going on?
All the best
Code of Conduct
- I agree to follow this project's Code of Conduct
Answers (4)
I've tried to find a fix for this but failing.
Problem occurs with:
__onKeydown(event) {
if (event.key === 'Enter') {
this.doc.execCommand('insertLineBreak');
event.preventDefault();
}
}
Which, when creating a list is not the desired behaviour. Only thing I can think of is adding another property to the RichTextEditor class that holds the current action in use, something like:
syncActions() {
this.getActions().forEach(action => {
if (this.actionbar) {
if (!action.state || (action.state && action.state(this, this.doc) >= 0)) {
const event = action.event || 'click';
action.btn[`on${event}`] = e => {
// add action
this.currentAction = action
action.result(this, action);
this.updateActiveActions();
};
}
}
});
}
__onKeydown(event) {
// check the property for something that we can use to determine if to insert line break
if (event.key === 'Enter' && this.currentAction !== "something??") {
this.doc.execCommand('insertLineBreak');
event.preventDefault();
}
}
But then, what could be used in that conditional?I'm not sure yet about the best long-term solution but as a workaround, we can prevent that condition but checking the active state of insertOrderedList/insertUnorderedList. I'll take care of it for the next release.
Where to find other commands like "insertUnorderedList"?
Thanks for reporting this, @skru.
Great question about Lists not working with default RTE. 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 #4440
Extending text component breaks textable blocks
GrapesJS version[X] I confirm to use the latest version of GrapesJSWhat browser are you using? Version 102.0.5005.115 (Official Build) (64-...
Issue #4473
v0.19.5 Breaks headless editor.setComponents(): "Uncaught (in promise) ReferenceError: window is not defined"
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome 102.0.5005.115 (Official Build) (64...
Issue #4752
Component with pointer-events: 'all' (except wrapper) or editable component are draggable & droppable to itself.
GrapesJS version[X] I confirm to use the latest version of GrapesJSWhat browser are you using? Chrome 107.0.5304.121 (Official Build) (arm6...
Issue #4401
resizer does not work with touch - draggable attribute not set on handlers
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome Version 102.0.5005.115 (Official Bu...
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.