onemsdk

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> FormItem - 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">  <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>  </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"> NodeJS ONEm SDK </h3> <h3>Classes</h3><ul><li id="Form-nav"><a href="Form.html">Form</a><ul class='methods'><li data-type="method" id="Form-fromTag-nav"><a href="Form.html#.fromTag">fromTag</a></li></ul></li><li id="FormItem-nav"><a href="FormItem.html">FormItem</a><ul class='methods'><li data-type="method" id="FormItem-fromTag-nav"><a href="FormItem.html#.fromTag">fromTag</a></li></ul></li><li id="FormMeta-nav"><a href="FormMeta.html">FormMeta</a></li><li id="Menu-nav"><a href="Menu.html">Menu</a><ul class='methods'><li data-type="method" id="Menu-fromTag-nav"><a href="Menu.html#.fromTag">fromTag</a></li></ul></li><li id="MenuFormItemMeta-nav"><a href="MenuFormItemMeta.html">MenuFormItemMeta</a></li><li id="MenuItem-nav"><a href="MenuItem.html">MenuItem</a><ul class='methods'><li data-type="method" id="MenuItem-fromTag-nav"><a href="MenuItem.html#.fromTag">fromTag</a></li></ul></li><li id="MenuItemFormItem-nav"><a href="MenuItemFormItem.html">MenuItemFormItem</a><ul class='methods'><li data-type="method" id="MenuItemFormItem-fromTag-nav"><a href="MenuItemFormItem.html#.fromTag">fromTag</a></li></ul></li><li id="MenuMeta-nav"><a href="MenuMeta.html">MenuMeta</a></li><li id="Response-nav"><a href="Response.html">Response</a><ul class='methods'><li data-type="method" id="Response-fromTag-nav"><a href="Response.html#.fromTag">fromTag</a></li></ul></li></ul> </nav> <div id="main"> <h1 class="page-title"> FormItem </h1> <section> <header> <h2> FormItem </h2> <div class="class-description"> <p>A FormItem object as defined in the JSON schema</p> </div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <span class='name-container'> <a class="link-icon" href="#FormItem"> <svg height="20" width="20" style="fill: black;"> <use xlink:href="#linkIcon"></use> </svg> </a> <h4 class="name" id="FormItem"> <span class="type-signature"></span>new FormItem<span class="signature">(props)</span><span class="type-signature"></span> </h4> </span> <div class="description"> <p>Instantiates a new FormItem</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>props</code></td> <td class="type"> <span class="param-type"> object </span> </td> <td class="description last"> <p>Properties to initialize the form item with</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</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"> 'string' </span> | <span class="param-type"> 'date' </span> | <span class="param-type"> 'datetime' </span> | <span class="param-type"> 'int' </span> | <span class="param-type"> 'float' </span> | <span class="param-type"> 'hidden' </span> | <span class="param-type"> 'form-menu' </span> | <span class="param-type"> 'email' </span> | <span class="param-type"> 'url' </span> | <span class="param-type"> 'location' </span> | <span class="param-type"> 'regex' </span> | <span class="param-type"> 'tel' </span> | <span class="param-type"> 'phone' </span> | <span class="param-type"> 'textarea' </span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#type"><code>FormItem#type</code></a></p> </td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#name"><code>FormItem#name</code></a></p> </td> </tr> <tr> <td class="name"><code>description</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#description"><code>FormItem#description</code></a></p> </td> </tr> <tr> <td class="name"><code>header</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#header"><code>FormItem#header</code></a></p> </td> </tr> <tr> <td class="name"><code>footer</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#footer"><code>FormItem#footer</code></a></p> </td> </tr> <tr> <td class="name"><code>body</code></td> <td class="type"> <span class="param-type"> Array.<<a href="MenuItemFormItem.html">MenuItemFormItem</a>> </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#body"><code>FormItem#body</code></a></p> </td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#value"><code>FormItem#value</code></a></p> </td> </tr> <tr> <td class="name"><code>chunkingFooter</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#chunkingFooter"><code>FormItem#chunkingFooter</code></a></p> </td> </tr> <tr> <td class="name"><code>confirmationLabel</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#confirmationLabel"><code>FormItem#confirmationLabel</code></a></p> </td> </tr> <tr> <td class="name"><code>minLength</code></td> <td class="type"> <span class="param-type"> number </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#minLength"><code>FormItem#minLength</code></a>. It must be integer.</p> </td> </tr> <tr> <td class="name"><code>minLengthError</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#minLengthError"><code>FormItem#minLengthError</code></a></p> </td> </tr> <tr> <td class="name"><code>maxLength</code></td> <td class="type"> <span class="param-type"> number </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#maxLength"><code>FormItem#maxLength</code></a>. It must be integer.</p> </td> </tr> <tr> <td class="name"><code>maxLengthError</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#maxLengthError"><code>FormItem#maxLengthError</code></a></p> </td> </tr> <tr> <td class="name"><code>minValue</code></td> <td class="type"> <span class="param-type"> number </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#minValue"><code>FormItem#minValue</code></a></p> </td> </tr> <tr> <td class="name"><code>minValueError</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#minValueError"><code>FormItem#minValueError</code></a></p> </td> </tr> <tr> <td class="name"><code>maxValue</code></td> <td class="type"> <span class="param-type"> number </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#maxValue"><code>FormItem#maxValue</code></a></p> </td> </tr> <tr> <td class="name"><code>maxValueError</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#maxValueError"><code>FormItem#maxValueError</code></a></p> </td> </tr> <tr> <td class="name"><code>step</code></td> <td class="type"> <span class="param-type"> number </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#step"><code>FormItem#step</code></a></p> </td> </tr> <tr> <td class="name"><code>meta</code></td> <td class="type"> <span class="param-type"> <a href="MenuFormItemMeta.html">MenuFormItemMeta</a> </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#meta"><code>FormItem#meta</code></a></p> </td> </tr> <tr> <td class="name"><code>method</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#method"><code>FormItem#method</code></a></p> </td> </tr> <tr> <td class="name"><code>required</code></td> <td class="type"> <span class="param-type"> boolean </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"> <p>Sets <a href="FormItem.html#required"><code>FormItem#required</code></a></p> </td> </tr> <tr> <td class="name"><code>default</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#default"><code>FormItem#default</code></a></p> </td> </tr> <tr> <td class="name"><code>pattern</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#pattern"><code>FormItem#pattern</code></a></p> </td> </tr> <tr> <td class="name"><code>statusExclude</code></td> <td class="type"> <span class="param-type"> boolean </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"> <p>Sets <a href="FormItem.html#statusExclude"><code>FormItem#statusExclude</code></a></p> </td> </tr> <tr> <td class="name"><code>statusPrepend</code></td> <td class="type"> <span class="param-type"> boolean </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"> <p>Sets <a href="FormItem.html#statusPrepend"><code>FormItem#statusPrepend</code></a></p> </td> </tr> <tr> <td class="name"><code>url</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#url"><code>FormItem#url</code></a></p> </td> </tr> <tr> <td class="name"><code>validateTypeError</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#validateTypeError"><code>FormItem#validateTypeError</code></a></p> </td> </tr> <tr> <td class="name"><code>validateTypeErrorFooter</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#validateTypeErrorFooter"><code>FormItem#validateTypeErrorFooter</code></a></p> </td> </tr> <tr> <td class="name"><code>validateUrl</code></td> <td class="type"> <span class="param-type"> string </span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>Sets <a href="FormItem.html#validateUrl"><code>FormItem#validateUrl</code></a></p> </td> </tr> </tbody> </table> </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#line161">line 161</a> </li> </ul> </dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="body"> <span class="type-signature"></span>body<span class="type-signature"> :Array.<<a href="MenuItemFormItem.html">MenuItemFormItem</a>></span> </h4> <div class="description"> <p>Composed of <a href="MenuItemFormItem.html"><code>MenuItemFormItem</code></a> objects <br> <em>required only for <code>type=form-menu</code></em>.</p> </div> <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#line250">line 250</a> </li> </ul> </dd> </dl> <h4 class="name" id="chunkingFooter"> <span class="type-signature"></span>chunkingFooter<span class="type-signature"> :string</span> </h4> <div class="description"> <p>Shown in the footer of the sms chunks.</p> </div> <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#line272">line 272</a> </li> </ul> </dd> </dl> <h4 class="name" id="confirmationLabel"> <span class="type-signature"></span>confirmationLabel<span class="type-signature"> :string</span> </h4> <div class="description"> <p>Shown in the confirmation menu.</p> </div> <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#line280">line 280</a> </li> </ul> </dd> </dl> <h4 class="name" id="default"> <span class="type-signature"></span>default<span class="type-signature"> :string</span> </h4> <div class="description"> <p>A default value in case of non required form items</p> </div> <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#line384">line 384</a> </li> </ul> </dd> </dl> <h4 class="name" id="description"> <span class="type-signature"></span>description<span class="type-signature"> :string</span> </h4> <div class="description"> <p>The description of this <code>FormItem</code>.</p> </div> <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#line226">line 226</a> </li> </ul> </dd> </dl> <h4 class="name" id="footer"> <span class="type-signature"></span>footer<span class="type-signature"> :string</span> </h4> <div class="description"> <p>If provided will overwrite the <a href="Form.html#footer"><code>Form#footer</code></a>.</p> </div> <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#line242">line 242</a> </li> </ul> </dd> </dl> <h4 class="name" id="header"> <span class="type-signature"></span>header<span class="type-signature"> :string</span> </h4> <div class="description"> <p>If provided will overwrite the <a href="Form.html#header"><code>Form#header</code></a>.</p> </div> <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#line234">line 234</a> </li> </ul> </dd> </dl> <h4 class="name" id="maxLength"> <span class="type-signature"></span>maxLength<span class="type-signature"> :number</span> </h4> <div class="description"> <p>Validates the user input <br> <em>applies only for <code>type=string</code></em>.</p> </div> <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#line304">line 304</a> </li> </ul> </dd> </dl> <h4 class="name" id="maxLengthError"> <span class="type-signature"></span>maxLengthError<span class="type-signature"> :string</span> </h4> <div class="description"> <p>Message to be shown on <code>maxLength</code> error.</p> </div> <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#line312">line 312</a> </li> </ul> </dd> </dl> <h4 class="name" id="maxValue"> <span class="type-signature"></span>maxValue<span class="type-signature"> :number</span> </h4> <div class="description"> <p>Validates the user input <br> <em>applies only for <code>type=int|float</code></em>.</p> </div> <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#line336">line 336</a> </li> </ul> </dd> </dl> <h4 class="name" id="maxValueError"> <span class="type-signature"></span>maxValueError<span class="type-signature"> :string</span> </h4> <div class="description"> <p>Message to be shown on <code>maxValue</code> error.</p> </div> <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#line344">line 344</a> </li> </ul> </dd> </dl> <h4 class="name" id="meta"> <span class="type-signature"></span>meta<span class="type-signature"> :<a href="MenuFormItemMeta.html">MenuFormItemMeta</a></span> </h4> <div class="description"> <p><a href="MenuFormItemMeta.html"><code>MenuFormItemMeta</code></a> object <br> <em>applies only for <code>type=form-menu</code></em>.</p> </div> <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#line359">line 359</a> </li> </ul> </dd> </dl> <h4 class="name" id="method"> <span class="type-signature"></span>method<span class="type-signature"> :string</span> </h4> <div class="description"> <p>HTTP method, how the callback url should be triggered.</p> </div> <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#line367">line 367</a> </li> </ul> </dd> </dl> <h4 class="name" id="minLength"> <span class="type-signature"></span>minLength<span class="type-signature"> :number</span> </h4> <div class="description"> <p>Validates the user input <br> <em>applies only for <code>type=string</code></em>.</p> </div> <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#line288">line 288</a> </li> </ul> </dd> </dl> <h4 class="name" id="minLengthError"> <span class="type-signature"></span>minLengthError<span class="type-signature"> :string</span> </h4> <div class="description"> <p>Message to be shown on <code>minLength</code> error.</p> </div> <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#line296">line 296</a> </li> </ul> </dd> </dl> <h4 class="name" id="minValue"> <span class="type-signature"></span>minValue<span class="type-signature"> :number</span> </h4> <div class="description"> <p>Validates the user input <br> <em>applies only for <code>type=int|float</code></em>.</p> </div> <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#line320">line 320</a> </li> </ul> </dd> </dl> <h4 class="name" id="minValueError"> <span class="type-signature"></span>minValueError<span class="type-signature"> :string</span> </h4> <div class="description"> <p>Message to be shown on <code>minValue</code> error.</p> </div> <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#line328">line 328</a> </li> </ul> </dd> </dl> <h4 class="name" id="name"> <span class="type-signature"></span>name<span class="type-signature"> :string</span> </h4> <div class="description"> <p>The name of this <code>FormItem</code>, used in form serialization.</p> </div> <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#line218">line 218</a> </li> </ul> </dd> </dl> <h4 class="name" id="pattern"> <span class="type-signature"></span>pattern<span class="type-signature"> :string|null</span> </h4> <div class="description"> <p>ECMA Script regex pattern string <br> <em>applies only for <code>type=regex</code></em>.</p> </div> <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#line392">line 392</a> </li> </ul> </dd> </dl> <h4 class="name" id="required"> <span class="type-signature"></span>required<span class="type-signature"> :boolean</span> </h4> <div class="description"> <p>User can <code>SKIP</code> this <code>FormItem</code> if set to <code>false</code></p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li> false </li> </ul> </dd> <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#line375">line 375</a> </li> </ul> </dd> </dl> <h4 class="name" id="statusExclude"> <span class="type-signature"></span>statusExclude<span class="type-signature"> :boolean</span> </h4> <div class="description"> <p>If <code>true</code> this step will be excluded from the form completion status.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li> false </li> </ul> </dd> <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#line413">line 413</a> </li> </ul> </dd> </dl> <h4 class="name" id="statusPrepend"> <span class="type-signature"></span>statusPrepend<span class="type-signature"> :boolean</span> </h4> <div class="description"> <p>If <code>true</code> this step will be prepended to the body of the response. Appended otherwise.</p> </div> <dl class="details"> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li> false </li> </ul> </dd> <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#line422">line 422</a> </li> </ul> </dd> </dl> <h4 class="name" id="step"> <span class="type-signature"></span>step<span class="type-signature"> :number</span> </h4> <div class="description"> <p>specifies the legal number intervals for input field</p> </div> <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#line352">line 352</a> </li> </ul> </dd> </dl> <h4 class="name" id="type"> <span class="type-signature"></span>type<span class="type-signature"> :string</span> </h4> <div class="description"> <p>Indicates the type of the object.</p> </div> <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#line201">line 201</a> </li> </ul> </dd> </dl> <h4 class="name" id="url"> <span class="type-signature"></span>url<span class="type-signature"> :string</span> </h4> <div class="description"> <p>Callback url triggered right after the choice has been set for this form item.</p> </div> <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#line431">line 431</a> </li> </ul> </dd> </dl> <h4 class="name" id="validateTypeError"> <span class="type-signature"></span>validateTypeError<span class="type-signature"> :string</span> </h4> <div class="description"> <p>An error message to be shown on basic type validation.</p> </div> <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#line439">line 439</a> </li> </ul> </dd> </dl> <h4 class="name" id="validateTypeErrorFooter"> <span class="type-signature"></span>validateTypeErrorFooter<span class="type-signature"> :string</span> </h4> <div class="description"> <p>Shown in the error message footer.</p> </div> <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#line447">line 447</a> </li> </ul> </dd> </dl> <h4 class="name" id="validateUrl"> <span class="type-signature"></span>validateUrl<span class="type-signature"> :string</span> </h4> <div class="description"> <p>The callback url path <code>"GET"</code> triggered to validate user input. <br> A query string is sent by ONEm: <code>?form_item_name=user_input</code> <br> The validate_url must return a json response: <code>{"valid": true/false, "error": "Some message in case of validation errors"}</code>.</p> </div> <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#line455">line 455</a> </li> </ul> </dd> </dl> <h4 class="name" id="value"> <span class="type-signature"></span>value<span class="type-signature"> :string</span> </h4> <div class="description"> <p>Value to pass in the form serialization data <br> <em>applies only for <code>type=hidden</code></em>.</p> </div> <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#line258">line 258</a> </li> </ul> </dd> </dl> <h3 class="subsection-title">Methods</h3> <span class='name-container'> <a class="link-icon" href="#.fromTag"> <svg height="20" width="20" style="fill: black;"> <use xlink:href="#linkIcon"></use> </svg> </a> <h4 class="name" id=".fromTag"> <span class="type-signature">(static) </span>fromTag<span class="signature">(sectionTag)</span><span class="type-signature"> → {<a href="FormItem.html">FormItem</a>}</span> </h4> </span> <div class="description"> <p>Creates a FormItem from a SectionTag</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>sectionTag</code></td> <td class="type"> <span class="param-type"> SectionTag </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#line473">line 473</a> </li> </ul> </dd> </dl> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> </footer> <script src="scripts/linenumber.js"></script> <script src="scripts/pagelocation.js"></script> </body> </html>