Extending preview command
If you specify a new run() function the command will run only the new one, otherwise, it wouldn't be possible to fully change a command (here more about extending commands)
Read full answer below ↓Question
I am trying to extend the preview command. I expected the code below to run the normal preview command along with console output, but only console statement runs. How can I preserve the original preview code?
editor.Commands.extend('preview', {
run() {
console.log("foo");
}
});
The below works for me until someone can enlighten where my thought process went wrong.
editor.Commands.add('preview-ext', {
run(e) {
e.runCommand('preview');
console.log("foo");
}
});
Answers (4)
If you specify a new run() function the command will run only the new one, otherwise, it wouldn't be possible to fully change a command (here more about extending commands)
Hello Artf, oddly enough, i need the same thing he does.
So, the best way to do is doing the same way he does? Running the original preview command inside the extended preview?
Well...
Other thing i'm doing is extending the preview by running the command on event.:
editor.on("run:preview",()=>{console.log("run-preview")});
editor.on("stop:preview",()=>{console.log("stop-preview")});
Thanks for reporting this, @kerryj89.
Great question about Extending preview command. 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!
Related Questions and Answers
Continue research with similar issue discussions.
Issue #3444
removeButton() causing error
Hi, I'm trying to remove a button from panel using this code editor.Panels.removeButton('options', 'fullscreen') . It removes the button bu...
Issue #4289
"storage:start:load" event is not being trigged
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? Chrome latest Reproducible demo link Bind...
Issue #4273
How to trigger the 'Import Template (modal)' on page load
Hello, Please i'm in need of the logic on how to the import template modal on initialization of the page... I'm using the newsletter preset...
Issue #3237
Add Trait For wrapper
Hi @artf I've added trait for wrapper this way. How can I perform the init function for the same Here is the code @artf Could you please he...
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
How to Build a Production GrapesJS Editor: The Complete Walkthrough of Brief, Preset, Plugins, and Services
A complete walkthrough of building a production GrapesJS editor: how to choose a preset, pick plugins, and scope setup services without burning a sprint.
Tutorial
Big Updates: TinyMCE 8 and Placeholder 2.0 for GrapesJS
In May we shipped major updates to two of our most popular GrapesJS plugins — TinyMCE Inline Text Editor and Placeholder.
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.
Browse Plugin Categories
Jump directly to plugin category pages on the marketplace.