Giter VIP home page Giter VIP logo

view-json-react's Introduction

JsonViewer Component Library

Welcome to the JsonViewer component library! This React-based tool is designed to render JSON data in a beautifully structured, collapsible format. It offers a convenient and intuitive way to visualize JSON structures, with features that enhance both functionality and user experience.

Features

  • Collapsible JSON View: Toggle visibility for sections of your JSON data for improved readability.
  • Customizable Expansion Level: Define the initial expansion level to tailor the display of your JSON data.
  • Copy Functionality: Enable users to copy data elements directly from the viewer.
  • Custom Styling: Style the JSON viewer to seamlessly integrate with your application's aesthetics.
  • Root Name Customization: Assign a custom name to the root node of your JSON structure for clearer representation.

Installation

Install the JsonViewer component library with npm:

npm install view-json-react

Or with Yarn:

yarn add view-json-react

Usage

Incorporate the JsonViewer component into your React application like so:

import React from 'react';
import { JsonViewer } from 'view-json-react';

const App = () => {
  const jsonData = {
    /* your JSON data */
  };

  return <JsonViewer data={jsonData} expandLevel={1} />;
};

export default App;

Props

The JsonViewer component accepts the following props:

  • data (required): The JSON data to visualize.
  • rootName (optional): Name for the root node. No root name if not specified.
  • style (optional): CSS properties for custom styling.
  • expandLevel (optional, default: 0): Initial JSON structure expansion level.
  • onCopy (optional): Callback for the copy action.

Customization

Styling

Apply custom styles via the style prop:

<JsonViewer
  data={yourData}
  style={{ backgroundColor: '#282c34', color: '#61dafb' }}
/>

Copy Functionality

Enable data copying with the onCopy prop:

<JsonViewer
  data={yourData}
  onCopy={copyData => console.log('Copied data:', copyData)}
/>

Contributing

We welcome contributions! Feel free to open an issue or submit a pull request for any bugs, feature requests, or improvements.

License

JsonViewer is made available under the MIT License. See the LICENSE file for more details.

view-json-react's People

Watchers

 avatar

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.