Angular Json Editor


Angular Json Editor (wrapper for jsoneditor). View/Edit Json file with formatting.

StackBlitz template

Working with latest Angular 18/19.

!Demo Image

Installation

To install this library with npm, run below command:

``sh
$ npm install --save jsoneditor ang-jsoneditor
`

Example:

`html

`

Usage

$3

Import the standalone component as below:

`ts
import { Component, ViewChild } from '@angular/core';
import { JsonEditorComponent, JsonEditorOptions } from 'ang-jsoneditor';

@Component({
selector: 'app-root',
template: '',
styleUrls: ['./app.component.css'],
imports: [JsonEditorComponent]
})
export class AppComponent {
public editorOptions: JsonEditorOptions;
public data: any;
// optional
@ViewChild(JsonEditorComponent, { static: false }) editor: JsonEditorComponent;

constructor() {
this.editorOptions = new JsonEditorOptions()
this.editorOptions.modes = ['code', 'text', 'tree', 'view']; // set all allowed modes
//this.options.mode = 'code'; //set only one mode

this.data = {"products":[{"name":"car","product":[{"name":"honda","model":[{"id":"civic","name":"civic"},{"id":"accord","name":"accord"},{"id":"crv","name":"crv"},{"id":"pilot","name":"pilot"},{"id":"odyssey","name":"odyssey"}]}]}]}
}

}
`
Note : For better styling, add below line to your main style.css file

`js
@import "~jsoneditor/dist/jsoneditor.min.css";
`




$3

Build it integrated with ReactiveForms:

`ts
this.form = this.fb.group({
myinput: [this.data]
});
`
`html








`

$3

Besides all the
configuration options
from the original jsoneditor, Angular Json Editor supports one additional option:

_expandAll_ - to automatically expand all nodes upon json loaded with the _data_ input.

Troubleshoot

If you have issue with the height of the component, you can try one of those solutions:

When you import CSS:

`css
@import "~jsoneditor/dist/jsoneditor.min.css";
textarea.jsoneditor-text{min-height:350px;}
`

Or Customizing the CSS:

`css
:host ::ng-deep json-editor,
:host ::ng-deep json-editor .jsoneditor,
:host ::ng-deep json-editor > div,
:host ::ng-deep json-editor jsoneditor-outer {
height: 500px;
}
`

Or as a inner style in component:

`html

`

For code view you can change the height using this example:
`css
.ace_editor.ace-jsoneditor {
min-height: 500px;
}
`

Use debug mode to see in your console the data and options passed to jsoneditor. Copy this and paste in your issue when reporting bugs.

`html

`

JSONOptions missing params

If you find youself trying to use an custom option that is not mapped here, you can do:

`ts
let editorOptions: JsonEditorOptions = new JsonEditorOptions(); (this.editorOptions).templates = [{menu options objects as in json editor documentation}]
`

See the issue

Internet Explorer

If you want to support IE, please follow this guide:
* https://github.com/mariohmol/ang-jsoneditor/issues/44#issuecomment-508650610

Multiple editors

To use multiple jsoneditors in your view you cannot use the same editor options.

You should have something like:

`html



`

`ts
makeOptions = () => {
return new JsonEditorOptions();
}
`

Demo

Demo component files are included in Git Project.

Demo Project with a lot of different implementations (ngInit, change event and others):
[https://github.com/mariohmol/ang-jsoneditor/tree/master/src/app/demo)

When publishing it to npm, look over this docs: https://docs.npmjs.com/misc/developers

Collaborate

Fork, clone this repo and install dependencies.
This project just works with webpack 4 (dont change to 5):

`sh
npm i -g rimraf
npm i
``

License

MIT(./LICENSE)