Skip to content

Commit

Permalink
doc: updat readme
Browse files Browse the repository at this point in the history
  • Loading branch information
blucas.wu committed Jun 6, 2023
1 parent 7927124 commit f87150f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Engligh | [中文](./README_ZH.md)

## @huolala-tech/react-json-view

`<ReactJsonView />` is a React component for displaying JSON data.
`<ReactJsonView />` is a React component for displaying serializable data.

## Install

Expand Down Expand Up @@ -68,7 +68,7 @@ The default configuration usage:

| Name | Type | Default value | Description |
| --------------- | ------------------ | ------------- | ------------------------------------------------------------ |
| `source` | `object` | None | Origin json data. |
| `source` | `object` | None | Origin serializable data. |
| `rootLabel` | `React.ReactNode` | `""` | Root node's label. |
| `defaultExpand` | `boolean / number` | `false` | Whether expand property panel. Expand at a particular depth if you pass a integer value. |
| `keyCount` | `number / "all"` | `200` | `ReactJsonView` supports lazily loading more properties. The parameter indicates how many properties to show at a time, and you can pass `"all"` to show all properties. |
Expand Down
4 changes: 2 additions & 2 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## @huolala-tech/react-json-view

`<ReactJsonView />` 是一个用于展示 JSON 数据的 React 组件。
`<ReactJsonView />` 是一个用于展示可序列化数据的 React 组件。

## 安装

Expand Down Expand Up @@ -68,7 +68,7 @@ ReactDOM.render(

| 配置项 | 类型 | 默认值 | 释义 |
| --------------- | ----------------- | ------------- | ---------------------- |
| `source` | `string` | 无默认值 | JSON 数据|
| `source` | `string` | 无默认值 | 可序列化的数据|
| `rootLabel` | `React.ReactNode` | `""` | 根节点的标题名称 |
| `defaultExpand` | `boolean / number` | `false` | 是否展开面板。传入整数时是指定展开的层级。 |
| `keyCount` | `number / "all"` | `200` | `ReactJsonView` 支持延迟加载更多属性。 该参数表示一次显示多少个属性,您可以传递 `"all"` 以显示所有属性。 |
Expand Down

0 comments on commit f87150f

Please sign in to comment.