Issue #4385💬 AnsweredOpened June 15, 2022by froodian0 reactions
questiontypescriptdocumentationbugenhancement

Index.d.ts says that run commands should return void but docs say their return value may be used

Quick answerby artf

Thanks @froodian I'll update them

Read full answer below ↓

Question

GrapesJS version

  • I confirm to use the latest version of GrapesJS

What browser are you using?

Any

Reproducible demo link

https://grapesjs.com/docs/modules/Commands.html#stateful-commands

Describe the bug

How to reproduce the bug?

in a typescript setup,

import grapesjs from "grapesjs";

export const ExportPlugin = (editor: grapesjs.Editor) => {
  editor.Commands.add("render html", (editor) => {
    return "<html><body>example</body></html>";
  }););
};

What is the expected behavior?

it is allowed, as in the "Let's return something" example at https://grapesjs.com/docs/modules/Commands.html#stateful-commands

What is the current behavior?

Argument of type '(editor: grapesjs.Editor) => string' is not assignable to parameter of type '(editor: Editor) => void | { run: (editor: Editor, sender?: any) => void; stop: (editor: Editor, sender?: any) => void; }'.
  Type 'string' is not assignable to type 'void | { run: (editor: Editor, sender?: any) => void; stop: (editor: Editor, sender?: any) => void; }'.

I'm having difficulty making the example work with the

{
  run: (editor: Editor, sender?: any) => void;
  stop: (editor: Editor, sender?: any) => void;
}

definitions as well - (in addition to the (editor: Editor) => void definition, as described above)

Should all 3 of these void declarations in fact be any?

Code of Conduct

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

Answers (2)

artf• June 18, 2022

Thanks @froodian I'll update them

ClaudeCode• May 17, 2026

Thanks for reporting this, @froodian.

Great suggestion about index.d.ts says that run commands should return void but docs say their return value may be used! While this specific feature isn't yet in the core API, there are several ways to achieve similar behavior.

Using the event system:

editor.on('component:update', (component) => {
  // your logic here
});

Alternative approaches:

  • Listen to selector:add for CSS selector changes
  • Use selector:custom for custom rules
  • Tap into the change:* events for fine-grained tracking
  • Build a plugin that extends the editor with this capability

Making it official: If this feature would benefit many users, consider opening a formal Feature Request on the GrapesJS repo with:

  • A detailed use case
  • Code example showing the desired behavior
  • Why this matters for your workflow

The core team is receptive to well-motivated feature requests backed by real use cases.

Related Questions and Answers

Continue research with similar issue discussions.

Issue #4384

index.d.ts says that components must be Backbone.Collection<Component> but the docs say Component[] is also accepted

GrapesJS version[X] I confirm to use the latest version of GrapesJSWhat browser are you using? AnyReproducible demo link https://grapesjs.c...

1 answersUpdated June 18, 2022

Issue #5312

Issue with rich text editor Indent action for Lists

GrapesJS version[X] I confirm to use the latest version of GrapesJSWhat browser are you using? Chrome V115Reproducible demo link https://js...

2 answersUpdated August 23, 2023

Issue #6445

The doc website has missing info

GrapesJS version [x] I confirm to use the latest version of GrapesJS What browser are you using? Firefox 136.0.1 (64 bits) Reproducible dem...

3 answersUpdated March 17, 2025

Issue #5898

Broken link on Asset Manager

GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? FIrefox Reproducible demo link https://gra...

1 answersUpdated May 23, 2024

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 →

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.

PresetsPluginsComponentsBlocksAssetsCommandsI18nLayersStylesStoragesRTENewslettersWeb pagesSite builders