Interactive react component for displaying javascript arrays and JSON objects.
npm install seacrest-react-json-view!alt text
   
js
// import the react-json-view component
import ReactJson from 'react-json-view'
// use the component in your app!
`
$3
#### Default Theme
!alt text
#### Hopscotch Theme, with Triangle Icons:
!alt text
$3
Install this component with NPM.
`shell
npm install --save react-json-view
`
Or add to your package.json config file:
`json
"dependencies": {
"react-json-view": "latest"
}
`
$3
Name|Type|Default|Description
|:---|:---|:---|:---
src|JSON Object|None|This property contains your input JSON
name|string or false|"root"|Contains the name of your root node. Use null or false for no name.
theme|string|"rjv-default"|RJV supports base-16 themes. Check out the list of supported themes in the demo. A custom "rjv-default" theme applies by default.
style|object|{}|Style attributes for react-json-view container. Explicit style attributes will override attributes provided by a theme.
iconStyle|string|"circle"| Style of expand/collapse icons. Accepted values are "circle", triangle" or "square".
indentWidth|integer|4|Set the indent-width for nested objects
collapsed|boolean or integer|false|When set to true, all nodes will be collapsed by default. Use an integer value to collapse at a particular depth.
collapseStringsAfterLength|integer|false|When an integer value is assigned, strings will be cut off at that length. Collapsed strings are followed by an ellipsis. String content can be expanded and collapsed by clicking on the string value.
shouldCollapse|(field)=>{}|false|Callback function to provide control over what objects and arrays should be collapsed by default. An object is passed to the callback containing name, src, type ("array" or "object") and namespace.
groupArraysAfterLength|integer|100|When an integer value is assigned, arrays will be displayed in groups by count of the value. Groups are displayed with bracket notation and can be expanded and collapsed by clicking on the brackets.
onToggleCollapse|(collapse)=>{}|false|Callback function to hook into when an object or array has been expanded or collapsed. An object is passed to the callback containing expanded, name, and namespace.
enableClipboard|boolean or (copy)=>{}|true|When prop is not false, the user can copy objects and arrays to clipboard by clicking on the clipboard icon. Copy callbacks are supported.
displayObjectSize|boolean|true|When set to true, objects and arrays are labeled with size
displayDataTypes|boolean|true|When set to true, data type labels prefix values
onEdit|(edit)=>{}|false|When a callback function is passed in, edit functionality is enabled. The callback is invoked before edits are completed. Returning false from onEdit will prevent the change from being made. see: onEdit docs
onAdd|(add)=>{}|false|When a callback function is passed in, add functionality is enabled. The callback is invoked before additions are completed. Returning false from onAdd will prevent the change from being made. see: onAdd docs
defaultValue|string \|number \|boolean \|array \|object|null|Sets the default value to be used when adding an item to json
onDelete|(delete)=>{}|false|When a callback function is passed in, delete functionality is enabled. The callback is invoked before deletions are completed. Returning false from onDelete will prevent the change from being made. see: onDelete docs
onSelect|(select)=>{}|false|When a function is passed in, clicking a value triggers the onSelect method to be called.
sortKeys|boolean|false|set to true to sort object keys
quotesOnKeys|boolean|true|set to false to remove quotes from keys (eg. "name": vs. name:)
validationMessage|string|"Validation Error"|Custom message for validation failures to onEdit, onAdd, or onDelete callbacks
displayArrayKey|boolean|true|When set to true, the index of the elements prefix values
$3
* onEdit, onAdd and onDelete props allow users to edit the src variable
* Object, array, string and function values can be collapsed and expanded
* Object and array nodes display length
* Object and array nodes support a "Copy to Clipboard" feature
* String values can be truncated after a specified length
* Arrays can be subgrouped after a specified length
* Base-16 Theme Support
* When onEdit is enabled:
* Ctrl/Cmd+Click Edit Mode
* Ctrl/Cmd+Enter Submit
$3
#### Stock Themes
RJV now supports base-16 themes!
You can specify a theme name or object when you instantiate your rjv component.
`jsx
`
Check out the list of supported themes in the component demo.
#### Monokai theme example
!alt text
#### Solarized theme example
!alt text
#### Use Your Own Theme
You can supply your own base-16 theme object.
To better understand custom themes, take a look at my example implementation and the base-16 theme styling guidelines.
$3
Pass callback methods to onEdit, onAdd and onDelete props. Your method will be invoked when a user attempts to update your src object.
The following object will be passed to your method:
`js
{
updated_src: src, //new src value
name: name, //new var name
namespace: namespace, //list, namespace indicating var location
new_value: new_value, //new variable value
existing_value: existing_value, //existing variable value
}
`
Returning false from a callback method will prevent the src from being affected.
$3
#### Run the Dev Server
`bash
clone this repository
git clone git@github.com:mac-s-g/react-json-view.git && cd react-json-view
install dependencies
npm install --save-dev
run the dev server with hot reloading
npm run dev
`
Webpack Dev Server should automatically open up http://localhost:2000 in your web browser. If it does not, open a browser and navigate to port 2000. The hot reloader will automatically reload when files are modified in the /src/ directory.
#### Run the Production Build
`bash
run the build (note: you may need to use
sudo priveledges to run the build successfully)
npm run build
`
Please add tests for your code before posting a pull request.
You can run the test suite with npm run test or npm run test:watch` to automatically reload when files are modified.