-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathJsonSchemaForms.js.html
133 lines (101 loc) · 6.98 KB
/
JsonSchemaForms.js.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: JsonSchemaForms.js</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">Source: JsonSchemaForms.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* The main module implementing the form construction.
*
* @module JsonSchemaForms
*/
'use strict';
import FormElement from './form/formElement.js';
import defaultFormOptions from './form/defaultFormOptions.js';
import $RefParser from '@apidevtools/json-schema-ref-parser';
import jquery from 'jquery';
/**
* Builds an HTML form from a given JSON Schema. The main function to be
* interacted by users.
*
* It allows to provide specific options for the form construction, and a custom
* callback function triggered on submission.
*
* @param {object} schema The JSON Schema to represent as an HTML form.
* @param {Function} [submitCallback=() => {}] Callback function to be called
* when the form triggers the `submit` DOM event.
* @param {object} customFormOptions Form options overriding the default. See
* {@link defaultFormOptions} for details.
*
* @returns {HTMLDivElement} A `<div>` element containing the HTML form.
*/
function build(schema, submitCallback = () => {}, customFormOptions = {}) {
// Builds form options by merging the provided custom options with the
// defaults.
const formOptions = {
...defaultFormOptions,
...customFormOptions,
};
// Ensures jQuery is available if Bootstrap is required but failed loading.
if (formOptions.bootstrap && !window.$) {
console.warn('Bootstrap expected but JQuery was not loaded.');
window.$ = jquery;
}
const containerDiv = document.createElement('div');
$RefParser.dereference(schema, (err, s) => {
if (err) console.error(err);
else {
// Generates the form recursively.
const rootFormElement = new FormElement(s, {
formOptions,
});
// Creates the HTML structure containing the form.
const formDiv = document.createElement('div');
const form = formDiv.appendChild(document.createElement('form'));
form.id = formOptions.formId;
form.addEventListener('submit', (event) => {
const valid = submitCallback(rootFormElement);
if (valid === false) event.preventDefault();
});
const submitButton = form.appendChild(document.createElement('button'));
submitButton.type = 'submit';
submitButton.innerText = formOptions.submitButtonText;
containerDiv.appendChild(rootFormElement.layout.root);
containerDiv.appendChild(formDiv);
if (formOptions.bootstrap) {
containerDiv.classList.add('container-fluid', 'bg-light');
formDiv.classList.add('pt-4');
submitButton.classList.add('btn', 'btn-primary');
}
}
});
return containerDiv;
}
export default { build };
</code></pre>
</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>