2.0 KiB
2.0 KiB
Usage
Install
using npm:
npm install jsoneditor
Load
To implement JSONEditor in a web application, load the javascript file in the head of the HTML page:
<script src="jsoneditor/dist/jsoneditor.js"></script>
Use
In the body, create an div element with an id and a size:
<div id="jsoneditor" style="width: 400px; height: 400px;"></div>
After the page is loaded, load the editor with javascript:
var container = document.getElementById("jsoneditor")
var options = {
mode: 'tree'
}
var editor = jsoneditor(container, options)
To set JSON data in the editor:
var json = {
"Array": [1, 2, 3],
"Boolean": true,
"Null": null,
"Number": 123,
"Object": {"a": "b", "c": "d"},
"String": "Hello World"
}
editor.set(json)
To get JSON data from the editor:
var json = editor.get()
Full Example
<!DOCTYPE HTML>
<html>
<head>
<!-- when using the mode "code", it's important to specify charset utf-8 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<script src="jsoneditor/dist/jsoneditor.js"></script>
</head>
<body>
<p>
<button onclick="setJSON()">Set JSON</button>
<button onclick="getJSON()">Get JSON</button>
</p>
<div id="jsoneditor" style="width: 400px; height: 400px;"></div>
<script>
// create the editor
var container = document.getElementById('jsoneditor')
var editor = jsoneditor(container)
// set json
function setJSON () {
var json = {
"Array": [1, 2, 3],
"Boolean": true,
"Null": null,
"Number": 123,
"Object": {"a": "b", "c": "d"},
"String": "Hello World"
}
editor.set(json)
}
// get json
function getJSON() {
var json = editor.get()
alert(JSON.stringify(json, null, 2))
}
</script>
</body>
</html>
For more examples, see the examples section.