react-json-tree
React JSON Viewer Component, Extracted from redux-devtools . Supports iterable objects, such as Immutable.js .
Usage
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' }),
};
< JSONTree data={ json } /> ; copy
Result:
Check out examples directory for more details.
Theming
This component now uses react-base16-styling module, which allows to customize component via theme property, which can be the following:
base16 theme data. The example theme data can be found here .
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 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.
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' ,
Result (Monokai theme, dark background):
Advanced Customization
< div >
< JSONTree
data={ data }
theme={ {
extend: theme,
// underline keys for literal values
valueLabel: {
textDecoration: 'underline' ,
},
// switch key for objects to uppercase when object is expanded.
// `nestedNodeLabel` receives additional argument `expandable`
nestedNodeLabel : ({ style }, keyPath, nodeType, expanded) => ({
style: {
... style,
textTransform: expanded ? 'uppercase' : style.textTransform,
},
}),
} }
/>
</ div > copy
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:
< JSONTree getItemString={ (type, data, itemType, itemString, keyPath)
=> < span >{ itemType } { itemString }</ span >} copy
But if you pass the following:
const getItemString = (type, data, itemType, itemString, keyPath)
=> ( < span > // { type }</ span > ); copy
Then the preview of child elements now look like this:
Customize Rendering
You can pass the following properties to customize rendered labels and values:
< JSONTree
labelRenderer={ ([key]) => < strong >{ key }</ strong >}
valueRenderer={ (raw) => < em >{ raw }</ em >}
/> copy
In this example the label and value will be rendered with <strong> and <em> wrappers respectively.
For labelRenderer, you can provide a full path - see this PR .
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 (veddermatic@gmail.com ), who wrote the original code as JSONViewer .
Extracted from redux-devtools , which contained ES6 + inline style port of JSONViewer by Daniele Zannotti ( )
Similar Libraries
License
MIT