# react-json-tree React JSON Viewer Component, Extracted from [redux-devtools](https://github.com/reduxjs/redux-devtools). Supports [iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#iterable) objects, such as [Immutable.js](https://facebook.github.io/immutable-js/). ![](https://img.shields.io/npm/v/react-json-tree.svg) ### Usage ```jsx import { JSONTree } from 'react-json-tree'; // If you're using Immutable.js: `npm i --save immutable` import { Map } from 'immutable'; // Inside a React component: const json = { array: [1, 2, 3], bool: true, object: { foo: 'bar', }, immutable: Map({ key: 'value' }), }; ; ``` #### Result: ![](https://i.ibb.co/0KSYRJg/example-result.png) Check out [examples](examples) directory for more details. ### Theming This component now uses [react-base16-styling](https://github.com/reduxjs/redux-devtools/tree/main/packages/react-base16-styling) module, which allows to customize component via `theme` property, which can be the following: - [base16](https://github.com/chriskempson/base16) theme data. [The example theme data can be found here](https://github.com/gaearon/redux-devtools/tree/75322b15ee7ba03fddf10ac3399881e302848874/src/react/themes). - object that contains style objects, strings (that treated as classnames) or functions. A function is used to extend its first argument `{ style, className }` and should return an object with the same structure. Other arguments depend on particular context (and should be described here). See [createStylingFromTheme.js](https://github.com/reduxjs/redux-devtools/blob/main/packages/react-json-tree/src/createStylingFromTheme.ts) for the list of styling object keys. Also, this object can extend `base16` theme via `extend` property. Every theme has a light version, which is enabled with `invertTheme` prop. ```jsx const theme = { scheme: 'monokai', author: 'wimer hazenberg (http://www.monokai.nl)', base00: '#272822', base01: '#383830', base02: '#49483e', base03: '#75715e', base04: '#a59f85', base05: '#f8f8f2', base06: '#f5f4f1', base07: '#f9f8f5', base08: '#f92672', base09: '#fd971f', base0A: '#f4bf75', base0B: '#a6e22e', base0C: '#a1efe4', base0D: '#66d9ef', base0E: '#ae81ff', base0F: '#cc6633', };

; ``` #### Result (Monokai theme, dark background): ![](http://cl.ly/image/330o2L1J3V0h/screenshot%202015-08-26%20at%2010.48.24%20AM.png) #### Advanced Customization ```jsx

({ style: { ...style, textTransform: expanded ? 'uppercase' : style.textTransform, }, }), }} />

``` #### Customize Labels for Arrays, Objects, and Iterables You can pass `getItemString` to customize the way arrays, objects, and iterable nodes are displayed (optional). By default, it'll be: ```jsx {itemType} {itemString}} ``` But if you pass the following: ```jsx const getItemString = (type, data, itemType, itemString, keyPath) => ( // {type}); ``` Then the preview of child elements now look like this: ![](http://cl.ly/image/1J1a0b0T0K3c/screenshot%202015-10-07%20at%203.44.31%20PM.png) #### Customize Rendering You can pass the following properties to customize rendered labels and values: ```jsx {key}} valueRenderer={(raw) => {raw}} /> ``` In this example the label and value will be rendered with `` and `` wrappers respectively. For `labelRenderer`, you can provide a full path - [see this PR](https://github.com/chibicode/react-json-tree/pull/32). Their full signatures are: - `labelRenderer: function(keyPath, nodeType, expanded, expandable)` - `valueRenderer: function(valueAsString, value, ...keyPath)` #### More Options - `shouldExpandNodeInitially: function(keyPath, data, level)` - determines if node should be expanded when it first renders (root is expanded by default) - `hideRoot: boolean` - if `true`, the root node is hidden. - `sortObjectKeys: boolean | function(a, b)` - sorts object keys with compare function (optional). Isn't applied to iterable maps like `Immutable.Map`. - `postprocessValue: function(value)` - maps `value` to a new `value` - `isCustomNode: function(value)` - overrides the default object type detection and renders the value as a single value - `collectionLimit: number` - sets the number of nodes that will be rendered in a collection before rendering them in collapsed ranges - `keyPath: (string | number)[]` - overrides the initial key path for the root node (defaults to `[root]`) ### Credits - All credits to [Dave Vedder](http://www.eskimospy.com/) ([veddermatic@gmail.com](mailto:veddermatic@gmail.com)), who wrote the original code as [JSONViewer](https://bitbucket.org/davevedder/react-json-viewer/). - Extracted from [redux-devtools](https://github.com/gaearon/redux-devtools), which contained ES6 + inline style port of [JSONViewer](https://bitbucket.org/davevedder/react-json-viewer/) by [Daniele Zannotti](http://www.github.com/dzannotti) ([dzannotti@me.com](mailto:dzannotti@me.com)) - [Iterable support](https://github.com/gaearon/redux-devtools/pull/79) thanks to [Daniel K](https://github.com/FredyC). - npm package created by [Shu Uesugi](http://github.com/chibicode) ([shu@chibicode.com](mailto:shu@chibicode.com)) per [this issue](https://github.com/gaearon/redux-devtools/issues/85). - Improved and maintained by [Alexander Kuznetsov](https://github.com/alexkuz). The repository was merged into [`redux-devtools` monorepo](https://github.com/reduxjs/redux-devtools) from [`alexkuz/react-json-tree`](https://github.com/alexkuz/react-json-tree). ### Similar Libraries - [react-treeview](https://github.com/chenglou/react-treeview) - [react-json-inspector](https://github.com/Lapple/react-json-inspector) - [react-object-inspector](https://github.com/xyc/react-object-inspector) - [react-json-view](https://github.com/mac-s-g/react-json-view) ### License MIT

	Stars	Issues	Version	Updated	Created
react-json-to-table	35	15	0.1.7	4 years ago	6 years ago
react-json-tree			0.19.0	9 days ago	9 years ago
react-treebeard	1,686	72	3.2.4	5 years ago	8 years ago
react-ui-tree	755	47	4.0.0	6 years ago	9 years ago

react-json-to-table vs react-json-tree vs react-treebeard vs react-ui-tree

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past