Documentation/Tutorial for Creating a Custom Editor

[jdorn]

No description provided.

[tedx]

+1
I like the concept and I'd like to take a shot at a custom editor but I could use a tutorial or better documentation.

[jdorn]

I've started filling out the wiki (https://github.com/jdorn/json-editor/wiki) with more in-depth documentation. I haven't documented custom editors yet, but the notes on overall code structure may still be helpful.

[SebT]

+1
I have a pretty annoying problem with a (simple) custom editor. It doesn't work great with validate and getValue on the global form object.

I update the this.value variable of the editor correctly (use console.log to make sure) when the user fills the form, yet when I use one of the two functions mentioned above, the value for the editor is null or undefined.
BUT if the users changes another value on the form that uses a default editor, the next getValueor validate call will return the right value for my custom editor.

I have noticed in default editors code that you often use this portion of code:

this.jsoneditor.notifyWatchers(this.path);
if(this.parent) this.parent.onChildEditorChange(this);
else this.jsoneditor.onChange();

So I tried it and it worked. The problem is that if my schema has an array with the items schema set to a custom editor, it generates an error on the editor of the first item of the table, whereas there is no first item.

I don't know if I explained my problem correctly, but my final question is:

[TL:DR] How to update a custom editor's value correctly ?

Edit: I replaced the problematic code above with

if(this.jsoneditor) {
  this.jsoneditor.notifyWatchers(this.path);
  if(this.parent) this.parent.onChildEditorChange(this);
  else this.jsoneditor.onChange();
}

and it seems to work fine now.

[JogoShugh]

@SebT thank you so much!!!

[jdorn]

I started documenting the editor class in the wiki - https://github.com/jdorn/json-editor/wiki#editor-srceditorjs

The solution @SebT has is slightly out of date. It should be replaced with just this.onChange(true). I recommend reading through the wiki which goes through the major editor methods and what is supposed to happen in each.