Use arrow keys to move blocks in canvas configured in absolute positioning mode
No, unfortunately, for such a case, the custom keymap would be the only solution. You should just get the selected component and update its style.
Read full answer below ↓Question
Hi, I am building a solution for students to tell their high school experiences as slides built from grapejs editor (similar to canva), and have configured the editor in 'absolute' mode, which works wonderfully. However I can't seem to find a way to move the dropped block in the editor with the arrow keys. I am aware that custom keymap binding and will look into adding that functionality, but just want to see if I have missed something, and if there are other better options.
Answers (4)
No, unfortunately, for such a case, the custom keymap would be the only solution. You should just get the selected component and update its style.
I have found a working solution for this as follows:
grapesjs.init({
keymaps: {
defaults: {
"ns:up" : { keys: 'up, shift+up', handler: 'moveUp' },
"ns:down" : { keys: 'down, shift+down', handler: 'moveDown' },
"ns:left" : { keys: 'left, shift+left', handler: 'moveLeft' },
"ns:right" : { keys: 'right, shift+right', handler: 'moveRight' }
}
},
...
The commands are being added as follows:
editor.Commands.add("moveUp", { run: function(editor) { moveSelectedElement(editor, -5, "top"); }});
editor.Commands.add("moveDown", { run: function(editor) { moveSelectedElement(editor, 5, "top")}});
editor.Commands.add("moveLeft", { run: function(editor) { moveSelectedElement(editor, -5, "left")}});
editor.Commands.add("moveRight", { run: function(editor) { moveSelectedElement(editor, 5, "left")}});
The moveSelectedElements method just does the following:
function moveSelectedElement(editor, pixel, property) {
var model = editor.getSelected();
var style = model.getStyle();
var position = style[property].replace('px','').replace(' ', '');
// Round to nearest multiple of 5 to align to grid
var newPosition = Math.ceil((Number(position)+Number(pixel))/5)*5
style[property] = newPosition + "px";
model.setStyle(style);
editor.trigger('component:toggled');
}
However, when moving the elements with arrow keys, the canvas scrolls as well, which is the default bowser behaviour.
How can we prevent the default propagation with the keymaps (e.preventDefault())? Should this be happening automatically, or is there a way to configure that?
keymaps.add('ns:my-keymap', '⌘+s, ctrl+s', 'some-gjs-command', { // Prevent the default browser action prevent: true, });
Thanks for reporting this, @wfcheng.
Great question about Question: Use arrow keys to move blocks in canvas configured in absolute positioning mode. 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 #4192
Drag boundary issue with dragMode: absolute/translate
GrapesJS version [X] I confirm to use the latest version of GrapesJS What browser are you using? chrome, firefox Reproducible demo link htt...
Issue #6695
Prevent default not working for edge
GrapesJS version [x] I confirm to use the latest version of GrapesJS What browser are you using? Edge 144.0.3719.92 Reproducible demo link...
Issue #6669
Cross-level reordering of blocks in Layer Manager causes Sorter errors and breaks further move attempts
GrapesJS version [x] I confirm to use the latest version of GrapesJS What browser are you using? Chrome Reproducible demo link https://grap...
Issue #6409
Cannot drag to move components on mobile
GrapesJS version [x] I confirm to use the latest version of GrapesJS What browser are you using? Chrome v133 Reproducible demo link https:/...
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.