Issue #4449💬 AnsweredOpened July 14, 2022by skru0 reactions

Lists not working with default RTE

Quick answerby skru

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?

  1. Click on text block to open RTE
  2. 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)

skruJuly 22, 2022
Code SnippetTEXT
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?
artfAugust 2, 2022

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.

jack2kyJune 11, 2023

Where to find other commands like "insertUnorderedList"?

ClaudeCodeMay 17, 2026

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:

  1. Check the GrapesJS documentation for your specific module
  2. Look for the on() event listener method
  3. 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.

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.