0.4.1 • Published 2 years ago

vue-json-pretty-sign v0.4.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

vue-json-pretty-sign

本项目基于 vue-json-pretty-sign@1.7.1 版本开发,主要实现标记键值与展示标记键值注释的功能。 注意如果父级为标记键值,则其子级将全部被标记.

一个将 JSON 字符串渲染成树形结构的 Vue2.x 组件

  • 基础功能: JSON 的美化
  • 高级功能: JSON 数据对应层级数据的获取

添加参数

属性级别说明类型默认值
showSignComment基础是否标记的键值注释booleantrue
signKeys高级标记的键值对Objectnull
addKeys基础额外标记 Json 不存在键值对Objectnull
showCopy基础显示复制按钮booleantrue
copyTitle基础复制按钮文字String"复制"
copyCompleteTitle高级复制完成按钮文字String"已复制"

链接

  • 当前项目 demo: Demo
  • 基于 leezng/vue-json-pretty: Github

安装

请下载后打包编译

快速开始

<template>
  <div>
    ...
    <vue-json-pretty-sign
      :path="'res'"
      :data="{ key: 'value' }"
      @click="handleClick"
    >
    </vue-json-pretty-sign>
  </div>
</template>
// 更多用法请见demo页面
import VueJsonPrettySign from "vue-json-pretty-sign";

export default {
  components: {
    VueJsonPrettySign
  }
};

Props

  • 若仅使用基础功能(JSON 美化),只需关注功能级别为 基础 的属性。
  • 若使用高级功能(选择数据),你可以同时使用 基础高级 的属性。
属性级别说明类型默认值
data基础待美化的源数据,注意不是 JSON 字符串JSON 对象-
deep基础数据深度, 大于该深度的数据将不被展开numberInfinity
showLength基础是否在数据线闭合的时候展示长度booleanfalse
showLine基础是否显示缩紧标识线booleantrue
showDoubleQuotes基础是否展示 key 名的双引号booleantrue
showDoubleQuotes基础是否展示 key 名的双引号booleantrue
showSignComment基础是否展示标记的键值注释booleantrue
signKeys高级标记的键值对Objectnull
highlightMouseoverNode基础是否在 mouseover 的时候高亮booleanfalse
v-model高级双向绑定选中的数据层级string, array-, []
path高级定义最顶层数据层级string''
pathChecked高级定义哪些数据层级是已被选中的array[]
pathSelectable高级定义哪些数据层级是可以被选中的Function(itemPath, itemData)-
selectableType高级定义组件支持的选中方式,默认无选中功能enum: -, multiple, single-
showSelectController高级是否展示选择控制器booleanfalse
selectOnClickNode高级是否在点击节点的时候触发 v-model 双向绑定booleantrue
highlightSelectedNode高级是否高亮已选项booleantrue
customValueFormatter高级可以进行值的自定义渲染Function(data, key, parent, defaultFormatted)-

Events

事件名说明回调参数
click点击某一个数据层级时触发的事件(path, data)
changev-model 改变的事件(仅在选择模式下可用)(newVal, oldVal)
0.4.1

2 years ago

0.3.1

2 years ago

0.3.0

2 years ago

0.1.1

2 years ago