-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathindex.html
165 lines (122 loc) · 11 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Home</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Home</h1>
<h3> </h3>
<section>
<article><h1>JsonSchemaForms</h1>
<p>A JavaScript tool that generates HTML forms from JSON Schemas.</p>
<p>This implementation accepts schemas following the <a href="https://json-schema.org/">JSON Schema Draft 2019-09 specification</a>, with the goal of providing a straightforward mean to express potentially large and complex JSON Schemas in an intuitive fashion.</p>
<p>JsonSchemaForms comes with <a href="https://getbootstrap.com/">Bootstrap</a> (4.5+) and <a href="https://fontawesome.com/">Font Awesome</a> (5.13+) support in order to organize and decorate the layout. While these libraries are not required, they are highly recommended to get the form properly rendered by the browser.</p>
<p>JsonSchemaForms makes use of the <a href="https://github.com/APIDevTools/json-schema-ref-parser">JSON Schema $Ref Parser</a> to resolve and dereference the schemas to be processed.</p>
<h2>Usage</h2>
<p>The JsonSchemaForms module provides a <code>build()</code> function that performs the whole process of analyzing a JSON Schema and generating the DOM and internal representation of the form. Have a look at the <a href="https://hblanko.github.io/json-schema-forms/module-JsonSchemaForms.html"><code>JsonSchemaForms.build()</code> API</a> for usage details.</p>
<h3>Through CDN</h3>
<p>The quickly and easy way to make JsonSchemaForms available to your scripts, by adding a few CDN links to your HTML code.</p>
<p>JsonSchemaForms provides a script and style sheet that can be linked adding the following tags:</p>
<pre class="prettyprint source lang-html"><code><link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/json-schema-forms@latest/css/json-schema-forms.min.css" />
</code></pre>
<pre class="prettyprint source lang-html"><code><script src="https://cdn.jsdelivr.net/npm/json-schema-forms@latest/dist/json-schema-forms.min.js"></script>
</code></pre>
<p>On top of that, as mentioned before, Bootstrap and Font Awesome allow for a nice-looking result, so their CDN links are recommended to be included, too.</p>
<p>Hence, the full picture of a barebone <code>example.html</code> using JsonSchemaForms CDN ends up looking like this:</p>
<pre class="prettyprint source lang-html"><code><!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<!-- Bootstrap-related style -->
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous" />
<!-- JsonSchemaForms style sheet -->
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/json-schema-forms@latest/css/json-schema-forms.min.css" />
</head>
<body>
<!-- Bootstrap and Font Awesome scripts -->
<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
<script src="https://kit.fontawesome.com/64968f57be.js" crossorigin="anonymous"></script>
<!-- JsonSchemaForms script -->
<script src="https://cdn.jsdelivr.net/npm/json-schema-forms@latest/dist/json-schema-forms.min.js"></script>
<!-- Your script -->
<script src="./example.js"></script>
<!-- Some containers to use by your script -->
<div id="form-container"></div>
<pre id="json-result"></pre>
</body>
</html>
</code></pre>
<p>A basic script <code>example.js</code> may look like this:</p>
<pre class="prettyprint source lang-javascript"><code>// You've got two options in order to plug your JSON Schema:
// 1. Provide a URL to a JSON Schema.
// 2. Directly assign an object following the JSON Schema format.
// const schema = 'http://landarltracker.com/schemas/test.json';
const schema = {
title: 'The Root Form Element',
description: 'Easy, right?',
type: 'string',
};
// Also, you can define the form behavior on submission, e.g.:
const submitCallback = (rootFormElement) => {
// Show the resulting JSON instance in your page.
document.getElementById('json-result').innerText = JSON.stringify(
rootFormElement.getInstance(),
null,
2
);
// (For testing purposes, return false to prevent automatic redirect.)
return false;
};
// Finally, get your form...
const jsonSchemaForm = JsonSchemaForms.build(schema, submitCallback);
// ... and attach it somewhere to your page.
window.addEventListener('load', () => {
document.getElementById('form-container').appendChild(jsonSchemaForm);
});
</code></pre>
<p>This example works directly out of the box. Feel free to copy, paste, and play around with it!</p>
<h3>Custom bundle</h3>
<p>If you prefer to import it into your own project, use your favorite package manager to install it:</p>
<pre class="prettyprint source lang-console"><code>yarn add json-schema-forms
</code></pre>
<p>or</p>
<pre class="prettyprint source lang-console"><code>npm i json-schema-forms
</code></pre>
<p>And just make it available by including at the top of your script:</p>
<pre class="prettyprint source lang-javascript"><code>import JsonSchemaForms from 'json-schema-forms';
</code></pre>
<p>Then, you can use it as shown in <code>example.js</code> through the <code>build()</code> function
(check <a href="https://hblanko.github.io/json-schema-forms/module-JsonSchemaForms.html">the API docs</a> for detailed information).</p>
<h2>What's to come?</h2>
<p>Base code is still under work, being several features not yet covered (but expected to be):</p>
<ul>
<li>Conditional in-place applicators.</li>
<li>Some child applicators (e.g. <code>patternProperties</code>) and validation keywords.</li>
<li>Aggregation logic yet to be implemented for several keywords.</li>
</ul>
<p><em>JsonSchemaForms was initially conceived as a basis for a specialized version to be used in the framework of <a href="https://github.com/hblanko/cookbase">the Cookbase Project</a>.</em></p></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-childApplicators.html">childApplicators</a></li><li><a href="module-components.html">components</a></li><li><a href="module-formElement.html">formElement</a></li><li><a href="module-formElementDefinitions.html">formElementDefinitions</a></li><li><a href="module-inPlaceApplicators.html">inPlaceApplicators</a></li><li><a href="module-JsonSchemaForms.html">JsonSchemaForms</a></li><li><a href="module-JsonSchemaKeywords.html">JsonSchemaKeywords</a></li><li><a href="module-JsonSchemaType.html">JsonSchemaType</a></li><li><a href="module-layouts.html">layouts</a></li><li><a href="module-selectors.html">selectors</a></li></ul><h3>Classes</h3><ul><li><a href="module-childApplicators-AdditionalItems.html">AdditionalItems</a></li><li><a href="module-childApplicators-AdditionalProperties.html">AdditionalProperties</a></li><li><a href="module-childApplicators-ArrayHandler.html">ArrayHandler</a></li><li><a href="module-childApplicators-ChildrenHandler.html">ChildrenHandler</a></li><li><a href="module-childApplicators-Items.html">Items</a></li><li><a href="module-childApplicators-ObjectHandler.html">ObjectHandler</a></li><li><a href="module-childApplicators-Properties.html">Properties</a></li><li><a href="module-components-AddButton.html">AddButton</a></li><li><a href="module-components-BooleanInput.html">BooleanInput</a></li><li><a href="module-components-GeneratorIcon.html">GeneratorIcon</a></li><li><a href="module-components-InputTitle.html">InputTitle</a></li><li><a href="module-components-InstanceViewPanel.html">InstanceViewPanel</a></li><li><a href="module-components-LabelTitle.html">LabelTitle</a></li><li><a href="module-components-NumericInput.html">NumericInput</a></li><li><a href="module-components-PillsInstancePanel.html">PillsInstancePanel</a></li><li><a href="module-components-RemoveButton.html">RemoveButton</a></li><li><a href="module-components-RequiredIcon.html">RequiredIcon</a></li><li><a href="module-components-RootIcon.html">RootIcon</a></li><li><a href="module-components-Select.html">Select</a></li><li><a href="module-components-SelectInstancePanel.html">SelectInstancePanel</a></li><li><a href="module-components-TextInput.html">TextInput</a></li><li><a href="module-components-Toggler.html">Toggler</a></li><li><a href="module-formElementDefinitions-State.html">State</a></li><li><a href="module-formElement-FormElement.html">FormElement</a></li><li><a href="module-inPlaceApplicators-Aggregation.html">Aggregation</a></li><li><a href="module-inPlaceApplicators-InPlaceApplicator.html">InPlaceApplicator</a></li><li><a href="module-inPlaceApplicators-IPASchema.html">IPASchema</a></li><li><a href="module-layouts-Layout.html">Layout</a></li><li><a href="module-selectors-Selector.html">Selector</a></li><li><a href="module-selectors-SelectorsContainer.html">SelectorsContainer</a></li><li><a href="module-selectors-SelectorsToolbar.html">SelectorsToolbar</a></li></ul><h3>Interfaces</h3><ul><li><a href="module-childApplicators-ChildApplicator.html">ChildApplicator</a></li><li><a href="module-components-Component.html">Component</a></li><li><a href="module-components-InputComponent.html">InputComponent</a></li></ul><h3>Global</h3><ul><li><a href="global.html#defaultFormOptions">defaultFormOptions</a></li><li><a href="global.html#formElementByDiv">formElementByDiv</a></li><li><a href="global.html#lcm">lcm</a></li><li><a href="global.html#pointerToId">pointerToId</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a>
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>