A web-based tool to view, edit, format, transform, and validate JSON
The library is written with Svelte, but can be used in any framework (React, Vue, Angular, plain JavaScript).
Install via npm:
npm install svelte-jsoneditor
- Svelte examples: /src/routes/examples
- Plain JavaScript examples: /examples/browser
- React example: https://codesandbox.io/s/svelte-jsoneditor-react-59wxz
There is currently an issue in SvelteKit with processing some dependencies (more precisely: Vite used by SvelteKit). svelte-jsoneditor depends on some libraries that hit this issue. To work around it, each of these dependencies needs to be listed in the configuration. Without the workaround, you'll see errors like "ReferenceError: module is not defined" (for debug, ajv, ace-builds, etc.).
In your SvelteKit configuration file svelte.config.js, add the list with dependencies viteOptimizeDeps, available in the svelte-jsoneditor/config.js, and use that in the configuration of vite (config.kit.vite.optimizeDeps.include):
// svelte.config.js
// ...
import { viteOptimizeDeps } from 'svelte-jsoneditor/config.js'
const config = {
// ...
kit: {
// ...
vite: {
optimizeDeps: {
include: [...viteOptimizeDeps]
}
}
}
}
// ...Create a JSONEditor with two-way binding bind:json:
<script>
import { JSONEditor } from 'svelte-jsoneditor'
let content = {
text: undefined, // used when in code mode
json: {
array: [1, 2, 3],
boolean: true,
color: '#82b92c',
null: null,
number: 123,
object: { a: 'b', c: 'd' },
string: 'Hello World'
}
}
</script>
<div>
<JSONEditor bind:content />
</div>Or one-way binding:
<script>
import { JSONEditor } from 'svelte-jsoneditor'
let content = {
text: undefined, // used when in code mode
json: {
greeting: 'Hello World'
}
}
function handleChange(updatedContent) {
// content is an object { json: JSON } | { text: string }
console.log('onChange: ', updatedContent)
content = updatedContent
}
</script>
<div>
<JSONEditor {content} onChange="{handleChange}" />
</div>The library provides a standalone bundle of the editor which can be used in any browser environment and framework. In a framework like React, Vue, or Angular, you'll need to write some wrapper code around the class interface.
Browser example loading the ES module:
<!DOCTYPE html>
<html lang="en">
<head>
<title>JSONEditor</title>
</head>
<body>
<div id="jsoneditor"></div>
<script type="module">
import { JSONEditor } from 'svelte-jsoneditor/dist/jsoneditor.js'
let content = {
text: undefined,
json: {
greeting: 'Hello World'
}
}
const editor = new JSONEditor({
target: document.getElementById('jsoneditor'),
props: {
content,
onChange: (updatedContent) => {
// content is an object { json: JSON } | { text: string }
console.log('onChange', updatedContent)
content = updatedContent
}
}
})
// use methods get, set, update, and onChange to get data in or out of the editor.
// Use updateProps to update properties.
</script>
</body>
</html>Svelte component:
<script>
import { JSONEditor } from 'svelte-jsoneditor'
</script>
<div>
<JSONEditor {content} />
</div>JavasScript class:
import { JSONEditor } from 'svelte-jsoneditor/dist/jsoneditor.js'
const editor = new JSONEditor({
target: document.getElementById('jsoneditor'),
props: {
content,
onChange: (updatedContent) => {
// content is an object { json: JSON } | { text: string }
console.log('onChange', updatedContent)
}
}
})-
content: { json: JSON } | { text: string }Pass the JSON contents to be rendered in the JSONEditor. Contents is an object containing a propertyjsonandtext. Only one of the two must be defined. In case oftreemode,jsonis used. In case ofcodemode,textis used. -
mode: 'tree' | 'code'. Open the editor in'tree'mode (default) or'code'mode. -
mainMenuBar: booleanShow the main menu bar. Default value istrue. -
navigationBar: booleanShow the navigation bar with, where you can see the selected path and navigate through your document from there. Default value istrue. -
readOnly: booleanOpen the editor in read-only mode: no changes can be made, non-relevant buttons are hidden from the menu, and the context menu is not enabled. Default value isfalse. -
indentation: numberNumber of spaces use for indentation when stringifying JSON. -
validator: function (json): ValidationError[]. Validate the JSON document. For example use the built-in JSON Schema validator powered by Ajv:import { createAjvValidator } from 'svelte-jsoneditor' const validator = createAjvValidator(schema, schemaRefs)
-
onError(err: Error). Callback fired when an error occurs. Default implementation is to log an error in the console and show a simple alert message to the user. -
onChange({ json: JSON | undefined, text: string | undefined}). Callback which is invoked on every change made in the JSON document. -
onChangeMode(mode: string). Invoked when the mode is changed. -
onClassName(path: Array.<string|number>, value: any): string | undefined. Add a custom class name to specific nodes, based on their path and/or value. -
onRenderMenu(mode: string, items: Array) : Array | undefined. Callback which can be used to make changes to the menu items. New items can be added, or existing items can be removed or reorganized. When the function returnsundefined, the originalitemswill be applied.A menu item can be one of the following types:
-
Button:
interface MenuButtonItem { onClick: () => void icon?: FontAwesomeIcon text?: string title?: string className?: string disabled?: boolean }
-
Separator (gray vertical line between a group of items):
interface MenuSeparatorItem { separator: true }
-
Space (fills up empty space):
interface MenuSpaceItem { space: true }
-
-
onFocus()callback fired when the editor got focus. -
onBlur()callback fired when the editor lost focus.
-
get(): { json: JSON } | { text: string }Get the current JSON document. -
set(content: { json: JSON } | { text: string })Replace the current content. Will reset the state of the editor. See also methodupdate(content). -
update(content: { json: JSON } | { text: string })Update the loaded content, keeping the state of the editor (like expanded objects). You can also calleditor.updateProps({ content }). See also methodset(content). -
patch(operations: JSONPatchDocument)Apply a JSON patch document to update the contents of the JSON document. A JSON patch document is a list with JSON Patch operations. -
updateProps(props: Object)update some or all of the properties. Updatedcontentcan be passed too; this is equivalent to callingupdate(content). Example:editor.updateProps({ readOnly: true })
-
expand([callback: (path: Path) => boolean])Expand or collapse paths in the editor. Thecallbackdetermines which paths will be expanded. If nocallbackis provided, all paths will be expanded. It is only possible to expand a path when all of its parent paths are expanded too. Examples:editor.expand(path => true)expand alleditor.expand(path => false)collapse alleditor.expand(path => path.length < 2)expand all paths up to 2 levels deep
-
transform({ id?: string, onTransform?: ({ operations: JSONPatchDocument, json: JSON, transformedJson: JSON }) => void, onClose?: () => void })programmatically trigger clicking of the transform button in the main menu, opening the transform model. If a callbackonTransformis provided, it will replace the build-in logic to apply a transform, allowing you to process the transform operations in an alternative way. If provided,onClosecallback will trigger when the transform modal closes, both after the user clicked apply or cancel. If anidis provided, the transform modal will load the previous status of thisidinstead of the status of the editors transform modal. -
scrollTo(path: Array.<string|number>)Scroll the editor vertically such that the specified path comes into view. The path will be expanded when needed. -
focus(). Give the editor focus. -
destroy(). Destroy the editor, remove it from the DOM.
Clone the git repository
Install dependencies (once):
npm install
Start the demo project (at http://localhost:3000):
npm run dev
Build the library:
npm run package
Run unit tests:
npm test
Run linter:
npm run lint
Publish to npm (will increase version number and publish to npm):
npm run release
Released under the ISC license.