To help you get started, we've collected the most common ways that react-json-view is being used within popular public projects.

rodrigopivi / aida / typescript / web / components / Editor / Editor.tsx View on Github

trainingParams?: ITrainingParams;
    testingParams?: ITestingParams;
    embeddingsAndTrainingDatasetLoaded?: boolean;
    ngramToIdDictionary?: IPretrainedDictionary['NGRAM_TO_ID_MAP'];
    pretrainedNGramVectors?: IPretrainedDictionary['PRETRAINED'];
    datasetStats?: Array<{ intent: string; training: number; testing: number }>;
}

// NOTE: for SSR, wrap the require in check for window (since it's pre rendered by gatsbyjs)
let CodeFlask: any = null;
let ReactJson: any = null;
if (typeof window !== `undefined`) {
    // tslint:disable-next-line:no-var-requires
    CodeFlask = require('codeflask').default;
    // tslint:disable-next-line:no-var-requires
    ReactJson = require('react-json-view').default;
}

export default class Editor extends React.Component {
    public state: IEditorState = {
        activeTabIndex: 0,
        downloadProgress: 0,
        error: null,
        generating: false,
        isDownloading: false,
        showDrawer: false,
        testingDataset: {},
        trainingDataset: {},
        warning: null
    };
    private tabsContainer = React.createRef() as React.RefObject;
    private codeflask: any = null;

View more ways to use react-json-view

react-json-view

RJV is a React component for displaying and editing javascript arrays and JSON objects.

This component provides a responsive interface for displaying arrays or JSON in a web browser. NPM offers a distribution of the source that's transpiled to ES5; so you can include this component with any web-based javascript application.

Check out the Interactive Demo

Implementation Example

// import the react-json-view component
import ReactJson from 'react-json-view'

// use the component in your app!

Output Examples

Default Theme

Hopscotch Theme, with Triangle Icons:

Installation Instructions

Install this component with NPM.

npm install --save react-json-view

Or add to your package.json config file:

"dependencies": {
    "react-json-view": "latest"
}

Props

Features

• 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

Customizing Style

Stock Themes

RJV now supports base-16 themes!

You can specify a theme name or object when you instantiate your rjv component.

Check out the list of supported themes in the component demo.

Monokai theme example

Solarized theme example

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.

onEdit, onAdd and onDelete Interaction

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:

{
    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.

Contributing to the source code

Run the Dev Server

# 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 https://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

# 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.

Docker Tools

I recommend using docker for development because it enforces environmental consistency.

For information about contributing with Docker, see the README in ./docker.

Inspiration

I drew a ton of design ideas from react-json-tree. Thanks to the RJT contributors for putting together an awesome component!

I'm also inspired by users who come up with interesting feature requests. Reach out to me with ideas for this project or other projects you want to collaborate on. My email address is listed on my github user page.