onemsdk
Version:
ONEm developer library for NodeJS
4,406 lines (1,443 loc) • 57.6 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Global - Documentation
</title>
<link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<link type="text/css" rel="stylesheet" href="styles/collapse.css">
<!-- start Mixpanel -->
<script type="text/javascript">(function(e,a){if(!a.__SV){var b=window;try{var c,l,i,j=b.location,g=j.hash;c=function(a,b){return(l=a.match(RegExp(b+"=([^&]*)")))?l[1]:null};g&&c(g,"state")&&(i=JSON.parse(decodeURIComponent(c(g,"state"))),"mpeditor"===i.action&&(b.sessionStorage.setItem("_mpcehash",g),history.replaceState(i.desiredHash||"",e.title,j.pathname+j.search)))}catch(m){}var k,h;window.mixpanel=a;a._i=[];a.init=function(b,c,f){function e(b,a){var c=a.split(".");2==c.length&&(b=b[c[0]],a=c[1]);b[a]=function(){b.push([a].concat(Array.prototype.slice.call(arguments,
0)))}}var d=a;"undefined"!==typeof f?d=a[f]=[]:f="mixpanel";d.people=d.people||[];d.toString=function(b){var a="mixpanel";"mixpanel"!==f&&(a+="."+f);b||(a+=" (stub)");return a};d.people.toString=function(){return d.toString(1)+".people (stub)"};k="disable time_event track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config reset people.set people.set_once people.increment people.append people.union people.track_charge people.clear_charges people.delete_user".split(" ");
for(h=0;h<k.length;h++)e(d,k[h]);a._i.push([b,c,f])};a.__SV=1.2;b=e.createElement("script");b.type="text/javascript";b.async=!0;b.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:"file:"===e.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";c=e.getElementsByTagName("script")[0];c.parentNode.insertBefore(b,c)}})(document,window.mixpanel||[]);
mixpanel.init("1919205b2da72e4da3b9b6639b444d59");</script>
<!-- end Mixpanel -->
</head>
<body>
<svg style="display: none;">
<defs>
<symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M0 0h24v24H0z" fill="none"/>
<path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
</symbol>
</defs>
</svg>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<div class="top-nav-wrapper">
<ul>
<li >
<a href="index.html">
<svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
<path d="M0 0h24v24H0z" fill="none"/>
</svg>
</a>
</li>
</ul>
</div>
<nav>
<h3 class="reference-title">
ONEm Node.js SDK
</h3>
<h3>Classes</h3><ul><li id="ATag-nav"><a href="global.html#ATag">ATag</a><ul class='methods'><li data-type="method" id="ATag-getAttributes-nav"><a href="global.html#ATag#.getAttributes">getAttributes</a></li></ul></li><li id="ATagAttrs-nav"><a href="ATagAttrs.html">ATagAttrs</a></li><li id="BrTag-nav"><a href="global.html#BrTag">BrTag</a></li><li id="FooterTag-nav"><a href="global.html#FooterTag">FooterTag</a></li><li id="Form-nav"><a href="global.html#Form">Form</a><ul class='methods'><li data-type="method" id="Form-fromTag-nav"><a href="global.html#Form#.fromTag">fromTag</a></li></ul></li><li id="FormItemContent-nav"><a href="global.html#FormItemContent">FormItemContent</a><ul class='methods'><li data-type="method" id="FormItemContent-fromTag-nav"><a href="global.html#FormItemContent#.fromTag">fromTag</a></li></ul></li><li id="FormItemMenu-nav"><a href="global.html#FormItemMenu">FormItemMenu</a><ul class='methods'><li data-type="method" id="FormItemMenu-fromTag-nav"><a href="global.html#FormItemMenu#.fromTag">fromTag</a></li></ul></li><li id="FormItemMenuItem-nav"><a href="global.html#FormItemMenuItem">FormItemMenuItem</a><ul class='methods'><li data-type="method" id="FormItemMenuItem-fromTag-nav"><a href="global.html#FormItemMenuItem#.fromTag">fromTag</a></li></ul></li><li id="FormItemMenuMeta-nav"><a href="global.html#FormItemMenuMeta">FormItemMenuMeta</a></li><li id="FormMeta-nav"><a href="global.html#FormMeta">FormMeta</a></li><li id="FormTag-nav"><a href="global.html#FormTag">FormTag</a></li><li id="FormTagAttrs-nav"><a href="FormTagAttrs.html">FormTagAttrs</a></li><li id="HeaderTag-nav"><a href="global.html#HeaderTag">HeaderTag</a></li><li id="InputTag-nav"><a href="global.html#InputTag">InputTag</a><ul class='methods'><li data-type="method" id="InputTag-getAttributes-nav"><a href="global.html#InputTag#.getAttributes">getAttributes</a></li></ul></li><li id="InputTagAttrs-nav"><a href="InputTagAttrs.html">InputTagAttrs</a></li><li id="LiTag-nav"><a href="global.html#LiTag">LiTag</a></li><li id="LiTagAttrs-nav"><a href="LiTagAttrs.html">LiTagAttrs</a></li><li id="Menu-nav"><a href="global.html#Menu">Menu</a><ul class='methods'><li data-type="method" id="Menu-fromTag-nav"><a href="global.html#Menu#.fromTag">fromTag</a></li></ul></li><li id="MenuItem-nav"><a href="global.html#MenuItem">MenuItem</a><ul class='methods'><li data-type="method" id="MenuItem-fromTag-nav"><a href="global.html#MenuItem#.fromTag">fromTag</a></li></ul></li><li id="MenuMeta-nav"><a href="global.html#MenuMeta">MenuMeta</a></li><li id="PTag-nav"><a href="global.html#PTag">PTag</a></li><li id="Response-nav"><a href="global.html#Response">Response</a><ul class='methods'><li data-type="method" id="Response-fromTag-nav"><a href="global.html#Response#.fromTag">fromTag</a></li></ul></li><li id="SectionTag-nav"><a href="global.html#SectionTag">SectionTag</a></li><li id="SectionTagAttrs-nav"><a href="SectionTagAttrs.html">SectionTagAttrs</a></li><li id="Tag-nav"><a href="global.html#Tag">Tag</a><ul class='methods'><li data-type="method" id="Tag-fromNode-nav"><a href="global.html#Tag#.fromNode">fromNode</a></li><li data-type="method" id="Tag-getAttributes-nav"><a href="global.html#Tag#.getAttributes">getAttributes</a></li></ul></li><li id="UlTag-nav"><a href="global.html#UlTag">UlTag</a></li></ul><h3 id="global-nav">Global</h3><ul><li><a href="global.html#loadHtml">loadHtml</a></li><li><a href="global.html#loadTemplate">loadTemplate</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">
Global
</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<span class='name-container'>
<a class="link-icon" href="#loadHtml">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="loadHtml">
<span class="type-signature"></span>loadHtml<span class="signature">(htmlFile, htmlText)</span><span class="type-signature"> → {<a href="global.html#FormTag">FormTag</a>|<a href="global.html#SectionTag">SectionTag</a>|<a href="global.html#UlTag">UlTag</a>|<a href="global.html#LiTag">LiTag</a>|<a href="global.html#ATag">ATag</a>|<a href="global.html#PTag">PTag</a>|*}</span>
</h4>
</span>
<div class="description">
<p>Turns a HTML content (from file or from variable) to a Tag object</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>htmlFile</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>htmlText</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="parser.js.html">parser.js</a>, <a href="parser.js.html#line47">line 47</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#loadTemplate">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="loadTemplate">
<span class="type-signature"></span>loadTemplate<span class="signature">(templateFile, data)</span><span class="type-signature"> → {<a href="global.html#FormTag">FormTag</a>|<a href="global.html#SectionTag">SectionTag</a>|<a href="global.html#UlTag">UlTag</a>|<a href="global.html#LiTag">LiTag</a>|<a href="global.html#ATag">ATag</a>|<a href="global.html#PTag">PTag</a>|*}</span>
</h4>
</span>
<div class="description">
<p>Turns a template file to a Tag object</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>templateFile</code></td>
<td class="type">
<span class="param-type">
string
</span>
</td>
<td class="description last">
<p>The name of the template file</p>
</td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type">
object
</span>
</td>
<td class="description last">
<p>The data to fill the template with</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="parser.js.html">parser.js</a>, <a href="parser.js.html#line67">line 67</a>
</li>
</ul>
</dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<span class='name-container'>
<a class="link-icon" href="#ATag">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="ATag">
<span class="type-signature"></span>ATag<span class="type-signature"></span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>children</code></td>
<td class="type">
<span class="param-type">
Array.<string>
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>attrs</code></td>
<td class="type">
<span class="param-type">
<a href="ATagAttrs.html">ATagAttrs</a>
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="tag_a.js.html">tag/a.js</a>, <a href="tag_a.js.html#line3">line 3</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#BrTag">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="BrTag">
<span class="type-signature"></span>BrTag<span class="type-signature"></span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>children</code></td>
<td class="type">
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>attrs</code></td>
<td class="type">
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="tag_br.js.html">tag/br.js</a>, <a href="tag_br.js.html#line3">line 3</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#FooterTag">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="FooterTag">
<span class="type-signature"></span>FooterTag<span class="type-signature"></span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>children</code></td>
<td class="type">
<span class="param-type">
Array.<string>
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>attrs</code></td>
<td class="type">
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="tag_footer.js.html">tag/footer.js</a>, <a href="tag_footer.js.html#line3">line 3</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#Form">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="Form">
<span class="type-signature"></span>Form<span class="type-signature"> :object</span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
'form'
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>header</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
<p>header value</p>
</td>
</tr>
<tr>
<td class="name"><code>footer</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
<p>footer value</p>
</td>
</tr>
<tr>
<td class="name"><code>meta</code></td>
<td class="type">
<span class="param-type">
<a href="global.html#FormMeta">FormMeta</a>
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>method</code></td>
<td class="type">
<span class="param-type">
'get'
</span>
|
<span class="param-type">
'post'
</span>
|
<span class="param-type">
'put'
</span>
|
<span class="param-type">
'delete'
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">
string
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
<span class="param-type">
<a href="global.html#FormItemContent">FormItemContent</a>
</span>
|
<span class="param-type">
<a href="global.html#FormItemMenu">FormItemMenu</a>
</span>
</td>
<td class="description last">
<p>form body object</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line13">line 13</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#FormItemContent">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="FormItemContent">
<span class="type-signature"></span>FormItemContent<span class="type-signature"> :object</span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
'string'
</span>
|
<span class="param-type">
'date'
</span>
|
<span class="param-type">
'datetime'
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">
string
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>description</code></td>
<td class="type">
<span class="param-type">
string
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>header</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>footer</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line31">line 31</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#FormItemMenu">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="FormItemMenu">
<span class="type-signature"></span>FormItemMenu<span class="type-signature"> :Object</span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
'form-menu'
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
<span class="param-type">
Array.<<a href="global.html#FormItemMenuItem">FormItemMenuItem</a>>
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">
string
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>header</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>footer</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>meta</code></td>
<td class="type">
<span class="param-type">
<a href="global.html#FormItemMenuMeta">FormItemMenuMeta</a>
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line40">line 40</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#FormItemMenuItem">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="FormItemMenuItem">
<span class="type-signature"></span>FormItemMenuItem<span class="type-signature"> :object</span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
'option'
</span>
|
<span class="param-type">
'content'
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>description</code></td>
<td class="type">
<span class="param-type">
string
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line57">line 57</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#FormItemMenuMeta">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="FormItemMenuMeta">
<span class="type-signature"></span>FormItemMenuMeta<span class="type-signature"> :Object</span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>autoSelect</code></td>
<td class="type">
<span class="param-type">
boolean
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>multiSelect</code></td>
<td class="type">
<span class="param-type">
boolean
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>numbered</code></td>
<td class="type">
<span class="param-type">
boolean
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line50">line 50</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#FormMeta">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="FormMeta">
<span class="type-signature"></span>FormMeta<span class="type-signature"> :object</span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>completionStatusShow</code></td>
<td class="type">
<span class="param-type">
boolean
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>completionStatusInHeader</code></td>
<td class="type">
<span class="param-type">
boolean
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>confirmationNeeded</code></td>
<td class="type">
<span class="param-type">
boolean
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line24">line 24</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#FormTag">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="FormTag">
<span class="type-signature"></span>FormTag<span class="type-signature"></span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>children</code></td>
<td class="type">
<span class="param-type">
Array.<<a href="global.html#SectionTag">SectionTag</a>>
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>attrs</code></td>
<td class="type">
<span class="param-type">
<a href="FormTagAttrs.html">FormTagAttrs</a>
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="tag_form.js.html">tag/form.js</a>, <a href="tag_form.js.html#line4">line 4</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#HeaderTag">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="HeaderTag">
<span class="type-signature"></span>HeaderTag<span class="type-signature"></span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>children</code></td>
<td class="type">
<span class="param-type">
Array.<string>
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>attrs</code></td>
<td class="type">
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="tag_header.js.html">tag/header.js</a>, <a href="tag_header.js.html#line2">line 2</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#InputTag">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="InputTag">
<span class="type-signature"></span>InputTag<span class="type-signature"></span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>children</code></td>
<td class="type">
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>attrs</code></td>
<td class="type">
<span class="param-type">
<a href="InputTagAttrs.html">InputTagAttrs</a>
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="tag_input.js.html">tag/input.js</a>, <a href="tag_input.js.html#line2">line 2</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#LabelTag">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="LabelTag">
<span class="type-signature"></span>LabelTag<span class="type-signature"></span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>children</code></td>
<td class="type">
<span class="param-type">
Array.<string>
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>attrs</code></td>
<td class="type">
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="tag_label.js.html">tag/label.js</a>, <a href="tag_label.js.html#line3">line 3</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#LiTag">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="LiTag">
<span class="type-signature"></span>LiTag<span class="type-signature"></span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>children</code></td>
<td class="type">
<span class="param-type">
Array.<(<a href="global.html#ATag">ATag</a>|string)>
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>attrs</code></td>
<td class="type">
<span class="param-type">
<a href="LiTagAttrs.html">LiTagAttrs</a>
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="tag_li.js.html">tag/li.js</a>, <a href="tag_li.js.html#line4">line 4</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#Menu">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="Menu">
<span class="type-signature"></span>Menu<span class="type-signature"> :Object</span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
'menu'
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
<span class="param-type">
Array.<<a href="global.html#MenuItem">MenuItem</a>>
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>header</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>footer</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>meta</code></td>
<td class="type">
<span class="param-type">
<a href="global.html#MenuMeta">MenuMeta</a>
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line64">line 64</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#MenuItem">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="MenuItem">
<span class="type-signature"></span>MenuItem<span class="type-signature"> :object</span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
'option'
</span>
|
<span class="param-type">
'content'
</span>
</td>
<td class="default">
</td>
<td class="description last">
<p>indicating menu option or plain content</p>
</td>
</tr>
<tr>
<td class="name"><code>description</code></td>
<td class="type">
<span class="param-type">
string
</span>
</td>
<td class="default">
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>path</code></td>
<td class="type">
<span class="param-type">
string
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="default">
</td>
<td class="description last">
<p>For menu options only. Path to be used for HTTP callback (added to base path configured in app's settings in developer portal)</p>
</td>
</tr>
<tr>
<td class="name"><code>method</code></td>
<td class="type">
<span class="param-type">
'get'
</span>
|
<span class="param-type">
'post'
</span>
|
<span class="param-type">
'put'
</span>
|
<span class="param-type">
'delete'
</span>
|
<span class="param-type">
undefined
</span>
</td>
<td class="default">
get
</td>
<td class="description last">
<p>For menu options only. HTTP method that should be used when redirecting after successful menu option submission</p>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line78">line 78</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#MenuMeta">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="MenuMeta">
<span class="type-signature"></span>MenuMeta<span class="type-signature"> :Object</span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>autoSelect</code></td>
<td class="type">
<span class="param-type">
boolean
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line73">line 73</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#PTag">
<svg height="20" width="20" style="fill: black;">
<use xlink:href="#linkIcon"></use>
</svg>
</a>
<h4 class="name" id="PTag">
<span class="type-signature"></span>PTag<span class="type-signature"></span>
</h4>
</span>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>children</code></td>
<td class="type">
<span class="param-type">
Array.<string>
</span>
</td>
<td class="description last">
</td>
</tr>
<tr>
<td class="name"><code>attrs</code></td>
<td class="type">
<span class="param-type">
undefined
</span>
</td>
<td class="description last">
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="tag_p.js.html">tag/p.js</a>, <a href="tag_p.js.html#line3">line 3</a>
</li>
</ul>
</dd>
</dl>
<span class='name-container'>
<a class="link-icon" href="#Response">
<svg height="20" wi