@a-b-r-o-w-n/react-json-view 中文文档教程

Question

react-json-view

RJV 是一个 React 组件，用于显示和编辑 javascript arrays 和 JSON 对象。

该组件提供了一个响应式界面，用于在 Web 浏览器中显示数组或 JSON。 NPM 提供了一个被转译为 ES5 的源代码分布； 因此您可以将此组件包含在任何基于 Web 的 javascript 应用程序中。

查看交互式演示

Implementation Example

// import the react-json-view component
import ReactJson from 'react-json-view'

// use the component in your app!
<ReactJson src={my_json_object} />

Output Examples

Default Theme

Hopscotch Theme, with Triangle Icons:

Installation Instructions

安装这个NPM 组件。

npm install --save react-json-view

或者添加到您的 package.json 配置文件：

"dependencies": {
    "react-json-view": "latest"
}

Props

Name	Type	Default	Description
src	JSON Object	None	This property contains your input JSON
name	string or false	"root"	Contains the name of your root node. Use null or false for no name.
theme	string	"rjv-default"	RJV supports base-16 themes. Check out the list of supported themes in the demo. A custom "rjv-default" theme applies by default.
style	object	{}	Style attributes for react-json-view container. Explicit style attributes will override attributes provided by a theme.
iconStyle	string	"circle"	Style of expand/collapse icons. Accepted values are "circle", triangle" or "square".
indentWidth	integer	4	Set the indent-width for nested objects
collapsed	boolean or integer	false	When set to true, all nodes will be collapsed by default. Use an integer value to collapse at a particular depth.
collapseStringsAfterLength	integer	false	When an integer value is assigned, strings will be cut off at that length. Collapsed strings are followed by an ellipsis. String content can be expanded and collapsed by clicking on the string value.
shouldCollapse	(field)=>{}	false	Callback function to provide control over what objects and arrays should be collapsed by default. An object is passed to the callback containing name, src, type ("array" or "object") and namespace.
groupArraysAfterLength	integer	100	When an integer value is assigned, arrays will be displayed in groups by count of the value. Groups are displayed with brakcet notation and can be expanded and collapsed by clickong on the brackets.
enableClipboard	boolean or (copy)=>{}	true	When prop is not false, the user can copy objects and arrays to clipboard by clicking on the clipboard icon. Copy callbacks are supported.
displayObjectSize	boolean	true	When set to true, objects and arrays are labeled with size
displayDataTypes	boolean	true	When set to true, data type labels prefix values
onEdit	(edit)=>{}	false	When a callback function is passed in, edit functionality is enabled. The callback is invoked before edits are completed. Returning false from onEdit will prevent the change from being made. see: onEdit docs
onAdd	(add)=>{}	false	When a callback function is passed in, add functionality is enabled. The callback is invoked before additions are completed. Returning false from onAdd will prevent the change from being made. see: onAdd docs
defaultValue	string |number |boolean |array |object	null	Sets the default value to be used when adding an item to json
onDelete	(delete)=>{}	false	When a callback function is passed in, delete functionality is enabled. The callback is invoked before deletions are completed. Returning false from onDelete will prevent the change from being made. see: onDelete docs
onSelect	(select)=>{}	false	When a function is passed in, clicking a value triggers the onSelect method to be called.
sortKeys	boolean	false	set to true to sort object keys
validationMessage	string	"Validation Error"	Custom message for validation failures to onEdit, onAdd, or onDelete callbacks

Features

• onEdit, onAdd and onDelete props allow users to edit the src variable
• Object, array, string and function values can be collapsed and expanded
• Object and array nodes display length
• Object and array nodes support a "Copy to Clipboard" feature
• String values can be truncated after a specified length
• Arrays can be subgrouped after a specified length
• Base-16 Theme Support
• When onEdit is enabled:
• Ctrl/Cmd+Click Edit Mode
• Ctrl/Cmd+Enter Submit

Customizing Style

Stock Themes

RJV 现在支持 base-16 主题！

当您实例化您的 rjv 组件时，您可以指定一个 theme 名称或对象。

<ReactJson src={my_important_json} theme="monokai" />

查看支持的主题列表在组件演示中。

Monokai theme example

Solarized theme example

Use Your Own Theme

您可以提供自己的 base-16 主题对象。

为了更好地理解自定义主题，请查看 我的示例实现 和 base-16 主题样式指南。

onEdit, onAdd and onDelete Interaction

将回调方法传递给 onEdit、onAdd 和 onDelete 属性。 当用户尝试更新您的 src 对象时，将调用您的方法。

以下对象将传递给您的方法：

{
    updated_src: src, //new src value
    name: name, //new var name
    namespace: namespace, //list, namespace indicating var location
    new_value: new_value, //new variable value
    existing_value: existing_value, //existing variable value
}

从回调方法返回 false 将防止 src 受到影响。

Contributing to the source code

Run the Dev Server

# clone this repository
git clone git@github.com:mac-s-g/react-json-view.git && cd react-json-view
# install dependencies
npm install --save-dev
# run the dev server with hot reloading
npm run dev

Webpack Dev Server 应该会在您的 Web 浏览器中自动打开 http://localhost:2000。 如果没有，请打开浏览器并导航到端口 2000。当 /src/ 目录中的文件被修改时，热加载器将自动重新加载。

Run the Production Build

# run the build (note: you may need to use `sudo` priveledges to run the build successfully)
npm run build

请在发布拉取请求之前为您的代码添加测试。

您可以使用 npm run test 或 npm run test:watch 运行测试套件，以便在文件被修改时自动重新加载。

Docker Tools

我建议使用 docker 进行开发，因为它强制执行环境一致性。

有关使用 Docker 进行贡献的信息，请参阅 ./docker 中的自述文件。

Inspiration

我从 react-json-tree 中汲取了大量的设计理念。 感谢 RJT 贡献者组合了一个很棒的组件！

我也受到提出有趣功能请求的用户的启发。 如果您对这个项目或其他您想合作的项目有想法，请与我联系。 我的电子邮件地址列在我的 github 用户页面 上。