JSONForms uses HTML custom elements and eliminates the need to write HTML templates in order to create forms by leveraging the capabilities of JSON and JSON schema.
JSONForms is based on Custom elements,
which are not yet supported by all browsers, hence you'll need to include additional files in order to enable Custom Elements support:
These files are webcomponents-lite.js and native-shim.js as well as JSONForms itself via jsonforms.js.
Pay attention to the order when including these files.
Once you add a json-forms element to the DOM with at least a data attribute set,
a form will be rendered for you.
Data and UI schemas can be configured by the dataSchema and uiSchema attributes.
Use CSS to style the form however you want.
- Install JSONForms via
npm install jsonforms@next - Add
webcomponents-lite.js,native-shim.js,jsonforms.jsandjsonforms-example.cssto your HTML
<head>
<script src="/node_modules/@webcomponents/webcomponentsjs/webcomponents-lite.js"></script>
<script src="node_modules/jsonforms/lib/native-shim.js"></script>
<script src="node_modules/jsonforms/dist/jsonforms.js"></script>
<link rel="stylesheet" type="text/css" href="node_modules/jsonforms/dist/jsonforms-example.css">
</head>- Add Javascript to create a
json-formselement:
<script>
var jsonForms = document.createElement('json-forms');
jsonForms.data = {name:'John Doe'};
document.body.appendChild(jsonForms);
</script>The whole document may for example now look like this:
<!DOCTYPE html>
<html>
<head>
<script src="node_modules/jsonforms/lib/native-shim.js"></script>
<script src="node_modules/jsonforms/dist/jsonforms.js"></script>
<link rel="stylesheet" type="text/css" href="node_modules/jsonforms/dist/jsonforms-example.css">
</head>
<body></body>
<script>
var jsonForms = document.createElement('json-forms');
jsonForms.data = {name:'John Doe'};
document.body.appendChild(jsonForms);
</script>
</html>- Optional: Add you own Data and UI schema within the script
<script>
var jsonForms = document.createElement('json-forms');
jsonForms.data = {name:'John Doe'};
jsonForms.dataSchema = {type: "object", properties: {name : { type: "string"}}};
jsonForms.uiSchema = {type: "Control", scope: { $ref: "#/properties/name" } };
document.body.appendChild(jsonForms);
</script>- Install node.js(version > 4.x.x)
- Clone this repository
- Install dependencies:
npm install - Install typescript:
npm install -g typescript
- Normal Build:
npm run build - Test:
npm run test - Watch:
npm run dev, point your browser tohttp://localhost:8080/ - Build Documentation:
npm run docs
The JSONForms project is build and tested via Travis. Coverage is documented by Coveralls.
Current status: 
- Locally login as one of the (npm) owners of the package (npm doc)
- Make sure your workspace looks exactly the way you want to release it. (Files specified in .npmignore are ignored by npm)
- Run either
npm run publish-patch,npm run publish-minorornpm run publish-major.
The script does the following:
- Build JSONForms
- Generate Documentation
- Execute tests
- Increase version in package.json
- Commit version bump to the current branch
- Checkout a new temporary deploy-branch
- Commit
dist/**/*anddocs/**/*directories - Create a new version tag
- Push the version tag to 'upstream'
- Release the workspace to npmjs
If any of the steps fail the script will abort. If the script was successful you should create a pull-request with the version bump commit to 'upstream'.
The JSONForms project is licensed under the MIT License. See the LICENSE file for more information.
Our current roadmap is available here.