react-json-view vs jsoneditor vs react-json-editor-ajrm vs react-jsonschema-form vs jsoneditor-react
JSON Editing Libraries for React Comparison
1 Year
react-json-viewjsoneditorreact-json-editor-ajrmreact-jsonschema-formjsoneditor-reactSimilar Packages:
What's JSON Editing Libraries for React?

These libraries provide various functionalities for editing, viewing, and managing JSON data in web applications. They cater to different needs, from simple viewing to complex schema-based forms, making it easier for developers to integrate JSON handling capabilities into their React applications.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
react-json-view707,0883,565-1814 years agoMIT
jsoneditor187,29711,8868.09 MB230a month agoApache-2.0
react-json-editor-ajrm57,477359350 kB12 years agoMIT
react-jsonschema-form33,56114,820-2975 years agoApache-2.0
jsoneditor-react20,66927365 kB43-MIT
Feature Comparison: react-json-view vs jsoneditor vs react-json-editor-ajrm vs react-jsonschema-form vs jsoneditor-react

Editing Capabilities

  • react-json-view:

    react-json-view is primarily for viewing JSON data rather than editing it. It allows users to expand and collapse JSON structures for better readability, but does not provide editing capabilities, making it unsuitable for applications that require JSON manipulation.

  • jsoneditor:

    jsoneditor offers a comprehensive set of editing tools, including tree and text views, allowing users to manipulate JSON data easily. It supports features like drag-and-drop for reordering elements, and it provides validation feedback to ensure the JSON structure is correct.

  • react-json-editor-ajrm:

    react-json-editor-ajrm provides a simple editing interface focused on JSON objects and arrays. It allows users to edit JSON data directly in a user-friendly manner, but lacks advanced features like drag-and-drop or validation feedback.

  • react-jsonschema-form:

    react-jsonschema-form allows users to edit JSON data through dynamically generated forms based on JSON Schema. It provides a structured way to edit data, with built-in validation, but is not a general-purpose JSON editor.

  • jsoneditor-react:

    jsoneditor-react inherits all editing capabilities from jsoneditor, providing a React-friendly interface. It allows for interactive editing of JSON data with real-time validation, making it easy to integrate into any React application.

Integration with React

  • react-json-view:

    react-json-view is a React component that displays JSON data in a structured format. It integrates well with React applications, allowing developers to easily visualize JSON data without additional setup.

  • jsoneditor:

    jsoneditor is a standalone library and does not have built-in support for React. It requires manual integration, which may involve handling lifecycle methods and state management separately.

  • react-json-editor-ajrm:

    react-json-editor-ajrm is tailored for React applications, providing a simple API to integrate JSON editing capabilities directly into React components. It leverages React's state management, making it easy to handle changes and updates.

  • react-jsonschema-form:

    react-jsonschema-form is built for React and utilizes JSON Schema to generate forms. It integrates smoothly with React's state management and lifecycle methods, making it ideal for applications that require dynamic form generation.

  • jsoneditor-react:

    jsoneditor-react is specifically designed for React, providing a seamless integration experience. It allows developers to use the jsoneditor library as a React component, making it easier to manage state and lifecycle events within a React application.

Complexity and Learning Curve

  • react-json-view:

    react-json-view is straightforward to use, focusing on displaying JSON data rather than editing it. Developers can quickly implement it in their applications without much overhead.

  • jsoneditor:

    jsoneditor has a moderate learning curve due to its extensive features and standalone nature. Developers need to familiarize themselves with its API and how to integrate it into their applications effectively.

  • react-json-editor-ajrm:

    react-json-editor-ajrm is designed to be simple and intuitive, making it easy for developers to get started with JSON editing in React. Its lightweight nature contributes to a gentle learning curve.

  • react-jsonschema-form:

    react-jsonschema-form may have a steeper learning curve due to its reliance on JSON Schema for form generation. Developers need to understand JSON Schema concepts to effectively use this library.

  • jsoneditor-react:

    jsoneditor-react has a lower learning curve for React developers since it wraps the jsoneditor library in a React component. Familiarity with React concepts will make it easier to use this package.

Use Cases

  • react-json-view:

    react-json-view is perfect for applications that need to display JSON data in a user-friendly manner, such as API response viewers or debugging tools that visualize complex data structures.

  • jsoneditor:

    jsoneditor is ideal for applications that require robust JSON editing capabilities, such as data management tools, configuration editors, or any application where users need to manipulate JSON data directly.

  • react-json-editor-ajrm:

    react-json-editor-ajrm is best for lightweight applications that need basic JSON editing features, such as simple data entry forms or educational tools that allow users to experiment with JSON.

  • react-jsonschema-form:

    react-jsonschema-form is designed for applications that require dynamic forms based on structured data, such as survey applications or any form-driven interface that needs to adapt to different data schemas.

  • jsoneditor-react:

    jsoneditor-react is suitable for React applications where a rich JSON editing experience is needed, such as admin dashboards or data entry forms that require user interaction with JSON data.

Customization and Extensibility

  • react-json-view:

    react-json-view is customizable in terms of styling and behavior, allowing developers to modify how JSON data is displayed. However, it does not support editing, limiting its extensibility for interactive applications.

  • jsoneditor:

    jsoneditor offers various customization options, allowing developers to style the editor and modify its behavior through configuration options. However, extensive customization may require deeper knowledge of the library.

  • react-json-editor-ajrm:

    react-json-editor-ajrm provides limited customization options, focusing on simplicity. Developers can adjust basic styles but may find it restrictive for more complex requirements.

  • react-jsonschema-form:

    react-jsonschema-form is highly customizable, allowing developers to define custom widgets and validation rules. This makes it suitable for applications that require tailored form experiences based on user needs.

  • jsoneditor-react:

    jsoneditor-react inherits customization capabilities from jsoneditor, allowing developers to adjust the component's appearance and functionality while leveraging React's props and state management.

How to Choose: react-json-view vs jsoneditor vs react-json-editor-ajrm vs react-jsonschema-form vs jsoneditor-react
  • react-json-view:

    Use react-json-view when you need a library focused on displaying JSON data in a structured and readable format. It allows for expandable and collapsible views of JSON objects, making it perfect for applications that need to visualize JSON data rather than edit it directly.

  • jsoneditor:

    Choose jsoneditor if you need a standalone library that provides a rich, interactive interface for editing JSON data with features like tree view, text view, and validation. It is suitable for applications requiring a comprehensive JSON editing experience without being tied to React.

  • react-json-editor-ajrm:

    Select react-json-editor-ajrm if you need a simple and lightweight JSON editor that is specifically designed for React. It provides a straightforward interface for editing JSON objects and arrays, making it ideal for applications that require basic JSON editing capabilities without additional complexity.

  • react-jsonschema-form:

    Choose react-jsonschema-form if you are building forms based on JSON Schema. This library automatically generates forms from a JSON Schema definition, making it suitable for applications that require dynamic form generation and validation based on structured data.

  • jsoneditor-react:

    Opt for jsoneditor-react if you want to integrate the jsoneditor library seamlessly into a React application. This package wraps the jsoneditor library, allowing you to use it as a React component while maintaining the same features and functionality of jsoneditor.

README for react-json-view

alt text

npm npm Build Status Coverage Status

react-json-view

RJV is a React component for displaying and editing javascript arrays and JSON objects.

This component provides a responsive interface for displaying arrays or JSON in a web browser. NPM offers a distribution of the source that's transpiled to ES5; so you can include this component with any web-based javascript application.

Check out the Interactive Demo

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

alt text

Hopscotch Theme, with Triangle Icons:

alt text

Installation Instructions

Install this component with NPM.

npm install --save react-json-view

Or add to your package.json config file:

"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 bracket notation and can be expanded and collapsed by clicking 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 quotesOnKeys|boolean|true|set to false to remove quotes from keys (eg. "name": vs. name:) validationMessage|string|"Validation Error"|Custom message for validation failures to onEdit, onAdd, or onDelete callbacks displayArrayKey|boolean|true|When set to true, the index of the elements prefix values

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 now supports base-16 themes!

You can specify a theme name or object when you instantiate your rjv component.

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

Check out the list of supported themes in the component demo.

Monokai theme example

alt text

Solarized theme example

alt text

Use Your Own Theme

You can supply your own base-16 theme object.

To better understand custom themes, take a look at my example implementation and the base-16 theme styling guidelines.

onEdit, onAdd and onDelete Interaction

Pass callback methods to onEdit, onAdd and onDelete props. Your method will be invoked when a user attempts to update your src object.

The following object will be passed to your method:

{
    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
}

Returning false from a callback method will prevent the src from being affected.

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 should automatically open up http://localhost:2000 in your web browser. If it does not, open a browser and navigate to port 2000. The hot reloader will automatically reload when files are modified in the /src/ directory.

Run the Production Build

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

Please add tests for your code before posting a pull request.

You can run the test suite with npm run test or npm run test:watch to automatically reload when files are modified.

Docker Tools

I recommend using docker for development because it enforces environmental consistency.

For information about contributing with Docker, see the README in ./docker.

Inspiration

I drew a ton of design ideas from react-json-tree. Thanks to the RJT contributors for putting together an awesome component!

I'm also inspired by users who come up with interesting feature requests. Reach out to me with ideas for this project or other projects you want to collaborate on. My email address is listed on my github user page.