vue-json-pretty

v2.4.0

A JSON tree view component that is easy to use and also supports data selection. For more information about how to use this package see README

Latest version published 8 months ago

License: MIT

NPM

GitHub

Package Health Score

68 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.4.0	\|	03/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.9.5	\|	12/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.3.0	\|	12/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.8.3	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.7.1	\|	10/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (90,028)

GitHub Stars: 1.26K
Forks: 131
Contributors: 20

Direct Usage Popularity

The npm package vue-json-pretty receives a total of 90,028 downloads a week. As such, we scored vue-json-pretty popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package vue-json-pretty, we found that it has been starred 1,260 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the vue-json-pretty repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like vue-json-pretty is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 19
Open PR: 2
Last Release: 8 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of vue-json-pretty based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that vue-json-pretty demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 10.0.0

Age: 7 years
Dependencies: 0 Direct
Versions: 58
Install Size: 102 kB
Dist-tags: 2
# of Files: 16
Maintainers: 1
TS Typings: Yes

vue-json-pretty has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Vue Json Pretty

A Vue component for rendering JSON data as a tree structure.

Now it supports Vue3 at least. If you still use Vue2, see 1.x.

English | 简体中文

Features

As a JSON Formatter.
Written in TypeScript, support d.ts.
Support get item data from JSON.
Support big data.
Support editable.

Environment Support

Modern browsers, Electron and Internet Explorer 11 (with polyfills)
Server-side Rendering

IE / Edge	Firefox	Chrome	Safari	Electron
IE11, Edge	last 10 versions	last 10 versions	last 10 versions	last 2 versions

Using NPM or Yarn

$ npm install vue-json-pretty --save

$ yarn add vue-json-pretty

Use Vue2

$ npm install vue-json-pretty@v1-latest --save

Usage

The CSS file is included separately and needs to be imported manually. You can either import CSS globally in your app (if supported by your framework) or directly from the component.

<template>
  <div>
    
  </div>
</template>

Use Nuxt.js

In plugins/vue-json-pretty.js

import Vue from 'vue'
import VueJsonPretty from 'vue-json-pretty'

Vue.component("vue-json-pretty", VueJsonPretty)

In nuxt.config.js

css: [
  'vue-json-pretty/lib/styles.css'
],
plugins: [
  '@/plugins/vue-json-pretty'
],

Props

Property	Description	Type	Default
data(v-model)	JSON data, support v-model when use editable	JSON object	-
collapsedNodeLength	Objects or arrays which length is greater than this threshold will be collapsed	number	-
deep	Paths greater than this depth will be collapsed	number	-
showLength	Show the length when collapsed	boolean	false
showLine	Show the line	boolean	true
showLineNumber	Show the line number	boolean	false
showIcon	Show the icon	boolean	false
showDoubleQuotes	Show doublequotes on key	boolean	true
virtual	Use virtual scroll	boolean	false
height	The height of list when using virtual	number	400
itemHeight	The height of node when using virtual	number	20
selectedValue(v-model)	Selected data path	string, array	-
rootPath	Root data path	string	`root`
nodeSelectable	Defines whether a node supports selection	(node) => boolean	-
selectableType	Support path select, default none	`multiple` \| `single`	-
showSelectController	Show the select controller	boolean	false
selectOnClickNode	Trigger select when click node	boolean	true
highlightSelectedNode	Support highlighting selected nodes	boolean	true
collapsedOnClickBrackets	Support click brackets to collapse	boolean	true
renderNodeKey	render node key, or use slot #renderNodeKey	({ node, defaultKey }) => vNode	-
renderNodeValue	render node value, or use slot #renderNodeValue	({ node, defaultValue }) => vNode	-
editable	Support editable	boolean	false
editableTrigger	Trigger	`click` \| `dblclick`	`click`
theme	Sets the theme of the component. Options are 'light' or 'dark', with dark mode enhancing visibility on dark backgrounds	`'light' \| 'dark'`	`light`

Events

Event Name	Description	Parameters
nodeClick	triggers when click node	(node: NodeData)
bracketsClick	triggers when click brackets	(collapsed: boolean, node: NodeData)
iconClick	triggers when click icon	(collapsed: boolean, node: NodeData)
selectedChange	triggers when the selected value changed	(newVal, oldVal)

Slots

Slot Name	Description	Parameters
renderNodeKey	render node key	{ node, defaultKey }
renderNodeValue	render node value	{ node, defaultValue }

Contributors

FAQs

What is vue-json-pretty?

A JSON tree view component that is easy to use and also supports data selection. Visit Snyk Advisor to see a full health score report for vue-json-pretty, including popularity, security, maintenance & community analysis.

Is vue-json-pretty popular?

The npm package vue-json-pretty receives a total of 90,028 weekly downloads. As such, vue-json-pretty popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is vue-json-pretty well maintained?

We found indications that vue-json-pretty maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is vue-json-pretty safe to use?

The npm package vue-json-pretty was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 November-2024, at 08:00 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP