Over a million developers have joined DZone.

ExtJS5—Codemirror Integration

DZone's Guide to

ExtJS5—Codemirror Integration

· Web Dev Zone ·
Free Resource

Jumpstart your Angular applications with Indigo.Design, a unified platform for visual design, UX prototyping, code generation, and app development.

Being one of the leading frameworks for RIA, I was expecting ExtJS 5 to have an inbuilt code editor. There are some add-ons available for ExtJS3 and ExtJS4 by extending the form field base so that they can make it in par with form. But it is more restricted using in that way. We need to compromise with the layout if you are not using it on any other component. Instead we can use a simple hack to make it work seamlessly on any ExtJS components.

Since code mirror requires div or textarea, we can make use of ExtJS' 'box' to get handle of div. Next level complexity comes with form support and layouting. Here is the idea

  • Create a custom component by extending container of panel(As per requirement)
  • Use codemirror's configs as configs of custom component
  • Add following components as items
    • box : Since it provides a div, we can use it to render code mirror component
    • field: Add this item to your custom component and make it hidden. Replicate all the changes/actions on this field component whenever there are changes/actions on the codemirror. 
  • Initialize codemiror field 'afterrender' of custom component with the configs that are defined on it. 
Form Support

ExtJS form comes with the additional properties like dirty change, load/get/update Record features  so that we can load the model into the form and work with it. Whenever we add our custom component to form, form will be able to identify the field item which is the part of our custom component. Since ExtJS form fires every action on our field, we can get the handle form actions. 

For example if there is a change event on code mirror, we will be able to find out whether its a dirty or not but how can we tell form that it is dirty? Thats where we bring our field into action. Call  setDirty function of field and fire dirty change event from that. Rest will be taken care by form. Sam e applies with the other actions. 

Layout Support

Since it is our custom component, we don't need to worry much. 

Controlling Size

Code mirror has a pre-configured height(300) in its css and there is a method to set custom height and width. We can pass these values as configs to our custom component and call setSize method of codemirror. 

I have tried a custom component with remote validation features. You can find source code at the following location. This is just a prototype code to show how we can make codemirror work with ExtJS without affecting much from its version changes. You can take the idea and customize it as per your needs.

Take a look at an Indigo.Design sample application to learn more about how apps are created with design to code software.


Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}