Skip to content

Simple json edit widget implemented as a Polymer webcomponent

Notifications You must be signed in to change notification settings

ionelmc/polymer-json-box

Repository files navigation

<polymer-json-box>

Polymer json editor widget webcomponent

Demo

Check it live!

Install

Install the component using Bower:

$ bower install json-box --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/platform/platform.js"></script>
  2. Import Custom Element:

    <link rel="import" href="bower_components/json-box/dist/json-box.html">
  3. Start using it!

    <json-box></json-box>

Options

Attribute Options Default Description
json object null Object to display in the widget

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

  • Install Bower & Grunt:

    $ [sudo] npm install -g bower grunt-cli
  • Install local dependencies:

    $ bower install && npm install
  • To test your project, start the development server and open http://localhost:8000.

    $ grunt server
  • To build the distribution files before releasing a new version.

    $ grunt build
  • To provide a live demo, send everything to gh-pages branch.

    $ grunt deploy

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

For detailed changelog, check Releases.

License

MIT License

About

Simple json edit widget implemented as a Polymer webcomponent

Resources

Stars

Watchers

Forks

Packages

No packages published