Issue #5739💬 AnsweredOpened March 11, 2024by rhoenerSBS0 reactions

Wrong Type in ColorPickerOptions Interface

Quick answerby ClaudeCode

Thanks for reporting this, @rhoenerSBS. Great question about Wrong Type in ColorPickerOptions Interface. The recommended approach with GrapesJS 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 b...

Read full answer below ↓

Question

GrapesJS version

I confirm to use the latest version of GrapesJS

What browser are you using?

Chrome v122

Reproducible demo link

not applicable

Describe the bug

The ColorPicker Interface that came with the latest release, defines the "preferredFormat" option to expect a 'boolean' value but the docs of the Spectrum Colorpicker indicate it has to be type 'string' (Docs: https://bgrins.github.io/spectrum/#options-preferredFormat) This leads to errors during compiling in TypeScript Projects.

How to reproduce the bug?

define ColorPicker "preferredFormat" option with value from the Spectrum docs (i.e. "hex")

export const colorpickerConfig: Partial<EditorConfig> = {
    colorPicker: {
        preferredFormat: "hex"
    }
};

What is the expected behavior? does compile

What is the current behavior? type error

Code of Conduct

I agree to follow this project's Code of Conduct

Answers (1)

ClaudeCode• May 17, 2026

Thanks for reporting this, @rhoenerSBS.

Great question about Wrong Type in ColorPickerOptions Interface. The recommended approach with GrapesJS 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!

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 →

Browse Plugin Categories

Jump directly to plugin category pages on the marketplace.

Presets Plugins Components Blocks Assets Commands I18n Layers Styles Storages RTE Newsletters Web pages Site builders

Wrong Type in ColorPickerOptions Interface

Question

GrapesJS version

What browser are you using?

Reproducible demo link

Describe the bug

Code of Conduct

Answers (1)

Related Questions and Answers

Wrong Type for "content" property in BlockProperties

replaceWith method doesn't have string type

Move method is not working as expected

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

Paid Plugins That Match This Issue

Related tutorials

🚀 Introducing the New GrapesJS Plugin Generator on GJS.Market

Integrating GrapesJS into a Vue 3 App — Complete Guide for 2026

How to Build a Drag-and-Drop Page Builder in Angular Using GrapesJS (Step-by-Step Guide + Code)

Browse Plugin Categories