Giter VIP home page Giter VIP logo

json-formatter's Introduction

JSONFormatter.js (beta)

JSONFormatter takes JSON and renders it into an HTML list.

View a demo

Basic usage

This library requires jQuery

The basic usage for JSONFormatter is passing in the JSON and an empty options object:

JSONFormatter.format(json, {});

Options

An options object can can be passed as a second parameter to the format function call (defaults shown):

JSONFormatter.format(json, {
  collapse: false, // Setting to 'true' this will format the JSON into a collapsable/expandable tree
  appendTo: 'body', // A string of the id, class or element name to append the formatted json
  list_id: 'json' // The name of the id at the root ul of the formatted JSON
})

Styling

A basic stylesheet is available to layout the list slightly nicer than the default styles.

<link href='jsonFormatter.css' media='all' rel='stylesheet' type='text/css' />

To do:

  • Fix the object of objects - don't output 0:, 1:, 2:, etc.
  • Fix array of strings in first child node
  • General refactor - lots of code duplication

Development

Source hosted at GitHub. Report Issues/Feature requests on GitHub Issues.

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

json-formatter's People

Contributors

aharwood avatar andrew avatar emmasax avatar pharsadi avatar

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.