forked from open-rpa/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
2.8._forms.html
1139 lines (1031 loc) · 57.5 KB
/
2.8._forms.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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Forms — BPA/OpenIAP Docs 1.0.5 documentation</title>
<script type="text/javascript" src="static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="static/documentation_options.js"></script>
<script src="static/jquery.js"></script>
<script src="static/underscore.js"></script>
<script src="static/doctools.js"></script>
<script src="static/language_data.js"></script>
<script type="text/javascript" src="static/js/theme.js"></script>
<link rel="stylesheet" href="static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<link rel="stylesheet" href="static/styles.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> BPA/OpenIAP Docs
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="rpa.html">1. <strong>Introduction to RPA</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="openflow.html">2. <strong>OpenFlow</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="openrpa.html">3. <strong>OpenRPA</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="node_red.html">4. <strong>Node-RED</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix_a.html">5. <strong>Appendix A</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix_b.html">6. <strong>Appendix B</strong></a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="license.html">1. License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">BPA/OpenIAP Docs</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li><strong>Forms</strong></li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="forms">
<h1><strong>Forms</strong><a class="headerlink" href="#forms" title="Permalink to this headline">¶</a></h1>
<p>Forms are an user-friendly way of passing input to a workflow by creating dynamic OpenFlow’s webpages. There are two ways of generating a Form: one of them is through OpenFlow’s automatically generated Forms which are created upon saving a Workflow into its repository and the other one is manually creating a Form and connecting it to a Node-RED workflow.</p>
<p>For thorough information on how to use Forms, please refer to <a class="reference external" href="https://help.form.io/userguide/introduction/">form.io Intro</a> (<code class="docutils literal notranslate"><span class="pre">https://help.form.io/userguide/introduction/</span></code>). Most of this chapter is based on this guide.</p>
<div class="section" id="creating-a-form">
<h2>Creating a Form<a class="headerlink" href="#creating-a-form" title="Permalink to this headline">¶</a></h2>
<p>Creating a form is rather easy and simple. Go to the Forms page, where all Forms are listed, available under the Admin dropdown or in the <a class="reference external" href="http://localhost.openiap.io/#/Forms">Forms page</a> (eg. <a class="reference external" href="http://localhost.openiap.io/#/Forms">http://localhost.openiap.io/#/Forms</a>) and click the Navy blue <code class="docutils literal notranslate"><span class="pre">Add</span> <span class="pre">form</span></code> button.</p>
<div class="figure align-center" id="id1">
<img alt="images/openflow_forms_page.png" src="images/openflow_forms_page.png" />
<p class="caption"><span class="caption-text"><strong>OpenFlow’s Forms page.</strong></span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
</div>
<p>Now at the Forms edit page, there are many Form components from which you can choose. For general purposes, we are only going to discuss the most used one here: Text Field Component. The other ones will be discussed further on in their specific sections.</p>
<div class="figure align-center" id="id2">
<img alt="images/openflow_forms_creation_page.png" src="images/openflow_forms_creation_page.png" />
<p class="caption"><span class="caption-text"><strong>OpenFlow’s Forms creation page.</strong></span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
</div>
<p>Drag the Text Field Component Form from the Basic category into the Form workspace. Immediately after, a window containing all the parameters to configure the Form Component will appear.</p>
<div class="figure align-center" id="id3">
<img alt="images/openflow_form_starter_config_page.png" src="images/openflow_form_starter_config_page.png" />
<p class="caption"><span class="caption-text"><strong>OpenFlow’s Forms starter configuration tab.</strong></span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
</div>
</div>
<div class="section" id="configuring-the-form-component">
<h2>Configuring the Form Component<a class="headerlink" href="#configuring-the-form-component" title="Permalink to this headline">¶</a></h2>
<p>Below are the steps needed to properly configure a Form Component, a TextField in our example.</p>
<ul>
<li><p><strong>Changing Form Label</strong></p>
<blockquote>
<div><p>To change the Form’s label, i.e., the title which will appear for the end-user, simply click the Display tab and change the input form titled <strong>Label</strong>. The changes are shown real-time.</p>
</div></blockquote>
</li>
</ul>
<div class="figure align-center" id="id4">
<img alt="images/openflow_form_label_config_page.png" src="images/openflow_form_label_config_page.png" />
<p class="caption"><span class="caption-text"><strong>OpenFlow’s Form Display configuration tab.</strong></span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
</div>
<ul>
<li><p><strong>Assigning Input Variable</strong></p>
<blockquote>
<div><p>To assign the input form to a variable configured inside the OpenRPA workflow you’ve mapped to OpenFlow, simply go to the API tab and insert the name of the variable inside <strong>Property Name</strong> and press save. Now the next time this workflow is called, a new parameter will appear.</p>
</div></blockquote>
</li>
</ul>
<div class="figure align-center" id="id5">
<img alt="images/openflow_text_field_api_config.png" src="images/openflow_text_field_api_config.png" />
<p class="caption"><span class="caption-text"><strong>OpenFlow’s Form API configuration tab.</strong></span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
</div>
<ul>
<li><p><strong>Assigning Form to Node-RED Workflow</strong></p>
<blockquote>
<div><p>Now it is required that you assign a Form to a Node-RED workflow. To do that, go to Node-RED and click twice on the <code class="docutils literal notranslate"><span class="pre">Workflow</span> <span class="pre">Out</span></code> node you want to assign the form to. The <code class="docutils literal notranslate"><span class="pre">Edit</span> <span class="pre">workflow</span> <span class="pre">out</span> <span class="pre">node</span></code> tab appears and you must select the form you’ve just created in the <code class="docutils literal notranslate"><span class="pre">Userform</span></code> dropdown.</p>
</div></blockquote>
</li>
</ul>
<div class="figure align-default" id="id6">
<img alt="images/openflow_node_red_configure_form.png" src="images/openflow_node_red_configure_form.png" />
<p class="caption"><span class="caption-text"><strong>Assigning Form to Node-RED workflow.</strong></span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
</div>
<p>For more information on how to configure the Form Component, please refer to the <span class="xref std std-ref">OpenFlow Forms</span> section.</p>
</div>
<div class="section" id="general-form-settings">
<h2>General Form Settings<a class="headerlink" href="#general-form-settings" title="Permalink to this headline">¶</a></h2>
<p>In this section, users will see a list of general settings that are offered for the majority of our components. In the later sections, only the specific settings for the given Forms will be shown.</p>
<p><strong>Display</strong></p>
<blockquote>
<div><p>Here belong the general properties related to the display methods and usage of this Form Component.</p>
<p><strong>Label</strong></p>
<blockquote>
<div><p>The name or title for this component.</p>
<div class="figure align-center" id="id7">
<a class="reference internal image-reference" href="images/general_label_property.png"><img alt="images/general_label_property.png" src="images/general_label_property.png" style="width: 247.5px; height: 41.0px;" /></a>
<p class="caption"><span class="caption-text"><strong>Label Property</strong></span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
</div>
<div class="figure align-center" id="id8">
<a class="reference internal image-reference" href="images/label_property_set.png"><img alt="images/label_property_set.png" src="images/label_property_set.png" style="width: 248.0px; height: 46.5px;" /></a>
<p class="caption"><span class="caption-text"><strong>Demo of Label Property set</strong></span><a class="headerlink" href="#id8" title="Permalink to this image">¶</a></p>
</div>
</div></blockquote>
<p><strong>Label Position</strong></p>
<blockquote>
<div><p>Position for the label for this field. Selecting <strong>Top</strong> shows the label above the input field, whereas <strong>Bottom</strong> shows the label below the input field.</p>
<div class="figure align-center" id="id9">
<a class="reference internal image-reference" href="images/general_label_position_property.png"><img alt="images/general_label_position_property.png" src="images/general_label_position_property.png" style="width: 235.5px; height: 95.5px;" /></a>
<p class="caption"><span class="caption-text"><strong>Label Position Property</strong></span><a class="headerlink" href="#id9" title="Permalink to this image">¶</a></p>
</div>
<div class="figure align-center" id="id10">
<a class="reference internal image-reference" href="images/label_position_property_set_to_bottom.png"><img alt="images/label_position_property_set_to_bottom.png" src="images/label_position_property_set_to_bottom.png" style="width: 241.5px; height: 35.0px;" /></a>
<p class="caption"><span class="caption-text"><strong>Demo of Label Position Property set to Bottom</strong></span><a class="headerlink" href="#id10" title="Permalink to this image">¶</a></p>
</div>
</div></blockquote>
<p><strong>Placeholder</strong></p>
<blockquote>
<div><p>This property sets the placeholder text that will appear when the field is empty.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/general_placeholder_property.png"><img alt="images/general_placeholder_property.png" src="images/general_placeholder_property.png" style="width: 239.0px; height: 38.5px;" /></a>
</div>
<p><strong>Placeholder Property</strong></p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/placeholder_property_set.png"><img alt="images/placeholder_property_set.png" src="images/placeholder_property_set.png" style="width: 244.0px; height: 26.0px;" /></a>
</div>
<p><strong>Placeholder Property set</strong></p>
</div></blockquote>
<p><strong>Description</strong></p>
<blockquote>
<div><p>This property sets a description which will appear below the input field.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/general_description_property.png"><img alt="images/general_description_property.png" src="images/general_description_property.png" style="width: 246.0px; height: 45.0px;" /></a>
</div>
<p><strong>Description Property</strong></p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/description_property_set.png"><img alt="images/description_property_set.png" src="images/description_property_set.png" style="width: 244.5px; height: 64.0px;" /></a>
</div>
<p><strong>Description Property set</strong></p>
</div></blockquote>
<p><strong>Prefix</strong></p>
<blockquote>
<div><p>This property sets a prefix text which will be passed along with the text inserted in the input field.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/general_prefix_property.png"><img alt="images/general_prefix_property.png" src="images/general_prefix_property.png" style="width: 245.0px; height: 39.0px;" /></a>
</div>
<p><strong>Prefix Property</strong></p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/prefix_property_set.png"><img alt="images/prefix_property_set.png" src="images/prefix_property_set.png" style="width: 240.5px; height: 24.5px;" /></a>
</div>
<p><strong>Prefix Property set</strong></p>
</div></blockquote>
<p><strong>Suffix</strong></p>
<blockquote>
<div><p>This property sets a suffix text which will be passed along with the text inserted in the input field.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/general_suffix_property.png"><img alt="images/general_suffix_property.png" src="images/general_suffix_property.png" style="width: 243.0px; height: 39.0px;" /></a>
</div>
<p><strong>Suffix Property</strong></p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/suffix_property_set.png"><img alt="images/suffix_property_set.png" src="images/suffix_property_set.png" style="width: 241.0px; height: 25.0px;" /></a>
</div>
<p><strong>Suffix Property set</strong></p>
</div></blockquote>
<p><strong>Widget</strong></p>
<blockquote>
<div><p>This property allows the user to choose between an <code class="docutils literal notranslate"><span class="pre">input</span> <span class="pre">field</span></code> and a <code class="docutils literal notranslate"><span class="pre">calendar</span> <span class="pre">picker</span></code>.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/general_widget_property.png"><img alt="images/general_widget_property.png" src="images/general_widget_property.png" style="width: 236.0px; height: 99.0px;" /></a>
</div>
<p><strong>Widget Property</strong></p>
</div></blockquote>
<p><strong>Input Mask</strong></p>
<blockquote>
<div><p>This property allows the user to insert one or more input masks to verify the input data. If you do no know what this means or want special customization, please refer to <a class="reference external" href="https://github.com/RobinHerbots/Inputmask">Inputmask</a> (<code class="docutils literal notranslate"><span class="pre">https://github.com/RobinHerbots/Inputmask</span></code>).</p>
<p>If you activate this option with either <cite>Show Character Count</cite> or <cite>Show Word Count</cite>, none of the latter will work properly.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/general_input_mask_property.png"><img alt="images/general_input_mask_property.png" src="images/general_input_mask_property.png" style="width: 245.0px; height: 60.5px;" /></a>
</div>
<p><strong>Input Mask Property</strong></p>
<p>The users can also allow for multiple masks. Checking this option will generate a prefix dropdown in the input field where he can select from which mask he desires to choose input fors.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/general_multiple_masks_property.png"><img alt="images/general_multiple_masks_property.png" src="images/general_multiple_masks_property.png" style="width: 240.0px; height: 135.5px;" /></a>
</div>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/multiple_masks_set.png"><img alt="images/multiple_masks_set.png" src="images/multiple_masks_set.png" style="width: 239.0px; height: 25.0px;" /></a>
</div>
<p><strong>Settings multiple masks</strong></p>
</div></blockquote>
<p><strong>Custom CSS Class</strong></p>
<blockquote>
<div><p>This property allows the users to make use of one of the custom CSS classes for Bootstrap’s input text fields as defined in <a class="reference external" href="https://getbootstrap.com/docs/4.0/components/input-group/">Input group</a> (<code class="docutils literal notranslate"><span class="pre">https://getbootstrap.com/docs/4.0/components/input-group/</span></code>).</p>
<div class="figure align-center" id="id11">
<a class="reference internal image-reference" href="images/general_custom_css_property.png"><img alt="images/general_custom_css_property.png" src="images/general_custom_css_property.png" style="width: 241.0px; height: 38.5px;" /></a>
<p class="caption"><span class="caption-text"><strong>Custom CSS Property</strong></span><a class="headerlink" href="#id11" title="Permalink to this image">¶</a></p>
</div>
</div></blockquote>
<p><strong>Tab Index</strong></p>
<blockquote>
<div><p>If set to <code class="docutils literal notranslate"><span class="pre">0</span></code>, this property allows the users to use the <code class="docutils literal notranslate"><span class="pre">{TAB}</span></code> key to navigate through the input fields. Else, if set to <code class="docutils literal notranslate"><span class="pre">1</span></code> it makes the input field unnavigable by using the <code class="docutils literal notranslate"><span class="pre">{TAB}</span></code> key. If this property is not very clear, users can find more information about it on <a class="reference external" href="https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex">MSDN - tabindex</a> (<code class="docutils literal notranslate"><span class="pre">https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex</span></code>).</p>
<div class="figure align-center" id="id12">
<a class="reference internal image-reference" href="images/general_tab_index_property.png"><img alt="images/general_tab_index_property.png" src="images/general_tab_index_property.png" style="width: 245.0px; height: 39.5px;" /></a>
<p class="caption"><span class="caption-text"><strong>Tab Index Property</strong></span><a class="headerlink" href="#id12" title="Permalink to this image">¶</a></p>
</div>
</div></blockquote>
<p><strong>Hidden</strong></p>
<blockquote>
<div><p>If checked, this property allows the users to hide the form when it is invoked. The component will still be part of the form.</p>
</div></blockquote>
<p><strong>Hide Label</strong></p>
<blockquote>
<div><p>This option allows users to hide the label of this component when the form is rendered. It will still be visible in the form builder.</p>
</div></blockquote>
<p><strong>Show Word counter</strong></p>
<blockquote>
<div><p>If checked, this property shows a live of number of words in the component.</p>
</div></blockquote>
<p><strong>Show Character Counter</strong></p>
<blockquote>
<div><p>If checked, this property shows a live of number of characters in the component.</p>
</div></blockquote>
<p><strong>Hide Input</strong></p>
<blockquote>
<div><p>This option hides the input in the browser. However, it does not encrypt the input in the server, so it should not be used with passwords.</p>
</div></blockquote>
<p><strong>Initial Focus</strong></p>
<blockquote>
<div><p>This option makes the component the initially focused in the form.</p>
</div></blockquote>
<p><strong>Allow Spellcheck</strong></p>
<blockquote>
<div><p>This option enables the spellcheck for this component.</p>
</div></blockquote>
<p><strong>Disabled</strong></p>
<blockquote>
<div><p>This option disabled the component in the form.</p>
</div></blockquote>
<p><strong>Always Enabled</strong></p>
<blockquote>
<div><p>This option makes the component always enabled, even if the form itself is disabled.</p>
</div></blockquote>
<p><strong>Table View</strong></p>
<blockquote>
<div><p>If checked, this option shows the input value within the table view of the submissions.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Data</strong></p>
<blockquote>
<div><p><strong>Multiple Values</strong></p>
<blockquote>
<div><p>This option allows multiple values to be entered for this field.</p>
</div></blockquote>
<p><strong>Default Value</strong></p>
<blockquote>
<div><p>If checked, there will be an default value for this field before user interaction. This value will override placeholder text.</p>
</div></blockquote>
<p><strong>Persistent</strong></p>
<blockquote>
<div><p>This option stored a persistent field in the database when the form is submitted. The available option are: None, Server and Client. These correspond to where the information will be stored, if checked.</p>
</div></blockquote>
<p><strong>Input Format</strong></p>
<blockquote>
<div><p>This option forces the output of this field to be sanitized in a specific format. The available options are: Plain, HTML and Raw. Please note that the last option (“Raw”) is considered insecure.</p>
</div></blockquote>
<p><strong>Protected</strong></p>
<blockquote>
<div><p>If checked, this field will not be returned when queried via API.</p>
</div></blockquote>
<p><strong>Database Index</strong></p>
<blockquote>
<div><p>This option sets this field as the index within the database. It increases performance for submission queries.</p>
</div></blockquote>
<p><strong>Text Case</strong></p>
<blockquote>
<div><p>With this option, user may control the case of the text in the field. There are the possibilities here: Mixed (allows upper and lower cases in the text), Uppercase and Lowercase. These two last options make the whole text to be in the specific case.</p>
</div></blockquote>
<p><strong>Encrypted (Enterprise Only)</strong></p>
<blockquote>
<div><p>This option encrpyt the input of the field in the server. Please note that it is not recommended for passwords, since it is two way encryption.</p>
</div></blockquote>
<p><strong>Redraw On</strong></p>
<blockquote>
<div><p>This option redraws this component if another component changes. It may be useful when interpolating parts of the component, as the label.</p>
</div></blockquote>
<p><strong>Clear Value When Hidden</strong></p>
<blockquote>
<div><p>When the field is hidden, it clears its value.</p>
</div></blockquote>
<p><strong>Custom Default Value</strong></p>
<blockquote>
<div><p>This option opens a JavaScript text field for the user to customize the default value. All available variables are listed for the user to handle them. As shown in the example, information within the system can be used to fill in the field for the end user as a suggestion.</p>
</div></blockquote>
<p><strong>Calculated Value</strong></p>
<blockquote>
<div><p>Similar to <strong>Custom Default Value</strong>, that is, the end user may be provided with an already calculated value for this field. A JavaScript text field will be opened for the user to treat the information as desired. Again, all available variables are listed.</p>
</div></blockquote>
<p><strong>Allow Manual Override of Calculated Value</strong></p>
<blockquote>
<div><p>If checked, this option allows end users to manually override the calculated value.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Validation</strong></p>
<blockquote>
<div><p><strong>Validate On</strong></p>
<blockquote>
<div><p>This option determines when this component should trigger frond-end validation. The available option are Change and Blur.</p>
</div></blockquote>
<p><strong>Required</strong></p>
<blockquote>
<div><p>If checked, the form can not be submitted if this field is empty.</p>
</div></blockquote>
<p><strong>Unique</strong></p>
<blockquote>
<div><p>This option makes the input of this field unique, that is, one end user can not submit the form if the text in this field is the same as another end user.</p>
</div></blockquote>
<p><strong>Minimum Length</strong></p>
<blockquote>
<div><p>The minimum length required for the input. It must be an integer represent the number of characters.</p>
</div></blockquote>
<p><strong>Maximum Length</strong></p>
<blockquote>
<div><p>The maximum length required for the input. It must be an integer represent the number of characters.</p>
</div></blockquote>
<p><strong>Minimum Word Length</strong></p>
<blockquote>
<div><p>The minimum number of words that can be entered in this field.</p>
</div></blockquote>
<p><strong>Maximum Word Length</strong></p>
<blockquote>
<div><p>The maximum number of words that can be entered in this field.</p>
</div></blockquote>
<p><strong>Regular Expression Pattern</strong></p>
<blockquote>
<div><p>The Regular Expression Pattern against which the input of this field must be tested before the form can be submitted.</p>
</div></blockquote>
<p><strong>Error Label</strong></p>
<blockquote>
<div><p>The label for this field when an error occurs.</p>
</div></blockquote>
<p><strong>Custom Error Message</strong></p>
<blockquote>
<div><p>An error message to be displayed if an error occurs.</p>
</div></blockquote>
<p><strong>Custom Validation</strong></p>
<blockquote>
<div><p>Customizable validation based in JavaScript syntax. All available variables are shown. A <strong>Secret Validation</strong> option is provided for those who wish to perform valition only in the server side. It keeps validation logic private and secret.</p>
</div></blockquote>
<p><strong>JSONLogic Validation</strong></p>
<blockquote>
<div><p>This option allows users to enter validation using JSONLogic syntax.</p>
</div></blockquote>
</div></blockquote>
<p><strong>API</strong></p>
<blockquote>
<div><p><strong>Property Name</strong></p>
<blockquote>
<div><p>The name of this field in the API endpoint.</p>
</div></blockquote>
<p><strong>Field Tags</strong></p>
<blockquote>
<div><p>Tags of field to be used in custom logic.</p>
</div></blockquote>
<p><strong>Custom Properties</strong></p>
<blockquote>
<div><p>This option allows users to configure any custom properties for this field.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Conditional</strong></p>
<blockquote>
<div><p>Any form component can use conditional logic to determine when to hide or display itself. The settings for a conditional field are configured on the component itself and can be found by viewing the Conditional tab within the components settings. Please note that the conditional component requires an API key to be configured to function correctly.</p>
<p><strong>Advanced</strong></p>
<blockquote>
<div><p>In addition to Simple Conditional logic, you can also use Advanced Conditional logic, which uses actual JavaScript for any combination of conditions. JavaScript conditional logic requires you to set the value of show to either true or false. You have access to the current value of any form component via the data object and the components API key. Advanced Conditional logic will only work if Simple Conditional logic isn’t already defined.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Logic</strong></p>
<blockquote>
<div><p>This option allows users to set conditional actions in the form based on triggers. The difference between this Logic and the previous tab (“Conditional”) is that here the user is presented with more Actions other than showing the component or not. For instance, based on this logic, the user can set the Value of the field, a Property (such as Label, Title, Placeholder etc.) or even Validation.</p>
</div></blockquote>
<p><strong>Layout</strong></p>
<blockquote>
<div><p><strong>HTML Attributes</strong></p>
<blockquote>
<div><p>This options provides a map of HTML attributes for component’s input element. Please note that the attributes provided by other component settings or other attributes generated by form.io take precedence over attributes in this option.</p>
</div></blockquote>
<p><strong>PDF Overlay</strong></p>
<blockquote>
<div><p>Options for rendering this component in PDF.</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="basic-form-components">
<h2>Basic Form Components<a class="headerlink" href="#basic-form-components" title="Permalink to this headline">¶</a></h2>
<p>The Basic Form Components contain the most basic input types.</p>
<div class="section" id="text-field">
<h3>Text Field<a class="headerlink" href="#text-field" title="Permalink to this headline">¶</a></h3>
<p>The Text Field Component allows the user to insert text inside an inline input field.</p>
<p>To use this Form Component, simply drag the <strong>Text Field</strong> component to the form you’re building.</p>
<div class="figure align-center">
<img alt="images/drag_text_field_component.png" src="images/drag_text_field_component.png" />
</div>
<p>After dragging it to the Form Designer, a new window will appear - the configuration window for this specific Form Component. It is divided by sections: <code class="docutils literal notranslate"><span class="pre">Display</span></code>, <code class="docutils literal notranslate"><span class="pre">Data</span></code>, <code class="docutils literal notranslate"><span class="pre">Validation</span></code>, <code class="docutils literal notranslate"><span class="pre">API</span></code>, <code class="docutils literal notranslate"><span class="pre">Conditionals</span></code>, <code class="docutils literal notranslate"><span class="pre">Logic</span></code> and <code class="docutils literal notranslate"><span class="pre">Layout</span></code>. These sections and their properties are discussed further below.</p>
<div class="figure align-center">
<img alt="images/text_field_general_config_page.png" src="images/text_field_general_config_page.png" />
</div>
</div>
<div class="section" id="text-area">
<h3>Text Area<a class="headerlink" href="#text-area" title="Permalink to this headline">¶</a></h3>
<p>A Text Area has the same options as the textfield form component. The difference is that it will be a multi-line input field that allows for longer text. The Text Area can also be utilized as a CK Editor WYSIWYG for the end user which is configured within the component settings.</p>
<p><strong>Display</strong></p>
<blockquote>
<div><p><strong>Rows</strong></p>
<blockquote>
<div><p>This allows control over how many rows are visible in the text area.</p>
<div class="figure align-center" id="id13">
<a class="reference internal image-reference" href="images/rows_textarea.png"><img alt="images/rows_textarea.png" src="images/rows_textarea.png" style="width: 244.0px; height: 39.5px;" /></a>
<p class="caption"><span class="caption-text"><strong>Rows</strong></span><a class="headerlink" href="#id13" title="Permalink to this image">¶</a></p>
</div>
</div></blockquote>
<p><strong>Editor</strong></p>
<blockquote>
<div><p>Options for selecting the type of WYSIWYG editor to use for this text area.</p>
<div class="figure align-center" id="id14">
<a class="reference internal image-reference" href="images/editor_textarea.png"><img alt="images/editor_textarea.png" src="images/editor_textarea.png" style="width: 246.0px; height: 122.5px;" /></a>
<p class="caption"><span class="caption-text"><strong>Editor</strong></span><a class="headerlink" href="#id14" title="Permalink to this image">¶</a></p>
</div>
</div></blockquote>
<p><strong>Auto Expand</strong></p>
<blockquote>
<div><p>This will make the Text Area auto expand its height as the user is typing into the area.</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="number">
<h3>Number<a class="headerlink" href="#number" title="Permalink to this headline">¶</a></h3>
<p>Number fields should be used whenever a field should be limited to a type of number value.</p>
<p><strong>Data</strong></p>
<blockquote>
<div><p><strong>Use Thousands Separator</strong></p>
<blockquote>
<div><p>This option separes thousands by local delimiter.</p>
</div></blockquote>
<p><strong>Decimal Places</strong></p>
<blockquote>
<div><p>The maximum number of decimal places for the values in this field.</p>
</div></blockquote>
<p><strong>Require Decimals</strong></p>
<blockquote>
<div><p>Always show decimals for this field, even if trailing zeros.</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="password">
<h3>Password<a class="headerlink" href="#password" title="Permalink to this headline">¶</a></h3>
<p>The password field has the same options as a text field component. It differs from a text field in that its html <input> type will be password instead of text. This will cause the field to display asterisks instead of the value entered.</p>
</div>
<div class="section" id="checkbox">
<h3>Checkbox<a class="headerlink" href="#checkbox" title="Permalink to this headline">¶</a></h3>
<p>A check box is a boolean value input field. It will either be on or off.</p>
<p><strong>Validation</strong></p>
<blockquote>
<div><dl class="simple">
<dt><strong>Required</strong></dt><dd><p>If checked, the field will be required to be checked. If it is required, you may not need to persist the value as it can be assumed to be checked when a form was submitted or it will not submit.</p>
</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="select-boxes">
<h3>Select Boxes<a class="headerlink" href="#select-boxes" title="Permalink to this headline">¶</a></h3>
<p>The Check Boxes form component works like the Radio component, but allows the user to check multiple values.</p>
<p><strong>Display</strong></p>
<blockquote>
<div><p><strong>Inline Layout</strong></p>
<blockquote>
<div><p>If checked, this field will layout the checkboxes horizontally instead of vertically.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Validation</strong></p>
<blockquote>
<div><p><strong>Required</strong></p>
<blockquote>
<div><p>If checked, the field will be required to have at least one box checked. If it is required, you may not need to persist the value as it can be assumed to be checked when a form was submitted or it will not submit.</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="select">
<h3>Select<a class="headerlink" href="#select" title="Permalink to this headline">¶</a></h3>
<p>A select field will display a list of values in a drop down list to users. Users can select one of the values.</p>
<p><strong>Display</strong></p>
<blockquote>
<div><p><strong>Widget Type</strong></p>
<blockquote>
<div><p>This option allows the user to select the type of widget to be used. The available options are ChoicesJS and HTML 5.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Data</strong></p>
<blockquote>
<div><p><strong>Data Source Type</strong></p>
<blockquote>
<div><p>Select the type of data the options will be pulled from.</p>
<p><strong>Values</strong></p>
<blockquote>
<div><p>These are the values that will be selected on this field. The Value column is what will be stored in the database and the Label is what is shown to the users.</p>
<p><strong>Storage Type</strong></p>
<blockquote>
<div><p>The type to store the data. It is suggested to choose “autotype”, which means it will use the type of the data from URL.</p>
</div></blockquote>
<p><strong>Item Template</strong></p>
<blockquote>
<div><p>The HTML template for the result data items.</p>
</div></blockquote>
<p><strong>Enable Static Search</strong></p>
<blockquote>
<div><p>When checked, the Select dropdown will allow for searching within the static list of items provided.</p>
</div></blockquote>
<p><strong>Search Threshold</strong></p>
<blockquote>
<div><p>A number from 0 to 1 representing the point that the matching algorithm gives up. A threshold of 0.0 required a perfect match, while a threshold of 1.0 will match anything.</p>
</div></blockquote>
<p><strong>Read Only Value</strong></p>
<blockquote>
<div><p>If checked, it will show just the value when in Read Only mode.</p>
</div></blockquote>
<p><strong>Choices.js options</strong></p>
<blockquote>
<div><p>A raw JSON object to use as options for the Select component.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Raw JSON</strong></p>
<blockquote>
<div><p>Enter a JSON Array to use. It should be formatted as an array of objects with named properties.</p>
</div></blockquote>
<p><strong>URL</strong></p>
<blockquote>
<div><p>Enter a url with a data source in JSON Array format. This can be used to populate a Select list with external JSON values.</p>
<p><strong>Lazy Load Data</strong></p>
<blockquote>
<div><p>When set, this option will not fire off the request to the URL until this control is within focus. It can improve performance in case of many Select dropdowns in the form.</p>
</div></blockquote>
<p><strong>Request Headers</strong></p>
<blockquote>
<div><p>The headers that should be sent along with the request to the URL. It can useful for authentication.</p>
</div></blockquote>
<p><strong>Data Path</strong></p>
<blockquote>
<div><p>The property within the source data, if the items are iterable.</p>
</div></blockquote>
<p><strong>Disable limiting response</strong></p>
<blockquote>
<div><p>When enabled the request will not include the limit and skip options in the query string.</p>
</div></blockquote>
<p><strong>Search Query Name</strong></p>
<blockquote>
<div><p>The name of the search querystring parameter used when sending a request to filter the results with. The server at the URL must handle this query parameter.</p>
</div></blockquote>
<p><strong>Filter Query</strong></p>
<blockquote>
<div><p>This filter is used to provide additional filtering when using query parameters.</p>
</div></blockquote>
<p><strong>Sort Query</strong></p>
<blockquote>
<div><p>This option is used to provide sorting when using query parameters.</p>
</div></blockquote>
<p><strong>Limit</strong></p>
<blockquote>
<div><p>This option is used to limit the number of items to request or view.</p>
</div></blockquote>
<p><strong>Refresh Options On</strong></p>
<blockquote>
<div><p>If checked, it will refresh data when another field changes.</p>
</div></blockquote>
<p><strong>Clear Value On Refresh Options</strong></p>
<blockquote>
<div><p>When <strong>Refresh Options On</strong> is on, the component will have its value cleared.</p>
</div></blockquote>
<p><strong>Formio Authenticate</strong></p>
<blockquote>
<div><p>The user must check this option if Formio Authentication is desired with the request.</p>
</div></blockquote>
</div></blockquote>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="radio">
<h3>Radio<a class="headerlink" href="#radio" title="Permalink to this headline">¶</a></h3>
<p>Radio form components should be used when presenting a list of options from which one should be chosen.</p>
</div>
<div class="section" id="button">
<h3>Button<a class="headerlink" href="#button" title="Permalink to this headline">¶</a></h3>
<p>Buttons can be added to perform various actions within the form.</p>
<p><strong>Display</strong></p>
<blockquote>
<div><p><strong>Action</strong></p>
<blockquote>
<div><p>The action to be performed by the button.</p>
<p><strong>Submit</strong></p>
<blockquote>
<div><p>A submit action submits the form to either the form.io server or a custom callback url that has been priorly set up.</p>
</div></blockquote>
<p><strong>Save in state</strong></p>
<blockquote>
<div><p>The state the user wishes to save the submission under when this button is pressed.</p>
</div></blockquote>
<p><strong>Event</strong></p>
<blockquote>
<div><p>An event to be fired when the button is clicked. The user must enter the name of the event.</p>
<p><strong>Show Validation</strong></p>
<blockquote>
<div><p>When the button is pressed, it will show any validation errors on the form.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Custom</strong></p>
<blockquote>
<div><p>A custom logic to evaluate when the button is clicked.</p>
</div></blockquote>
<p><strong>Reset</strong></p>
<blockquote>
<div><p>Reset the form fields back to their original state.</p>
</div></blockquote>
<p><strong>OAuth</strong></p>
<blockquote>
<div><p>Perform OAuth authentication.</p>
</div></blockquote>
<p><strong>POST to URL</strong></p>
<blockquote>
<div><p>The URL where the submission will be sent.</p>
<p><strong>Headers</strong></p>
<blockquote>
<div><p>Headers properties and values for the request.</p>
</div></blockquote>
</div></blockquote>
</div></blockquote>
<p><strong>Theme</strong></p>
<blockquote>
<div><p>The color theme of the button.</p>
</div></blockquote>
<p><strong>Size</strong></p>
<blockquote>
<div><p>The size of the button.</p>
</div></blockquote>
<p><strong>Block Button</strong></p>
<blockquote>
<div><p>This control should span the full width of the bounding container.</p>
</div></blockquote>
<p><strong>Left Icon</strong></p>
<blockquote>
<div><p>The full icon class string to show the icon.</p>
</div></blockquote>
<p><strong>Right Icon</strong></p>
<blockquote>
<div><p>The full icon class string to show the icon.</p>
</div></blockquote>
<p><strong>Shortcut</strong></p>
<blockquote>
<div><p>The shortcut for this component.</p>
</div></blockquote>
</div></blockquote>
</div>
</div>
<div class="section" id="advanced-form-components">
<h2>Advanced Form Components<a class="headerlink" href="#advanced-form-components" title="Permalink to this headline">¶</a></h2>
<p>The Advanced forms contain the most advanced forms of inputs.</p>
<div class="section" id="email">
<h3>Email<a class="headerlink" href="#email" title="Permalink to this headline">¶</a></h3>
<p>The email component is nearly identical to the text field component. The Email component has a custom validation setting that, if set up correctly, can ensure the value entered is a valid email address. The email component can also more easily be integrate into a form’s email action. Use this component when you want an email address field for your form.</p>
</div>
<div class="section" id="url">
<h3>URL<a class="headerlink" href="#url" title="Permalink to this headline">¶</a></h3>
<p>The URL component is nearly identical to the text field component, except that it does not accept simple text.</p>
</div>
<div class="section" id="phone-number">
<h3>Phone Number<a class="headerlink" href="#phone-number" title="Permalink to this headline">¶</a></h3>
<p>The phone number form component can be used to enter phone numbers in a form. A textfield can be used for general text input that is shorter than a sentence. There are options to define input masks and validations so information can be molded into desired formats.</p>
</div>
<div class="section" id="tags">
<h3>Tags<a class="headerlink" href="#tags" title="Permalink to this headline">¶</a></h3>
<p>The Tags component is very similar to text field, but is used to add tags to the form.</p>
<p><strong>Data</strong></p>
<blockquote>
<div><p><strong>Delimiter</strong></p>
<blockquote>
<div><p>The delimiter to be used to separate the tags.</p>
</div></blockquote>
<p><strong>Max Tags</strong></p>
<blockquote>
<div><p>The maximum amount of tags that can be added. If set to 0, there will be no limit.</p>
</div></blockquote>
<p><strong>Store As</strong></p>
<blockquote>
<div><p>The data type in which the tags will be stored. There are two options: string (CSV) or array of tags.</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="address">
<h3>Address<a class="headerlink" href="#address" title="Permalink to this headline">¶</a></h3>
<p>The address form component is a special component that does lookups for addresses entered. It can be entered in free form and will save the address as well as geolocation and other information.</p>
<p><strong>Display</strong></p>
<blockquote>
<div><p><strong>Region Bias</strong></p>
<blockquote>
<div><p>The region bias to use for this search.</p>
</div></blockquote>
<p><strong>Google Maps API Key</strong></p>
<blockquote>
<div><p>The API kay for Google Maps. A full account on how to get an Google Maps API key, please visit <a class="reference external" href="https://developers.google.com/maps/documentation/geocoding/get-api-key">Google’s Developers site on the theme</a> (<a class="reference external" href="https://developers.google.com/maps/documentation/geocoding/get-api-key">https://developers.google.com/maps/documentation/geocoding/get-api-key</a>).</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="date-time">
<h3>Date / Time<a class="headerlink" href="#date-time" title="Permalink to this headline">¶</a></h3>
<p>Date/Time form components can be used to input dates, times or both.</p>
<p><strong>Display</strong></p>
<blockquote>
<div><p><strong>Display in Timezone</strong></p>
<blockquote>
<div><p>This will display the captured date time in the selected timezone. The user can selected between datime of: the Viewer, Submission, Location or UTC. In case of “Location”, the user will have to choose the location in the dropdown menu.</p>
</div></blockquote>
<p><strong>Use Locale Settings</strong></p>
<blockquote>
<div><p>Use locale settings to display date and time.</p>
</div></blockquote>
<p><strong>Format</strong></p>
<blockquote>
<div><p>The date format for displaying the datetime value. For a complete list of accepted formats, please visit <a class="reference external" href="https://github.com/angular-ui/bootstrap/tree/master/src/dateparser/docs#uibdateparsers-format-codes">this site</a> (<a class="reference external" href="https://github.com/angular-ui/bootstrap/tree/master/src/dateparser/docs#uibdateparsers-format-codes">https://github.com/angular-ui/bootstrap/tree/master/src/dateparser/docs#uibdateparsers-format-codes</a>).</p>
</div></blockquote>
</div></blockquote>
<p><strong>Date</strong></p>
<blockquote>
<div><p><strong>Enable Date Input</strong></p>
<blockquote>
<div><p>This option enables date input for this field.</p>
</div></blockquote>
<p><strong>Minimum Date</strong></p>
<blockquote>
<div><p>The minimum date that can be picked.</p>
</div></blockquote>
<p><strong>Maximum Date</strong></p>
<blockquote>
<div><p>The maximum date that can be picked.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Time</strong></p>
<blockquote>
<div><p><strong>Enable Time Input</strong></p>
<blockquote>
<div><p>This option enables time input for this field.</p>
</div></blockquote>
<p><strong>Hour Step Size</strong></p>
<blockquote>
<div><p>The number of hours to increment/decrement in the time picker.</p>
</div></blockquote>
<p><strong>Minute Step Size</strong></p>
<blockquote>
<div><p>The number of minutes to increment/decrement in the time picker.</p>
</div></blockquote>
<p><strong>12 Hour Time (AM/PM)</strong></p>
<blockquote>
<div><p>This option enables 12 hour time with AM/PM.</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="day">
<h3>Day<a class="headerlink" href="#day" title="Permalink to this headline">¶</a></h3>
<p>Component to input dates.</p>
<p><strong>Day</strong></p>
<blockquote>
<div><p><strong>Select</strong></p>
<blockquote>
<div><p>In this option, users can choose between “Number” and “Select”. It means that the end user will be presented with an empty field for typing the number of the Day or with a dropdown menu with all available Days.</p>
</div></blockquote>
<p><strong>Day first</strong></p>
<blockquote>
<div><p>Display the Day field before Month field.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Month</strong></p>
<blockquote>
<div><p><strong>Select</strong></p>
<blockquote>
<div><p>In this option, users can choose between “Number” and “Select”. It means that the end user will be presented with an empty field for typing the name of the Month or with a dropdown menu with all available Months.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Year</strong></p>
<blockquote>
<div><p><strong>Select</strong></p>
<p>In this option, users can choose between “Number” and “Select”. It means that the end user will be presented with an empty field for typing the number of the Year or with a dropdown menu with all available Years.</p>
<p><strong>Minimum Year</strong></p>
<blockquote>
<div><p>The minimum year that can be entered.</p>
</div></blockquote>
<p><strong>Maximum Year</strong></p>
<blockquote>
<div><p>The maximum year that can be entered.</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="time">
<h3>Time<a class="headerlink" href="#time" title="Permalink to this headline">¶</a></h3>
<p>Component to input time.</p>
<p><strong>Display</strong></p>
<blockquote>
<div><p><strong>Input Type</strong></p>
<blockquote>
<div><p>The type of widget to use. There are two options: HTML 5 Time Input and Text Input with Mask.</p>
</div></blockquote>
</div></blockquote>
<p><strong>Data</strong></p>
<blockquote>
<div><p><strong>Data Format</strong></p>
<blockquote>
<div><p>The moment.js format for saving the value of this field.</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="currency">
<h3>Currency<a class="headerlink" href="#currency" title="Permalink to this headline">¶</a></h3>
<p>The Currency component should be used when a field should display currency amounts on a form. This component holds a numeric input mask that allows two decimal values and automatically adds commas as a user inputs a currency amount.</p>
<p><strong>Data</strong></p>
<blockquote>
<div><p><strong>Currency</strong></p>
<blockquote>
<div><p>The currency to use in the currency formatting. Possible values are currency codes (ISO-4217).</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="survey">
<h3>Survey<a class="headerlink" href="#survey" title="Permalink to this headline">¶</a></h3>
<p>The Survey component works similar to the radio. Instead of one question, users are able to select a value for multiple questions which are configured within the component settings. Survey is a great component to utilize when asking multiple questions with the same context of answers or values.</p>
<p><strong>Data</strong></p>
<blockquote>
<div><p><strong>Questions</strong></p>
<blockquote>
<div><p>The questions users want to ask in the survey.</p>
</div></blockquote>
<p><strong>Values</strong></p>
<blockquote>
<div><p>The values that can be selected per question.</p>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="signature">
<h3>Signature<a class="headerlink" href="#signature" title="Permalink to this headline">¶</a></h3>
<p>A signature field is a special field that allows someone to sign the field with either their finger on a touch enabled device or with the mouse pointer. This signature will be converted into an image and stored with the form submission.</p>
<p><strong>Display</strong></p>
<blockquote>
<div><p><strong>Footer Label</strong></p>
<blockquote>
<div><p>The footer text that appears below the signature area.</p>
</div></blockquote>
<p><strong>Width</strong></p>
<blockquote>
<div><p>The width of the signature area. This can be in pixels or percents.</p>
</div></blockquote>
<p><strong>Height</strong></p>
<blockquote>
<div><p>The height of the signature area. This can be in pixels or percents.</p>
</div></blockquote>
<p><strong>Background Color</strong></p>
<blockquote>
<div><p>The background color of the signature area. This can be an RGB value in RGB(255,255,255) format, a hex value like #000000 or the name of a color.</p>
</div></blockquote>
<p><strong>Pen Color</strong></p>
<blockquote>
<div><p>The ink color of the signature area. This can be an RGB value in RGB(255,255,255) format, a hex value like #000000 or the name of a color.</p>
</div></blockquote>
</div></blockquote>
</div>
</div>
<div class="section" id="layout-form-components">
<h2>Layout Form Components<a class="headerlink" href="#layout-form-components" title="Permalink to this headline">¶</a></h2>
<p>The Layout forms contain view-related forms of input.</p>
<div class="section" id="html-element">
<h3>HTML Element<a class="headerlink" href="#html-element" title="Permalink to this headline">¶</a></h3>