vue-json-viewer

by chenfengjw163

chenfengjw163 / vue-json-viewer

Simple JSON viewer component, for Vue.js 2 and support ssr

184 Stars 36 Forks Last release: 4 months ago (2.2.12) MIT License 123 Commits 5 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

vue-json-viewer

中文版

Simple JSON viewer component, for Vue.js 2.

Support for incremental update components

Travis npm npm

Installing

Using npm:

$ npm install vue-json-viewer --save

Using yarn:

$ yarn add vue-json-viewer

Example


import Vue from 'vue'
import JsonViewer from 'vue-json-viewer'

// Import JsonViewer as a Vue.js plugin Vue.use(JsonViewer) // or // components: {JsonViewer}

new Vue({ el: '#app', data() { return { jsonData: { total: 25, limit: 10, skip: 0, links: { previous: undefined, next: function () {}, }, data: [ { id: '5968fcad629fa84ab65a5247', firstname: 'Ada', lastname: 'Lovelace', awards: null, known: [ 'mathematics', 'computing' ], position: { lat: 44.563836, lng: 6.495139 }, description: Augusta Ada King, Countess of Lovelace (née Byron; 10 December 1815 – 27 November 1852) was an English mathematician and writer, chiefly known for her work on Charles Babbage's proposed mechanical general-purpose computer, the Analytical Engine. She was the first to recognise that the machine had applications beyond pure calculation, and published the first algorithm intended to be carried out by such a machine. As a result, she is sometimes regarded as the first to recognise the full potential of a "computing machine" and the first computer programmer., bornAt: '1815-12-10T00:00:00.000Z', diedAt: '1852-11-27T00:00:00.000Z' }, { id: '5968fcad629fa84ab65a5246', firstname: 'Grace', lastname: 'Hopper', awards: [ 'Defense Distinguished Service Medal', 'Legion of Merit', 'Meritorious Service Medal', 'American Campaign Medal', 'World War II Victory Medal', 'National Defense Service Medal', 'Armed Forces Reserve Medal', 'Naval Reserve Medal', 'Presidential Medal of Freedom' ], known: null, position: { lat: 43.614624, lng: 3.879995 }, description: Grace Brewster Murray Hopper (née Murray; December 9, 1906 – January 1, 1992) was an American computer scientist and United States Navy rear admiral. One of the first programmers of the Harvard Mark I computer, she was a pioneer of computer programming who invented one of the first compiler related tools. She popularized the idea of machine-independent programming languages, which led to the development of COBOL, an early high-level programming language still in use today., bornAt: '1815-12-10T00:00:00.000Z', diedAt: '1852-11-27T00:00:00.000Z' } ] } } } })

SSR

import JsonViewer from 'vue-json-viewer/ssr'

// Import JsonViewer as a Vue.js plugin Vue.use(JsonViewer) // or // components: {JsonViewer}

and

import 'vue-json-viewer/style.css'

Preview

preview

Options

| Property | Description | Default | | ----------- |:------------- | ----------- | |

value
| JSON data (can be used with
v-model
) | Required | |
expand-depth
| Collapse blocs under this depth |
1
| |
copyable
| Display the copy button, you can customize copy text just set
{copyText: 'copy', copiedText: 'copied', timeout: 2000}
or set
true
use default copytext |
false
| |
sort
| Sort keys before displaying |
false
| |
boxed
| Add a fancy "boxed" style to component |
false
| |
theme
| Add a custom CSS class for theming purposes |
jv-light
| |
expanded
| Default expand the view |
false
| |
timeformat
| custom time format function | time => time.toLocaleString() |

Listeners

| Listener | Description | Value | | ----------- |:------------- | ----------- | |

copied
| Emits copyEvent after text copied | Clipboard success event |

Slots

| Name | Description | Scope | | ----------- |:------------- | ----------- | |

copy
| Custom content for copy button |
{copied: boolean}
|

Theming

To create custom theme, (e.g.

my-awesome-json-theme
), in two easy steps: 1. add
theme="my-awesome-json-theme"
to the JsonViewer component 2. copy-pasta and customize this SCSS template:
// values are default one from jv-light template
.my-awesome-json-theme {
  background: #fff;
  white-space: nowrap;
  color: #525252;
  font-size: 14px;
  font-family: Consolas, Menlo, Courier, monospace;

.jv-ellipsis { color: #999; background-color: #eee; display: inline-block; line-height: 0.9; font-size: 0.9em; padding: 0px 4px 2px 4px; border-radius: 3px; vertical-align: 2px; cursor: pointer; user-select: none; } .jv-button { color: #49b3ff } .jv-key { color: #111111 } .jv-item { &.jv-array { color: #111111 } &.jv-boolean { color: #fc1e70 } &.jv-function { color: #067bca } &.jv-number { color: #fc1e70 } &.jv-number-float { color: #fc1e70 } &.jv-number-integer { color: #fc1e70 } &.jv-object { color: #111111 } &.jv-undefined { color: #e08331 } &.jv-string { color: #42b983; word-break: break-word; white-space: normal; } } .jv-code { .jv-toggle { &:before { padding: 0px 2px; border-radius: 2px; } &:hover { &:before { background: #eee; } } } } }

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.