Skip to content

Commit d3133c7

Browse files
committed
docs: Update README.
1 parent ebf9444 commit d3133c7

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010

1111
<div align="center">
1212

13-
A Vue component for rendering JSON data as a tree structure.
13+
<p>A Vue component for rendering JSON data as a tree structure.</p>
14+
<p>Now it supports Vue3 at least. If you still use Vue2, see <a href="https://github.com/leezng/vue-json-pretty/tree/1.x">1.x</a>.</p>
1415

1516
[![Build Status](https://travis-ci.org/leezng/vue-json-pretty.svg?branch=master)](https://travis-ci.org/leezng/vue-json-pretty)
1617
[![npm package](https://img.shields.io/npm/v/vue-json-pretty.svg)](https://www.npmjs.org/package/vue-json-pretty)
@@ -110,15 +111,15 @@ plugins: [
110111
| showDoubleQuotes | normal | Whether to show doublequotes on key | boolean | true |
111112
| virtual | normal | Whether to use virtual scrolling, usually used for big data | boolean | false |
112113
| itemHeight | normal | The height of each item when using virtual scrolling | number | auto |
113-
| v-model | higher | Defines value when the tree can be selected | string, array | -, [] |
114-
| path | higher | root data path | string | root |
115-
| pathSelectable | higher | Defines whether a data path supports selection | Function(path, content) | - |
114+
| v-model | higher | Defines value when the tree can be selected | string, array | - |
115+
| path | higher | Root data path | string | root |
116+
| pathSelectable | higher | Defines whether a data path supports selection | function(path, content) | - |
116117
| selectableType | higher | Defines the selected type, this feature is not supported by default | multiple, single | - |
117118
| showSelectController | higher | Whether to show the select controller at left | boolean | false |
118119
| selectOnClickNode | higher | Whether to change selected value when click node | boolean | true |
119120
| highlightSelectedNode | higher | Highlight current node when selected | boolean | true |
120121
| collapsedOnClickBrackets | higher | Collapsed control | boolean | true |
121-
| customValueFormatter | higher | A function that can return different html or strings to display for values in the data. | Function(data, key, path, defaultFormatResult) | - |
122+
| customValueFormatter | higher | A function that can return different html or strings to display for values in the data. | function(data, key, path, defaultFormatResult) | - |
122123

123124
## Events
124125

0 commit comments

Comments
 (0)