React JSON Pretty

!MIT license

Introduction

This is a lightweight and tiny react component that helps you to format and prettify the JSON data.

Install

``bash
npm install --save react-json-pretty
`

Usage

$3

The usage is quite simple, assuming that you already have an application using React. If you don't, visit Facebook React to create one or take a look at the example provided.

Firstly, you need to require the react-json-pretty:

`javascript
var JSONPretty = require('react-json-pretty');
`
Or use the es2015 syntax with the help of tools like babel:

`javascript
import JSONPretty from 'react-json-pretty';
`

Next, use it in your React component:

`jsx

`

Where the property data is the JSON string or just a plain JavaScript object.

Lastly, you can add themes stated below.

Note: if yourData is not a plain object, use circular-json or other similar tools to preprocess it before being passed to JSONPretty.

$3

#### Use themes with css-loader and webpack

And also you can import the style to the document, here is an example of using webpack loaders(style!css) to load style, You can visit webpack to get more details:

`javascript
require('react-json-pretty/themes/monikai.css');
`

Or

`javascript
import 'react-json-pretty/themes/monikai.css';
`

#### Use themes with theme property

If you don't want to use css, theme property is also available. Properties of theme will be used as style property of the target DOM element.

`jsx
var JSONPrettyMon = require('react-json-pretty/dist/monikai');

`

Visit the example to get some details.

The preview is as below:

!previews, you can also find it in the example folder

Others

$3

Use onJSONPrettyError function property to get JSON.parse errors.

`jsx
console.error(e)}>
`

$3

Actually, react-json-pretty is based on JSON.stringify(value[, replacer[, space]]). However, JSON.stringify(value[, replacer[, space]]) has some optional parameters additionally such as replacer and space. This is also available in react-json-pretty.

Here is an example:

`jsx
function (key, value) {
if (key === 'cccc') {
value += '~~~abc';
}
if (key === 'gggg') {
value *=10;
}
return value;
}
} space="4"
>

`

Note: The default value for property replacer is null，and space is 2.

You can visit the example to see the details.

$3

Your can also define your custome themeClassName, the default value is __json-pretty__.

Note: this may lead to the usage of default themes provided with css being invalid.

`jsx
// The final className will be 'custom-json-pretty'

`

$3

There are some default themes provided including "Adventure Time", acai and 1337, to provide users more ready-made options.

!Adventure Time
!1337
!acai

All the css theme files are placed in the themes folder.

It is also prossible to define a custom theme:

#### Using typeStyle property

This can make control the extra styles of the specific type of value:

`
mainStyle?: string;
keyStyle?: string;
valueStyle?: string;
booleanStyle?: string;
stringStyle?: string;
errorStyle: string;
`

For example: set padding of the main area and the font size the normal value

`jsx

`

#### Using themes property

Here is the property schema:

`
{
main?: string,
error?: string,
key?: string,
string?: string,
value?: string,
boolean?: string'
}
`

For example:

`js
{
main: 'line-height:1.3;color:#66d9ef;background:#272822;overflow:auto;',
error: 'line-height:1.3;color:#66d9ef;background:#272822;overflow:auto;',
key: 'color:#f92672;',
string: 'color:#fd971f;',
value: 'color:#a6e22e;',
boolean: 'color:#ac81fe;',
}
`

#### Using css file

For example the monokai.styl:

`
.__json-pretty__
line-height 1.3
color rgba(248,248,242,1)
background #1e1e1e
overflow auto

.__json-key__
color rgba(255,94,94,1)

.__json-value__
color rgba(253,176,130,1)

.__json-string__
color rgba(233,253,172,1)

.__json-boolean__
color rgba(102,153,204,1)

.__json-pretty-error__
line-height 1.3
color rgba(248,248,242,1)
background #1e1e1e
overflow auto
``

License

MIT (http://www.opensource.org/licenses/mit-license.php)