JsonTree.js

A lightweight JavaScript library that generates customizable tree views to ...

Tree / Explorer componentJSON
williamtroup/JsonTree.jswww.william-troup.com/jsontree-js/jjsontree.js

README

JsonTree.js


🔗 A lightweight JavaScript library that generates customizable tree views to better visualize JSON data.

What features does JsonTree.js have?


- Zero-dependencies and extremely lightweight!
- Exportable for use in other frameworks!
- Full API available via public functions.
- Fully styled in CSS/SASS, fully responsive, and compatible with the Bootstrap library!
- Full CSS theme support (using :root variables).
- Fully configurable per DOM element!
- Close/Open all.
- Clickable values!
- Custom value rendering.

Where can I find the documentation?


All the documentation can be found here.

What browsers are supported?


All modern browsers (such as Google Chrome, FireFox, and Opera) are fully supported.

What are the most recent changes?


To see a list of all the most recent changes.

How do I install JsonTree.js?


You can install the library with npm into your local modules directory using the following command:

  1. ```markdown
  2. npm install jjsontree.js
  3. ```

How do I get started?


To get started using JsonTree.js, do the following steps:

1. Prerequisites:


Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows:

  1. ```markdown
  2. DOCTYPE html>
  3. ```

2. Include Files:


  1. ```markdown
  2. <link rel="stylesheet" href="dist/jsontree.js.css">
  3. <script src="dist/jsontree.js"></script>
  4. ```

3. DOM Element Binding:


  1. ```markdown
  2. <div id="tree-1" data-jsontree-js="{ 'showCounts': true, 'data': [ true, false, 5, 10, 'A String' ] }">
  3.     Your HTML.
  4. </div>
  5. ```

To see a list of all the available binding options you can use for "data-jsontree-js".

To see a list of all the available custom triggers you can use for "data-jsontree-js".

4. Finishing Up:


That's it! Nice and simple. Please refer to the code if you need more help (fully documented).

How do I go about customizing JsonTree.js?


To customize, and get more out of JsonTree.js, please read through the following documentation.

1. Public Functions:


To see a list of all the public functions available.

2. Configuration:


Configuration options allow you to customize how JsonTree.js will function.  You can set them as follows:

  1. ```markdown
  2. <script>
  3.   $jsontree.setConfiguration( {
  4.       safeMode: false
  5.   } );
  6. </script>
  7. ```

To see a list of all the available configuration options you can use.