Socket
Socket
Sign inDemoInstall

@pgrabovets/json-view

Package Overview
Dependencies
0
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @pgrabovets/json-view

This is a javascript library for displaying json data into a DOM. [link to demo](http://pgrabovets.github.io/json-view/)


Version published
Weekly downloads
15K
increased by6.56%
Maintainers
1
Install size
22.3 kB
Created
Weekly downloads
 

Readme

Source

json-view

This is a javascript library for displaying json data into a DOM. link to demo

Installation

  npm install '@pgrabovets/json-view';

How to use

include jsonview.js from dist directory in your html page

 <script src="jsonview.js"></script>

or you can use import

  import jsonview from '@pgrabovets/json-view';

get json data and render tree into DOM

// get json data
const data = '{"name": "json-view","version": "1.0.0"}';

// create json tree object
const tree = jsonview.create(data);

// render tree into dom element
jsonview.render(tree, document.querySelector('.tree'));

// you can render json data without creating tree
const tree = jsonview.renderJSON(data, document.querySelector('.tree'));

control methods

// expand tree
jsonview.expand(tree);

// collapse tree
jsonview.collapse(tree);

// traverse tree object
jsonview.traverse(tree, function(node) {
  console.log(node);
});

// function toggles between show or hide
jsonview.toggleNode(tree);

// destory and unmount json tree from the dom
jsonview.destroy(tree);

Example1

<!DOCTYPE html>
<html>
<head>
  <title>JSON VIEW</title>
</head>
<body>
  <div class="root"></div>

  <script type="text/javascript" src="jsonview.js"></script>
  <script type="text/javascript">
    fetch('example2.json')
    .then((res)=> {
      return res.text();
    })
    .then((data) => {
      const tree = jsonview.create(data);
      jsonview.render(tree, document.querySelector('.root'));
      jsonview.expand(tree);
    })
    .catch((err) => {
      console.log(err);
    })
  </script>
</body>
</html>

Example2

import jsonview from '@pgrabovets/json-view';

fetch('example2.json')
.then((res)=> {
  return res.text();
})
.then((data) => {
  const tree = jsonview.create(data);
  jsonview.render(tree, document.querySelector('.root'));
  jsonview.expand(tree);
})
.catch((err) => {
  console.log(err);
})

For development install dependencies and run scripts

$ npm install

$ npm run serve
$ npm run build

open http://localhost:3000/

Keywords

FAQs

Last updated on 17 Oct 2023

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc