GithubHelp home page GithubHelp logo

gaearon / react-json-tree Goto Github PK

View Code? Open in Web Editor NEW

This project forked from alexkuz/react-json-tree

5.0 2.0 1.0 274 KB

React JSON Viewer Component, Extracted from redux-devtools

License: MIT License

JavaScript 100.00%

react-json-tree's Introduction

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

Result:

Check out examples directory for more details.

Theming

You can pass a theme prop containing base16 theme data to change the theme. The example theme data can be found here.

(The theme data is also used by redux-devtools, and extracting it to a separate npm package is a TODO).

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'
};

<div style={{ backgroundColor: theme.base00 }}>
  <JSONTree data={ data } theme={ theme } />
</div>

Result (Monokai theme, dark background):

Customization

Customize CSS

You can pass the following properties to customize styling (all optional):

<JSONTree getArrowStyle={(type, expanded) => ({})}
    getItemStringStyle={(type, expanded) => ({})}
    getListStyle={(type, expanded) => ({})}
    getLabelStyle={(type, expanded) => ({})}
    getValueStyle={(type, expanded) => ({})} />

Here type is a string representing type of data, expanded is a current state for expandable items. Each function returns a style object, which extends corresponding default style.

For example, if you pass the following function:

const getStyle = (type, expanded) =>
  (expanded ? { textTransform: 'uppercase' } :
              { textTransform: 'lowercase' });

Then expanded nodes will all be in uppercase:

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 getArrowStyle={(type, data, itemType, itemString)
  => <span>{itemType} {itemString}</span>}

But if you pass the following:

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

Then the preview of child elements now look like this:

Credits

Similar Libraries

License

MIT

react-json-tree's People

Contributors

alexkuz avatar chibicode avatar cpylua avatar evansimpson avatar jasisk avatar liamkennedy89 avatar mdziekon avatar pbomb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

rubythonode

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.