Repository files navigation

React JSON Viewer Component, Extracted fromredux-devtools. Supportsiterable objects, such asImmutable.js.

importJSONTreefrom'react-json-tree'// If you're using Immutable.js: `npm i --save immutable`import{Map}from'immutable'// Inside a React component:constjson={array:[1,2,3],bool:true,object:{foo:'bar'},immutable:Map({key:'value'})}<JSONTreedata={json}/>

Check outexamples directory for more details.

This component now usesreact-base16-styling module, which allows to customize component viatheme 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). SeecreateStylingFromTheme.js for the list of styling object keys. Also, this object can extendbase16 theme viaextend property.

Every theme has a light version, which is enabled withinvertTheme prop.

consttheme={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'};<div><JSONTreedata={data}theme={theme}invertTheme={false}/></div>

<div><JSONTreedata={data}theme={{extend:theme,// underline keys for literal valuesvalueLabel:{textDecoration:'underline'},// switch key for objects to uppercase when object is expanded.// `nestedNodeLabel` receives additional arguments `expanded` and `keyPath`nestedNodeLabel:({ style},nodeType,expanded)=>({style:{        ...style,textTransform:expanded ?'uppercase' :style.textTransform}})}}/></div>

You can passgetItemString to customize the way arrays, objects, and iterable nodes are displayed (optional).

By default, it'll be:

<JSONTreegetItemString={(type,data,itemType,itemString)=><span>{itemType}{itemString}</span>}

But if you pass the following:

constgetItemString=(type,data,itemType,itemString)=>(<span> //{type}</span>);

Then the preview of child elements now look like this:

You can pass the following properties to customize rendered labels and values:

<JSONTreelabelRenderer={raw=><strong>{raw}</strong>}valueRenderer={raw=><em>{raw}</em>}/>

In this example the label and value will be rendered with<strong> and<em> wrappers respectively.

ForlabelRenderer, you can provide a full path -see this PR.

• shouldExpandNode: function(keyName, data, level) - determines if node should be expanded (root is expanded by default)
• hideRoot: Boolean - iftrue, the root node is hidden.
• sortObjectKeys: Boolean | function(a, b) - sorts object keys with compare function (optional). Isn't applied to iterable maps likeImmutable.Map.

• All credits toDave Vedder (veddermatic@gmail.com), who wrote the original code asJSONViewer.
• Extracted fromredux-devtools, which contained ES6 + inline style port ofJSONViewer byDaniele Zannotti (dzannotti@me.com)
• Iterable support thanks toDaniel K.
• npm package created byShu Uesugi (shu@chibicode.com) perthis issue.

• react-treeview
• react-json-inspector
• react-object-inspector
• react-json-view

MIT