Code Monkey home page Code Monkey logo

vue-json-pretty's Introduction

vue-json-pretty

Build Status npm package GitHub license

A vue 2.x component for rendering JSON data as a tree structure.

  • As a JSON Formatter
  • Get item data from JSON

Links

Install

npm install vue-json-pretty

Usage

<template>
  <div>
    ...
    <vue-json-pretty
      :path="'res'"
      :data="{ key: 'value' }"
      @click="handleClick">
    </vue-json-pretty>
  </div>
</template>
import VueJsonPretty from 'vue-json-pretty'

export default {
  components: {
    VueJsonPretty
  }
}

Props

  • If you are using only the normal features (JSON pretty), just focus on the base properties.
  • If you are using higher features (Get data), you can use base and higher attributes.
Attribute Level Description Type Default
data normal json data JSON object -
deep normal data depth, data larger than this depth will not be expanded number Infinity
showLength normal whether to show the length when closed boolean false
showLine normal whether to show the line boolean true
showDoubleQuotes normal whether to show doublequotes on key boolean true
highlightMouseoverNode normal highlight current node when mouseover boolean false
v-model higher defines value when the tree can be selected string, array -, []
path higher root data path string root
pathChecked higher defines the selected data path array []
pathSelectable higher defines whether a data path supports selection Function(itemPath, itemData) -
selectableType higher defines the selected type, this feature is not supported by default enum: -, multiple, single -
showSelectController higher whether to show the select controller at left boolean false
selectOnClickNode higher whether to change selected value when click node boolean true
highlightSelectedNode higher highlight current node when selected boolean true
customValueFormatter higher a function that can return different html or strings to display for values in the data. Function(data, key, parent, defaultFormatted) -

Events

Event Name Description Callback Parameters
click triggered when a data item is clicked (path, data)
change triggered when the selected value changed (only the selectableType not null) (newVal, oldVal)

vue-json-pretty's People

Contributors

blackmad avatar dependabot[bot] avatar henrikekblad avatar leezng avatar rchl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.