https://github.com/ionelmc/polymer-json-box
Simple json edit widget implemented as a Polymer webcomponent
https://github.com/ionelmc/polymer-json-box
Last synced: 7 months ago
JSON representation
Simple json edit widget implemented as a Polymer webcomponent
- Host: GitHub
- URL: https://github.com/ionelmc/polymer-json-box
- Owner: ionelmc
- Created: 2014-08-01T17:31:08.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2014-09-10T10:17:59.000Z (about 11 years ago)
- Last Synced: 2025-02-24T22:05:12.147Z (7 months ago)
- Language: JavaScript
- Size: 844 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# <polymer-json-box>
> Polymer json editor widget webcomponent
## Demo
[Check it live!](http://ionelmc.github.io/polymer-json-box)
## Install
Install the component using [Bower](http://bower.io/):
```sh
$ bower install json-box --save
```
Or [download as ZIP](https://github.com/ionelmc/polymer-json-box/archive/master.zip).
## Usage
1. Import Web Components' polyfill:
```html
```
2. Import Custom Element:
```html
```
3. Start using it!
```html
```
## 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](http://bower.io/) & [Grunt](http://gruntjs.com/):
```sh
$ [sudo] npm install -g bower grunt-cli
```
* Install local dependencies:
```sh
$ bower install && npm install
```
* To test your project, start the development server and open `http://localhost:8000`.
```sh
$ grunt server
```
* To build the distribution files before releasing a new version.
```sh
$ grunt build
```
* To provide a live demo, send everything to `gh-pages` branch.
```sh
$ 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](https://github.com/ionelmc/polymer-json-box/releases).
## License
[MIT License](http://opensource.org/licenses/MIT)