vue-json-tree

CircleCI NPM LICENSE

Vue component that renders JSON data in a collapsible tree structure.


@usage

> Use in browsers

1. Include the CSS and JS along with Vue, so you get a <json-tree> component.

<script src="https://unpkg.com/vue@2.6.10/dist/vue.min.js"></script>
<script src="https://unpkg.com/vue-json-tree@0.4.1/dist/json-tree.js"></script>

2. Instantiate the component with your data.

<div id="app"></div>
<script>
  new Vue({
    template: '<json-tree :raw="sample"></json-tree>',
    el: '#app',
    data: {
      sample: '{"foo": "bar"}'
    }
  })
</script>

> Use with webpack and vue-loader

1. Install the vue-json-tree package via NPM.

npm install --save vue-json-tree

2. Import the SFC (with CSS embedded) and register it as a component, either globally or in another component.

import JsonTree from 'vue-json-tree'
Vue.component('json-tree', JsonTree)

@props

> raw (string, optional)

The data you want to present in the tree view. Must be a valid JSON string, otherwise it fails.

> data (any, optional)

If your JSON data has already been parsed, bind this one instead. Must be something that can be produced by JSON.parse().

> level (number, optional)

Sometimes the data structure is very deep. You could set them to collapsed on load. By default all levels are expanded.


@demo


@development

> Want to fix bugs or implement new features?

1. Grab the source code from GitHub.

git clone git@github.com:myst729/vue-json-tree.git

2. Install dependencies via NPM.

npm install

3. Run in dev mode and start to hack.

npm run dev

4. Make sure you run the tests.

npm run test

5. Build the dist files.

npm run dist

MIT © Leo Deng 2019