JSONMEdit: A JavaScript repository from MoritzWillig

#JSON M Edit A minimalistic JSON Editor.

#Building & Include Clone the repo into a public accessible directory (marked as {$PATH} in the code below).

##Include to a web page JSONMEdit is build with the Closure Compiler to create a single code file which can be included. cd to resources/closureCompiler and run the closureCompiler.sh to generate a minified version of JSONMEdit. The minified file is then placed under libs/JSONMedit.js and can be included as follows:

<!-- if you already include query you can skip this include -->
<script src="{$PATH}/libs/jQuery_v1.11.1.js"></script>

<!-- include JSONMEdit -->
<script src="{$PATH}/libs/JSONMedit.js"></script>
<link rel="stylesheet" type="text/css" href="{$PATH}/resources/css/jsonEditor.css">

##Debugging & Developement For debugging or developing include the uncompressed code into your html:

<!-- if you already include query you can skip this include -->
<script src="{$PATH}/libs/jQuery_v1.11.1.js"></script>

<!-- include code -->
<script src="{$PATH}/src/interfaces/Interface.js"></script>
<script src="{$PATH}/src/interfaces/IEventHandler.js"></script>
...

<!-- include css -->
<link rel="stylesheet" type="text/css" href="{$PATH}/resources/css/jsonEditor.css">

The full list and order of necessary code files to include can be found under resources/closureCompiler/closureCompiler.sh

##Generating documentation Documentation is generated with JSDoc. Change to docu/ and run docu/jsDocGen.sh to create a new documentation of the code.

#Usage Every Editor included implements the IEditor interface and therefore can be used on its own to edit their specific JSON type.

##Dynamic JSON Editor

The JSONDynamicNode-Editor dynamically chooses the right Editor for the JSON value given. Be carefull when passing arbitrary objects (especially if not parsed from JSON strings) and make sure to only pass objects with non circular references. No check for circlular references is done and therefore the application will loop infinitely if such an object is passed as a parameter.

##Editor Providers

For simple selection by json names the DefaultJSONEditorProvider can be used. A self implemented version of the IEditorProvider also provides a way of controlling sub editors if you wish to replace e.g. the boolean editor, of a JSONDynamicNode-Editor.

var provider=new DefaultJSONEditorProvider();

/* create a dynamic json editor. See the documentation for other accepted
 * constants ("string", "number", "array", etc.)
 */
var editor=provider.requestEditor("json");

//set value
//editor.setValue([1,2,3,4]);

//attach editor to your gui
//editor.getDom().attachTo(some jquery node);

...

//if the editor is not needed anymore
provider.disposeEditor(editor);

##JSON Strings

For JSON strings the JSONEditor can be used. It parses the JSON string and displays it in a JSONDynamicNode (for non valid JSON string a fallback to text mode is done).

var provider=new DefaultJSONEditorProvider();

//create a json editor which can handle json strings
editor=new JSONEditor(undefined,provider);

//set value
//editor.setValue("{\"helloWorld\":[1,2,3,4]}");

//attach editor to your gui
//editor.getDom().attachTo(some jquery node);

...

//if the editor is not needed anymore
provider.disposeEditor(editor);

#License The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MoritzWillig/JSONMEdit