Layer labels
You can extend the model of your component/s and overwrite the getName function
Read full answer below ↓Question
@artf I am loving working with GJS. I have one last thing I'd love your help on.
It would be incredibly helpful to be able to customise the labels in the layer manager. I've searched high and low but not found anything.
The default way it just shows Text and Box is not very helpful when wanting to navigate efficiently.
I would really like to be able to customise these myself. In my case, I'd like to show the tagname and the id.
Many thanks
Answers (4)
You can extend the model of your component/s and overwrite the getName function
In case this is useful for anyone, I found an easy/alternative way of doing this when a component is created.
editor.on('component:create', function(component) {
// filter the tag types you're interested in
if( component.attributes.tagName === 'div' ) {
// Get some information you want to use as the replacement text
// In my case, the component element's id attribute, which is stored in component.ccid
const idParts = component.ccid.split('-')
if( idParts.length > 0 && idParts[0] === 'cbt') {
// This is specific to my case, but 'component.attributes.name' is the field that appears in the layer manager
component.attributes.name = ''
for( let i=1; i < idParts.length; i++ ) {
component.attributes.name += idParts[i].charAt(0).toUpperCase() + idParts[i].slice(1) + ' '
}
}
else {
component.attributes.name = 'Div'
}
}
})
This is how I did it:
grapesInstance.on('component:create', (component) => {
component.getName = () => component.attributes['custom-name'] || `${component.attributes.tagName}#${component.ccid}`;
});
The benefit is that if the components id or tag change later it will still be updated in the layer manager and you can also rename individual components.
Thanks for reporting this, @fmay.
Great question about Question : Layer labels. 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 #3600
[Question]: Event listener to visibility(eye) icon in the Layer Manager
I would like to listen to the eye icon in the layer manager from the editor, based on which, I need to write the custom styles. Is there an...
Issue #3367
Modal template
Is there a way for me to modify the template from a compiled state? https://github.com/artf/grapesjs/blob/d3256e621bb43a537213ffcd86b10dc0b...
Issue #3721
Test drag and drop with Cypress
Hi @artf. I would like to run some test scenarios on GrapesJs using Cypress tool. However i am unable to simulate drag and drop mode using...
Issue #3365
contenteditable attribute on Layer's name span
Hi @artf I would like to know why layer's name span has a contenteditable attribute. There is no mechanism implemented on grapesJs to reall...
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.