vue-json-view 一款用于展现json的vue组件,支持大致积json文件快速解析渲染

在线示例html

开发背景:vue

项目开发过程当中遇到展现json的场景,且json文件体积过大,小则几百kb,也尝试了已经开源的部分组件,但因为节点过多,渲染速度过慢,没法使用,已有项目技术选型为vue,没法再使用react相关技术,因此考虑本身开发一款。react

开发过程当中参考了react-json-view部分api,组件实现的功能比较基础,但知足基本业务场景,也提供了一些可选配置。git

即便加载1M左右的json文时,结合deep深度限制,也能实现秒开的速度github

组件压所事后体积只有15.7kb,开启gzip压缩后只有4.74kb,npm

image.png

1.查看示例

在线示例json

git clone  https://github.com/zhaoxuhui1122/vue-json-view.git
npm i
npm run dev

或 直接双击index.html
复制代码

2.在项目中使用

npm i -S vue-json-views  // 注意是 views
import jsonView from 'vue-json-views'

或

直接将未编译的组件复制到项目内(推荐该方式,便于自定义修改)

复制代码
<template>
    <json-view :data="json"/>
</template>

<script>
    import jsonView from '@/components/json-view';

    export default {
        components: {
            jsonView
        },
        data() {
            return {
                json: { /* json data*/ }
            }
        }
    }
</script>
复制代码

3.可选配置说明

属性 说明 类型 默认值
json 传入的json数据(必填) Object -
closed 是否折叠所有 Boolean false
deep 展开深度,越大渲染速度越慢,建议不超过5 Number 3
icon-style 折叠按钮样式,可选值为square、circle、triangle String square
icon-color 两个折叠按钮的颜色 Array theme=vs-code时,['#c6c6c6', '#c6c6c6'],其余状况为['#747983', '#747983']
theme 可选主题样式,可选值为one-dark、vs-code,不选时为默认的白色主题 String -
font-size 字体大小,单位px Number 14
line-height 行高,单位px Number 24

注:行高和字体大小不建议选用过大值,由于icon大小、每行的padding-left等参数并不会随之发生改变api

4.关于二次开发

可根据本身项目的实际状况进行以下开发bash

  • 主题定制:根据需求定制主题,不一样的主题名称会给组件定义对应的class名称,根据class从新定义样式便可,可参见项目内的主题配置
  • 修改icon样式:项目内icon使用的svg,支持三种样式,可自定义更换或者删除不须要的svg文件,以下降打包体积
  • ...