ldonlytest / jquery.json-viewer

jQuery plugin for displaying JSON data

jQuery json-viewer

json-viewer is a jQuery plugin for easily displaying JSON objects by transforming them into HTML.

Features:

• Syntax highlighting
• Collapse and expand child nodes on click
• Clickable links
• Easily readable and minimal DOM structure

Check out the demo page!

Usage

Import jquery.json-viewer.js and jquery.json-viewer.css in your application.

Copy sources from git repository, or use npm:

npm install jquery.json-viewer

Then just call the jsonViewer() method and pass your JSON data in argument:

<pre id="json-renderer"></pre>

var data = {
  "foobar": "foobaz"
};
$('#json-renderer').jsonViewer(data);

Options

The jsonViewer method accepts an optional options hash as a second argument:

• collapsed (boolean, default: false): all nodes are collapsed at html generation.
• rootCollapsable (boolean, default: true): allow root element to be collasped.
• withQuotes (boolean, default: false): all JSON keys are surrounded with double quotation marks ({"foobar": 1} instead of {foobar: 1}).
• withLinks (boolean, default: true): all values that are valid links will be clickable, if false they will only be strings.

Example:

$('#json-renderer').jsonViewer(data, {collapsed: true, withQuotes: true, withLinks: false});

About

• Author: Alexandre Bodelot
• License: MIT License