svelte-jsoneditor
Advanced tools
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
See the /examples section for some full examples.
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 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:json />
</div>
Or one-way binding:
<script>
import { JSONEditor } from 'svelte-jsoneditor'
let json = {
greeting: 'Hello World'
}
function onChange(content) {
// content is an object { json: JSON | undefined, text: string | undefined }
console.log('onChange: ', content)
json = content.json
}
</script>
<div>
<JSONEditor json="{json}" onChange="{onChange}" />
</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'
const editor = new JSONEditor({
target: document.getElementById('jsoneditor'),
props: {
json: {
greeting: 'Hello World'
},
onChange: (content) => {
// content is an object { json: JSON | undefined, text: string | undefined }
console.log('onChange', content)
}
}
})
</script>
</body>
</html>
Svelte component:
<script>
import { JSONEditor } from 'svelte-jsoneditor'
</script>
<div>
<JSONEditor json="{json}" />
</div>
JavasScript class:
import { JSONEditor } from 'svelte-jsoneditor'
const editor = new JSONEditor({
target: document.getElementById('jsoneditor'),
props: {
json,
onChange: (content) => {
// content is an object { json: JSON | undefined, text: string | undefined }
console.log('onChange', content)
}
}
})
json Pass the JSON document to be rendered in the JSONEditormode: 'tree' | 'code'. Open the editor in 'tree' mode (default) or 'code' mode.
mainMenuBar: boolean Show the main menu bar. Default value is true.
readOnly: boolean Open 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 is false.
indentation: number Number 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
returns undefined, the original items will 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 Get the current JSON document. Will throw an error when the editor is code mode and does not contain valid JSON.getText(): string Get the current JSON document as stringified JSON.set(json: JSON) Replace the current JSON document. Will reset the state of the editor.setText(text: string) Replace the current JSON document, passing stringified JSON contents.update(json: JSON) Update the loaded JSON document, keeping the state of the editor (like expanded objects).updateText(text: string) Update the loaded JSON document, keeping the state of the editor (like expanded objects).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.expand([callback: (path: Path) => boolean]) Expand or collapse paths in the editor. The callback determines which paths will be expanded. If no callback is 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 deeptransform({ 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 callback onTransform is 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, onClose callback will trigger when the transform modal closes, both after the user clicked apply or cancel. If an id is provided, the transform modal will load the previous status of this id instead 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.
FAQs
A web-based tool to view, edit, format, transform, and validate JSON
The npm package svelte-jsoneditor receives a total of 2,343 weekly downloads. As such, svelte-jsoneditor popularity was classified as popular.
We found that svelte-jsoneditor demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers uncover how threat actors weaponize Out-of-Band Application Security Testing (OAST) techniques across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Research
A malicious npm campaign is targeting Ethereum developers by impersonating Hardhat plugins and the Nomic Foundation, stealing sensitive data like private keys.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.