@verdocs/web-sdk 4.0.9 → 4.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (493) hide show
  1. package/dist/cjs/{EnvelopeStore-13f60ae9.js → EnvelopeStore-db4f3f17.js} +10 -0
  2. package/dist/cjs/{TemplateFieldStore-6a79aae7.js → TemplateFieldStore-2db70818.js} +2 -6
  3. package/dist/cjs/{TemplateRoleStore-06db6e56.js → TemplateRoleStore-fb869e9a.js} +0 -5
  4. package/dist/cjs/{TemplateStore-5a46be5e.js → TemplateStore-037833e5.js} +20 -5
  5. package/dist/cjs/index-cfdfab36.js +18 -18
  6. package/dist/cjs/{interact.min-3f0b5e7d.js → interact.min-ee721bdc.js} +1 -1
  7. package/dist/cjs/loader.cjs.js +1 -1
  8. package/dist/cjs/{utils-5eb11b46.js → utils-d9ecd23d.js} +5 -12
  9. package/dist/cjs/verdocs-auth.cjs.entry.js +1 -1
  10. package/dist/cjs/verdocs-build.cjs.entry.js +29 -24
  11. package/dist/cjs/verdocs-button-panel.cjs.entry.js +2 -2
  12. package/dist/cjs/verdocs-button_3.cjs.entry.js +5 -5
  13. package/dist/cjs/{verdocs-checkbox_5.cjs.entry.js → verdocs-checkbox_3.cjs.entry.js} +5 -93
  14. package/dist/cjs/verdocs-component-error.cjs.entry.js +21 -0
  15. package/dist/cjs/verdocs-contact-picker_2.cjs.entry.js +30 -11
  16. package/dist/cjs/verdocs-dialog_2.cjs.entry.js +4 -6
  17. package/dist/cjs/verdocs-dropdown.cjs.entry.js +1 -1
  18. package/dist/cjs/verdocs-envelope-document-page.cjs.entry.js +2 -2
  19. package/dist/cjs/verdocs-envelope-recipient-link_2.cjs.entry.js +1 -1
  20. package/dist/cjs/verdocs-envelope-sidebar.cjs.entry.js +1 -1
  21. package/dist/cjs/verdocs-envelopes-list.cjs.entry.js +7 -7
  22. package/dist/cjs/{verdocs-field-attachment_14.cjs.entry.js → verdocs-field-attachment_13.cjs.entry.js} +202 -377
  23. package/dist/cjs/verdocs-field-payment.cjs.entry.js +3 -3
  24. package/dist/cjs/verdocs-file-chooser_2.cjs.entry.js +3 -3
  25. package/dist/cjs/verdocs-kba-dialog.cjs.entry.js +5 -5
  26. package/dist/cjs/verdocs-loader.cjs.entry.js +1 -1
  27. package/dist/cjs/verdocs-ok-dialog.cjs.entry.js +2 -2
  28. package/dist/cjs/{verdocs-organization-card.cjs.entry.js → verdocs-organization-card_2.cjs.entry.js} +85 -5
  29. package/dist/cjs/verdocs-pagination_2.cjs.entry.js +3 -3
  30. package/dist/cjs/verdocs-preview_10.cjs.entry.js +156 -79
  31. package/dist/cjs/verdocs-quick-functions_2.cjs.entry.js +2 -2
  32. package/dist/cjs/verdocs-radio-button_3.cjs.entry.js +12 -12
  33. package/dist/cjs/verdocs-search-tabs.cjs.entry.js +1 -1
  34. package/dist/cjs/verdocs-search.cjs.entry.js +1 -1
  35. package/dist/cjs/verdocs-settings-api-keys_4.cjs.entry.js +11 -24
  36. package/dist/cjs/verdocs-settings.cjs.entry.js +1 -2
  37. package/dist/cjs/verdocs-sign.cjs.entry.js +2 -2
  38. package/dist/cjs/verdocs-spinner.cjs.entry.js +1 -1
  39. package/dist/cjs/verdocs-status-indicator.cjs.entry.js +11 -3
  40. package/dist/cjs/verdocs-tabs.cjs.entry.js +2 -2
  41. package/dist/cjs/verdocs-template-card.cjs.entry.js +1 -1
  42. package/dist/cjs/verdocs-template-document-page_2.cjs.entry.js +210 -0
  43. package/dist/cjs/verdocs-template-star.cjs.entry.js +1 -1
  44. package/dist/cjs/verdocs-template-tags.cjs.entry.js +1 -1
  45. package/dist/cjs/verdocs-templates-list.cjs.entry.js +7 -7
  46. package/dist/cjs/verdocs-toggle.cjs.entry.js +1 -1
  47. package/dist/cjs/verdocs-view.cjs.entry.js +1 -1
  48. package/dist/cjs/verdocs-web-sdk.cjs.js +1 -1
  49. package/dist/collection/collection-manifest.json +0 -1
  50. package/dist/collection/components/controls/verdocs-button/verdocs-button.js +4 -4
  51. package/dist/collection/components/controls/verdocs-button-panel/verdocs-button-panel.js +14 -2
  52. package/dist/collection/components/controls/verdocs-checkbox/verdocs-checkbox.js +2 -2
  53. package/dist/collection/components/controls/verdocs-component-error/verdocs-component-error.js +1 -1
  54. package/dist/collection/components/controls/verdocs-dropdown/verdocs-dropdown.js +2 -2
  55. package/dist/collection/components/controls/verdocs-file-chooser/verdocs-file-chooser.js +5 -1
  56. package/dist/collection/components/controls/verdocs-help-icon/verdocs-help-icon.css +2 -2
  57. package/dist/collection/components/controls/verdocs-help-icon/verdocs-help-icon.js +5 -1
  58. package/dist/collection/components/controls/verdocs-loader/verdocs-loader.js +5 -1
  59. package/dist/collection/components/controls/verdocs-organization-card/verdocs-organization-card.css +13 -21
  60. package/dist/collection/components/controls/verdocs-organization-card/verdocs-organization-card.js +36 -5
  61. package/dist/collection/components/controls/verdocs-pagination/verdocs-pagination.js +10 -1
  62. package/dist/collection/components/controls/verdocs-portal/verdocs-portal.js +13 -2
  63. package/dist/collection/components/controls/verdocs-progress-bar/verdocs-progress-bar.css +1 -0
  64. package/dist/collection/components/controls/verdocs-progress-bar/verdocs-progress-bar.js +6 -2
  65. package/dist/collection/components/controls/verdocs-quick-filter/verdocs-quick-filter.js +5 -1
  66. package/dist/collection/components/controls/verdocs-radio-button/verdocs-radio-button.js +2 -2
  67. package/dist/collection/components/controls/verdocs-select-input/verdocs-select-input.js +6 -2
  68. package/dist/collection/components/controls/verdocs-spinner/verdocs-spinner.js +5 -1
  69. package/dist/collection/components/controls/verdocs-table/verdocs-table.js +7 -5
  70. package/dist/collection/components/controls/verdocs-tabs/verdocs-tabs.css +1 -1
  71. package/dist/collection/components/controls/verdocs-tabs/verdocs-tabs.js +5 -1
  72. package/dist/collection/components/controls/verdocs-text-input/verdocs-text-input.js +7 -3
  73. package/dist/collection/components/controls/verdocs-toggle/verdocs-toggle.js +6 -2
  74. package/dist/collection/components/controls/verdocs-toggle-button/verdocs-toggle-button.js +5 -1
  75. package/dist/collection/components/controls/verdocs-toolbar-icon/verdocs-toolbar-icon.js +5 -1
  76. package/dist/collection/components/dialogs/verdocs-dialog/verdocs-dialog.js +1 -1
  77. package/dist/collection/components/dialogs/verdocs-initial-dialog/verdocs-initial-dialog.js +9 -7
  78. package/dist/collection/components/dialogs/verdocs-kba-dialog/verdocs-kba-dialog.css +11 -0
  79. package/dist/collection/components/dialogs/verdocs-kba-dialog/verdocs-kba-dialog.js +7 -9
  80. package/dist/collection/components/dialogs/verdocs-ok-dialog/verdocs-ok-dialog.css +2 -1
  81. package/dist/collection/components/dialogs/verdocs-ok-dialog/verdocs-ok-dialog.js +1 -1
  82. package/dist/collection/components/dialogs/verdocs-signature-dialog/verdocs-signature-dialog.js +6 -7
  83. package/dist/collection/components/dialogs/verdocs-upload-dialog/verdocs-upload-dialog.js +1 -1
  84. package/dist/collection/components/elements/verdocs-quick-functions/verdocs-quick-functions.js +1 -1
  85. package/dist/collection/components/elements/verdocs-search-box/verdocs-search-box.js +1 -1
  86. package/dist/collection/components/elements/verdocs-search-tabs/verdocs-search-tabs.js +1 -1
  87. package/dist/collection/components/embeds/verdocs-auth/verdocs-auth.js +10 -24
  88. package/dist/collection/components/embeds/verdocs-build/verdocs-build.js +31 -22
  89. package/dist/collection/components/embeds/verdocs-preview/verdocs-preview.js +42 -19
  90. package/dist/collection/components/embeds/verdocs-search/verdocs-search.js +1 -1
  91. package/dist/collection/components/embeds/verdocs-send/verdocs-send.js +85 -36
  92. package/dist/collection/components/embeds/verdocs-settings/verdocs-settings.js +5 -2
  93. package/dist/collection/components/envelopes/verdocs-contact-picker/verdocs-contact-picker.css +9 -1
  94. package/dist/collection/components/envelopes/verdocs-contact-picker/verdocs-contact-picker.js +30 -8
  95. package/dist/collection/components/envelopes/verdocs-envelope-document-page/verdocs-envelope-document-page.js +1 -1
  96. package/dist/collection/components/envelopes/verdocs-envelopes-list/verdocs-envelopes-list.js +6 -6
  97. package/dist/collection/components/envelopes/verdocs-status-indicator/verdocs-status-indicator.js +2 -2
  98. package/dist/collection/components/fields/verdocs-field-attachment/verdocs-field-attachment.css +7 -3
  99. package/dist/collection/components/fields/verdocs-field-attachment/verdocs-field-attachment.js +118 -43
  100. package/dist/collection/components/fields/verdocs-field-checkbox/verdocs-field-checkbox.css +2 -1
  101. package/dist/collection/components/fields/verdocs-field-checkbox/verdocs-field-checkbox.js +22 -27
  102. package/dist/collection/components/fields/verdocs-field-date/verdocs-field-date.css +76 -33
  103. package/dist/collection/components/fields/verdocs-field-date/verdocs-field-date.js +21 -29
  104. package/dist/collection/components/fields/verdocs-field-dropdown/verdocs-field-dropdown.css +1 -1
  105. package/dist/collection/components/fields/verdocs-field-dropdown/verdocs-field-dropdown.js +20 -28
  106. package/dist/collection/components/fields/verdocs-field-initial/verdocs-field-initial.css +1 -1
  107. package/dist/collection/components/fields/verdocs-field-initial/verdocs-field-initial.js +26 -28
  108. package/dist/collection/components/fields/verdocs-field-payment/verdocs-field-payment.css +1 -1
  109. package/dist/collection/components/fields/verdocs-field-radio-button-group/verdocs-field-radio-button.css +1 -1
  110. package/dist/collection/components/fields/verdocs-field-radio-button-group/verdocs-field-radio-button.js +22 -29
  111. package/dist/collection/components/fields/verdocs-field-signature/verdocs-field-signature.css +1 -1
  112. package/dist/collection/components/fields/verdocs-field-signature/verdocs-field-signature.js +27 -30
  113. package/dist/collection/components/fields/verdocs-field-textarea/verdocs-field-textarea.css +1 -1
  114. package/dist/collection/components/fields/verdocs-field-textarea/verdocs-field-textarea.js +21 -27
  115. package/dist/collection/components/fields/verdocs-field-textbox/verdocs-field-textbox.css +1 -1
  116. package/dist/collection/components/fields/verdocs-field-textbox/verdocs-field-textbox.js +19 -31
  117. package/dist/collection/components/fields/verdocs-field-timestamp/verdocs-field-timestamp.css +1 -1
  118. package/dist/collection/components/fields/verdocs-field-timestamp/verdocs-field-timestamp.js +21 -31
  119. package/dist/collection/components/settings/verdocs-settings-api-keys/verdocs-settings-api-keys.js +5 -5
  120. package/dist/collection/components/settings/verdocs-settings-members/verdocs-settings-members.js +5 -11
  121. package/dist/collection/components/settings/verdocs-settings-organization/verdocs-settings-organization.js +0 -8
  122. package/dist/collection/components/templates/verdocs-template-build-tabs/verdocs-template-build-tabs.css +37 -2
  123. package/dist/collection/components/templates/verdocs-template-build-tabs/verdocs-template-build-tabs.js +50 -25
  124. package/dist/collection/components/templates/verdocs-template-card/verdocs-template-card.js +1 -1
  125. package/dist/collection/components/templates/verdocs-template-document-page/verdocs-template-document-page.js +1 -1
  126. package/dist/collection/components/templates/verdocs-template-role-properties/verdocs-template-role-properties.js +7 -7
  127. package/dist/collection/components/templates/verdocs-template-roles/verdocs-template-roles.js +1 -0
  128. package/dist/collection/components/templates/verdocs-template-sender/verdocs-template-sender.js +1 -1
  129. package/dist/collection/components/templates/verdocs-template-star/verdocs-template-star.js +1 -1
  130. package/dist/collection/components/templates/verdocs-template-tags/verdocs-template-tags.js +1 -1
  131. package/dist/collection/components/templates/verdocs-templates-list/verdocs-templates-list.js +7 -7
  132. package/dist/collection/utils/EnvelopeStore.js +10 -0
  133. package/dist/collection/utils/TemplateFieldStore.js +2 -10
  134. package/dist/collection/utils/TemplateRoleStore.js +0 -5
  135. package/dist/collection/utils/TemplateStore.js +18 -3
  136. package/dist/collection/utils/utils.js +5 -12
  137. package/dist/components/EnvelopeStore.js +10 -0
  138. package/dist/components/TemplateFieldStore.js +2 -6
  139. package/dist/components/TemplateRoleStore.js +0 -5
  140. package/dist/components/TemplateStore.js +18 -3
  141. package/dist/components/index.js +0 -2
  142. package/dist/components/utils.js +5 -12
  143. package/dist/components/verdocs-auth.js +2 -2
  144. package/dist/components/verdocs-build.js +35 -24
  145. package/dist/components/verdocs-button-panel.js +1 -94
  146. package/dist/components/verdocs-button-panel2.js +96 -0
  147. package/dist/components/verdocs-button2.js +1 -1
  148. package/dist/components/verdocs-checkbox2.js +1 -1
  149. package/dist/components/verdocs-component-error2.js +1 -1
  150. package/dist/components/verdocs-contact-picker2.js +45 -11
  151. package/dist/components/verdocs-dialog2.js +1 -1
  152. package/dist/components/verdocs-dropdown2.js +1 -1
  153. package/dist/components/verdocs-envelope-document-page2.js +1 -1
  154. package/dist/components/verdocs-envelopes-list.js +6 -6
  155. package/dist/components/verdocs-field-attachment2.js +91 -39
  156. package/dist/components/verdocs-field-checkbox2.js +24 -29
  157. package/dist/components/verdocs-field-date2.js +22 -30
  158. package/dist/components/verdocs-field-dropdown2.js +21 -28
  159. package/dist/components/verdocs-field-initial2.js +21 -28
  160. package/dist/components/verdocs-field-payment.js +1 -1
  161. package/dist/components/verdocs-field-radio-button2.js +24 -31
  162. package/dist/components/verdocs-field-signature2.js +22 -30
  163. package/dist/components/verdocs-field-textarea2.js +20 -27
  164. package/dist/components/verdocs-field-textbox2.js +20 -32
  165. package/dist/components/verdocs-field-timestamp2.js +21 -32
  166. package/dist/components/verdocs-file-chooser2.js +1 -1
  167. package/dist/components/verdocs-help-icon2.js +2 -2
  168. package/dist/components/verdocs-initial-dialog2.js +9 -7
  169. package/dist/components/verdocs-kba-dialog.js +5 -5
  170. package/dist/components/verdocs-loader2.js +1 -1
  171. package/dist/components/verdocs-ok-dialog2.js +2 -2
  172. package/dist/components/verdocs-organization-card.js +22 -8
  173. package/dist/components/verdocs-pagination2.js +1 -1
  174. package/dist/components/verdocs-portal2.js +2 -2
  175. package/dist/components/verdocs-preview2.js +37 -19
  176. package/dist/components/verdocs-progress-bar2.js +2 -2
  177. package/dist/components/verdocs-quick-filter2.js +1 -1
  178. package/dist/components/verdocs-quick-functions2.js +1 -1
  179. package/dist/components/verdocs-radio-button2.js +1 -1
  180. package/dist/components/verdocs-search-box2.js +1 -1
  181. package/dist/components/verdocs-search-tabs.js +1 -1
  182. package/dist/components/verdocs-search.js +1 -1
  183. package/dist/components/verdocs-select-input2.js +1 -1
  184. package/dist/components/verdocs-send2.js +95 -36
  185. package/dist/components/verdocs-settings-api-keys2.js +5 -5
  186. package/dist/components/verdocs-settings-members2.js +5 -11
  187. package/dist/components/verdocs-settings-organization2.js +0 -8
  188. package/dist/components/verdocs-settings.js +8 -9
  189. package/dist/components/verdocs-signature-dialog2.js +6 -7
  190. package/dist/components/verdocs-spinner2.js +1 -1
  191. package/dist/components/verdocs-status-indicator2.js +11 -3
  192. package/dist/components/verdocs-table2.js +3 -5
  193. package/dist/components/verdocs-tabs2.js +2 -2
  194. package/dist/components/verdocs-template-build-tabs2.js +57 -27
  195. package/dist/components/verdocs-template-card.js +1 -1
  196. package/dist/components/verdocs-template-document-page2.js +1 -1
  197. package/dist/components/verdocs-template-role-properties2.js +7 -7
  198. package/dist/components/verdocs-template-roles2.js +1 -0
  199. package/dist/components/verdocs-template-sender2.js +1 -1
  200. package/dist/components/verdocs-template-star2.js +1 -1
  201. package/dist/components/verdocs-template-tags.js +1 -1
  202. package/dist/components/verdocs-templates-list.js +7 -7
  203. package/dist/components/verdocs-text-input2.js +2 -2
  204. package/dist/components/verdocs-toggle-button2.js +1 -1
  205. package/dist/components/verdocs-toggle.js +1 -1
  206. package/dist/components/verdocs-toolbar-icon2.js +1 -1
  207. package/dist/components/verdocs-upload-dialog2.js +1 -1
  208. package/dist/esm/{EnvelopeStore-fefba6fd.js → EnvelopeStore-9df042b5.js} +10 -0
  209. package/dist/esm/{TemplateFieldStore-d7516adf.js → TemplateFieldStore-32329b5a.js} +2 -6
  210. package/dist/esm/{TemplateRoleStore-ddc3b96f.js → TemplateRoleStore-0a4f98cb.js} +0 -5
  211. package/dist/esm/{TemplateStore-df5484bb.js → TemplateStore-78ad24d7.js} +20 -5
  212. package/dist/esm/index-b89cf6a4.js +18 -18
  213. package/dist/esm/{interact.min-b055a9b6.js → interact.min-4fac3f2b.js} +1 -1
  214. package/dist/esm/loader.js +1 -1
  215. package/dist/esm/{utils-61c1093b.js → utils-d1c95309.js} +6 -13
  216. package/dist/esm/verdocs-auth.entry.js +2 -2
  217. package/dist/esm/verdocs-build.entry.js +29 -24
  218. package/dist/esm/verdocs-button-panel.entry.js +2 -2
  219. package/dist/esm/verdocs-button_3.entry.js +5 -5
  220. package/dist/esm/{verdocs-checkbox_5.entry.js → verdocs-checkbox_3.entry.js} +6 -92
  221. package/dist/esm/verdocs-component-error.entry.js +17 -0
  222. package/dist/esm/verdocs-contact-picker_2.entry.js +30 -11
  223. package/dist/esm/verdocs-dialog_2.entry.js +4 -6
  224. package/dist/esm/verdocs-dropdown.entry.js +1 -1
  225. package/dist/esm/verdocs-envelope-document-page.entry.js +2 -2
  226. package/dist/esm/verdocs-envelope-recipient-link_2.entry.js +1 -1
  227. package/dist/esm/verdocs-envelope-sidebar.entry.js +1 -1
  228. package/dist/esm/verdocs-envelopes-list.entry.js +7 -7
  229. package/dist/esm/{verdocs-field-attachment_14.entry.js → verdocs-field-attachment_13.entry.js} +205 -379
  230. package/dist/esm/verdocs-field-payment.entry.js +3 -3
  231. package/dist/esm/verdocs-file-chooser_2.entry.js +3 -3
  232. package/dist/esm/verdocs-kba-dialog.entry.js +5 -5
  233. package/dist/esm/verdocs-loader.entry.js +1 -1
  234. package/dist/esm/verdocs-ok-dialog.entry.js +2 -2
  235. package/dist/esm/{verdocs-organization-card.entry.js → verdocs-organization-card_2.entry.js} +86 -7
  236. package/dist/esm/verdocs-pagination_2.entry.js +3 -3
  237. package/dist/esm/verdocs-preview_10.entry.js +156 -79
  238. package/dist/esm/verdocs-quick-functions_2.entry.js +2 -2
  239. package/dist/esm/verdocs-radio-button_3.entry.js +12 -12
  240. package/dist/esm/verdocs-search-tabs.entry.js +1 -1
  241. package/dist/esm/verdocs-search.entry.js +1 -1
  242. package/dist/esm/verdocs-settings-api-keys_4.entry.js +11 -24
  243. package/dist/esm/verdocs-settings.entry.js +1 -2
  244. package/dist/esm/verdocs-sign.entry.js +2 -2
  245. package/dist/esm/verdocs-spinner.entry.js +1 -1
  246. package/dist/esm/verdocs-status-indicator.entry.js +11 -3
  247. package/dist/esm/verdocs-tabs.entry.js +2 -2
  248. package/dist/esm/verdocs-template-card.entry.js +1 -1
  249. package/dist/esm/verdocs-template-document-page_2.entry.js +205 -0
  250. package/dist/esm/verdocs-template-star.entry.js +1 -1
  251. package/dist/esm/verdocs-template-tags.entry.js +1 -1
  252. package/dist/esm/verdocs-templates-list.entry.js +7 -7
  253. package/dist/esm/verdocs-toggle.entry.js +1 -1
  254. package/dist/esm/verdocs-view.entry.js +1 -1
  255. package/dist/esm/verdocs-web-sdk.js +1 -1
  256. package/dist/esm-es5/{EnvelopeStore-fefba6fd.js → EnvelopeStore-9df042b5.js} +1 -1
  257. package/dist/esm-es5/TemplateFieldStore-32329b5a.js +1 -0
  258. package/dist/esm-es5/TemplateRoleStore-0a4f98cb.js +1 -0
  259. package/dist/esm-es5/TemplateStore-78ad24d7.js +1 -0
  260. package/dist/esm-es5/index-b89cf6a4.js +1 -1
  261. package/dist/esm-es5/{interact.min-b055a9b6.js → interact.min-4fac3f2b.js} +1 -1
  262. package/dist/esm-es5/loader.js +1 -1
  263. package/dist/esm-es5/{utils-61c1093b.js → utils-d1c95309.js} +1 -1
  264. package/dist/esm-es5/verdocs-auth.entry.js +1 -1
  265. package/dist/esm-es5/verdocs-build.entry.js +1 -1
  266. package/dist/esm-es5/verdocs-button-panel.entry.js +1 -1
  267. package/dist/esm-es5/verdocs-button_3.entry.js +1 -1
  268. package/dist/esm-es5/verdocs-checkbox_3.entry.js +1 -0
  269. package/dist/esm-es5/verdocs-component-error.entry.js +1 -0
  270. package/dist/esm-es5/verdocs-contact-picker_2.entry.js +1 -1
  271. package/dist/esm-es5/verdocs-dialog_2.entry.js +1 -1
  272. package/dist/esm-es5/verdocs-dropdown.entry.js +1 -1
  273. package/dist/esm-es5/verdocs-envelope-document-page.entry.js +1 -1
  274. package/dist/esm-es5/verdocs-envelope-recipient-link_2.entry.js +1 -1
  275. package/dist/esm-es5/verdocs-envelope-sidebar.entry.js +1 -1
  276. package/dist/esm-es5/verdocs-envelopes-list.entry.js +1 -1
  277. package/dist/esm-es5/verdocs-field-attachment_13.entry.js +1 -0
  278. package/dist/esm-es5/verdocs-field-payment.entry.js +1 -1
  279. package/dist/esm-es5/verdocs-file-chooser_2.entry.js +1 -1
  280. package/dist/esm-es5/verdocs-kba-dialog.entry.js +1 -1
  281. package/dist/esm-es5/verdocs-loader.entry.js +1 -1
  282. package/dist/esm-es5/verdocs-ok-dialog.entry.js +1 -1
  283. package/dist/esm-es5/verdocs-organization-card_2.entry.js +1 -0
  284. package/dist/esm-es5/verdocs-pagination_2.entry.js +1 -1
  285. package/dist/esm-es5/verdocs-preview_10.entry.js +1 -1
  286. package/dist/esm-es5/verdocs-quick-functions_2.entry.js +1 -1
  287. package/dist/esm-es5/verdocs-radio-button_3.entry.js +1 -1
  288. package/dist/esm-es5/verdocs-search-tabs.entry.js +1 -1
  289. package/dist/esm-es5/verdocs-search.entry.js +1 -1
  290. package/dist/esm-es5/verdocs-settings-api-keys_4.entry.js +1 -1
  291. package/dist/esm-es5/verdocs-settings.entry.js +1 -1
  292. package/dist/esm-es5/verdocs-sign.entry.js +1 -1
  293. package/dist/esm-es5/verdocs-spinner.entry.js +1 -1
  294. package/dist/esm-es5/verdocs-status-indicator.entry.js +1 -1
  295. package/dist/esm-es5/verdocs-tabs.entry.js +1 -1
  296. package/dist/esm-es5/verdocs-template-card.entry.js +1 -1
  297. package/dist/esm-es5/verdocs-template-document-page_2.entry.js +1 -0
  298. package/dist/esm-es5/verdocs-template-star.entry.js +1 -1
  299. package/dist/esm-es5/verdocs-template-tags.entry.js +1 -1
  300. package/dist/esm-es5/verdocs-templates-list.entry.js +1 -1
  301. package/dist/esm-es5/verdocs-toggle.entry.js +1 -1
  302. package/dist/esm-es5/verdocs-view.entry.js +1 -1
  303. package/dist/esm-es5/verdocs-web-sdk.js +1 -1
  304. package/dist/types/components/controls/verdocs-button/verdocs-button.d.ts +3 -3
  305. package/dist/types/components/controls/verdocs-button-panel/verdocs-button-panel.d.ts +12 -0
  306. package/dist/types/components/controls/verdocs-checkbox/verdocs-checkbox.d.ts +1 -1
  307. package/dist/types/components/controls/verdocs-dropdown/verdocs-dropdown.d.ts +1 -1
  308. package/dist/types/components/controls/verdocs-file-chooser/verdocs-file-chooser.d.ts +4 -0
  309. package/dist/types/components/controls/verdocs-help-icon/verdocs-help-icon.d.ts +4 -0
  310. package/dist/types/components/controls/verdocs-loader/verdocs-loader.d.ts +4 -0
  311. package/dist/types/components/controls/verdocs-organization-card/verdocs-organization-card.d.ts +9 -2
  312. package/dist/types/components/controls/verdocs-pagination/verdocs-pagination.d.ts +9 -0
  313. package/dist/types/components/controls/verdocs-portal/verdocs-portal.d.ts +11 -0
  314. package/dist/types/components/controls/verdocs-progress-bar/verdocs-progress-bar.d.ts +5 -1
  315. package/dist/types/components/controls/verdocs-quick-filter/verdocs-quick-filter.d.ts +4 -0
  316. package/dist/types/components/controls/verdocs-radio-button/verdocs-radio-button.d.ts +1 -1
  317. package/dist/types/components/controls/verdocs-select-input/verdocs-select-input.d.ts +5 -1
  318. package/dist/types/components/controls/verdocs-spinner/verdocs-spinner.d.ts +4 -0
  319. package/dist/types/components/controls/verdocs-table/verdocs-table.d.ts +4 -0
  320. package/dist/types/components/controls/verdocs-tabs/verdocs-tabs.d.ts +4 -0
  321. package/dist/types/components/controls/verdocs-text-input/verdocs-text-input.d.ts +5 -1
  322. package/dist/types/components/controls/verdocs-toggle/verdocs-toggle.d.ts +5 -1
  323. package/dist/types/components/controls/verdocs-toggle-button/verdocs-toggle-button.d.ts +4 -0
  324. package/dist/types/components/controls/verdocs-toolbar-icon/verdocs-toolbar-icon.d.ts +4 -0
  325. package/dist/types/components/dialogs/verdocs-kba-dialog/verdocs-kba-dialog.d.ts +1 -3
  326. package/dist/types/components/embeds/verdocs-auth/verdocs-auth.d.ts +10 -22
  327. package/dist/types/components/embeds/verdocs-build/verdocs-build.d.ts +8 -4
  328. package/dist/types/components/embeds/verdocs-preview/verdocs-preview.d.ts +6 -0
  329. package/dist/types/components/embeds/verdocs-send/verdocs-send.d.ts +17 -7
  330. package/dist/types/components/embeds/verdocs-settings/verdocs-settings.d.ts +4 -0
  331. package/dist/types/components/envelopes/verdocs-contact-picker/verdocs-contact-picker.d.ts +3 -0
  332. package/dist/types/components/fields/verdocs-field-attachment/verdocs-field-attachment.d.ts +25 -10
  333. package/dist/types/components/fields/verdocs-field-date/verdocs-field-date.d.ts +3 -3
  334. package/dist/types/components/fields/verdocs-field-dropdown/verdocs-field-dropdown.d.ts +1 -2
  335. package/dist/types/components/fields/verdocs-field-initial/verdocs-field-initial.d.ts +7 -2
  336. package/dist/types/components/fields/verdocs-field-signature/verdocs-field-signature.d.ts +7 -2
  337. package/dist/types/components/fields/verdocs-field-textarea/verdocs-field-textarea.d.ts +2 -1
  338. package/dist/types/components/fields/verdocs-field-textbox/verdocs-field-textbox.d.ts +1 -1
  339. package/dist/types/components/fields/verdocs-field-timestamp/verdocs-field-timestamp.d.ts +2 -1
  340. package/dist/types/components/settings/verdocs-settings-organization/verdocs-settings-organization.d.ts +0 -1
  341. package/dist/types/components/templates/verdocs-template-build-tabs/verdocs-template-build-tabs.d.ts +5 -3
  342. package/dist/types/components.d.ts +531 -253
  343. package/dist/types/utils/TemplateFieldStore.d.ts +0 -1
  344. package/dist/verdocs-web-sdk/{p-0003dac3.entry.js → p-000b8414.entry.js} +1 -1
  345. package/dist/verdocs-web-sdk/p-05c9b6c9.system.entry.js +1 -0
  346. package/dist/verdocs-web-sdk/{p-db9ef2cc.entry.js → p-0a0ac65f.entry.js} +1 -1
  347. package/dist/verdocs-web-sdk/p-0d5fb952.system.js +1 -0
  348. package/dist/verdocs-web-sdk/{p-79407dd8.entry.js → p-0ff14c4d.entry.js} +1 -1
  349. package/dist/verdocs-web-sdk/p-13450dcd.system.entry.js +1 -0
  350. package/dist/verdocs-web-sdk/{p-c1f7cfff.system.entry.js → p-16850eac.system.entry.js} +1 -1
  351. package/dist/verdocs-web-sdk/{p-82fbf5b5.entry.js → p-1dd1d686.entry.js} +1 -1
  352. package/dist/verdocs-web-sdk/{p-79cef953.system.entry.js → p-1fec2d1e.system.entry.js} +1 -1
  353. package/dist/verdocs-web-sdk/{p-483cc30b.entry.js → p-203d8ff0.entry.js} +1 -1
  354. package/dist/verdocs-web-sdk/{p-c543852a.entry.js → p-225418c7.entry.js} +1 -1
  355. package/dist/verdocs-web-sdk/p-2b6566eb.entry.js +1 -0
  356. package/dist/verdocs-web-sdk/{p-c244e090.entry.js → p-3093ede7.entry.js} +1 -1
  357. package/dist/verdocs-web-sdk/{p-819187c7.system.entry.js → p-314321b8.system.entry.js} +1 -1
  358. package/dist/verdocs-web-sdk/p-316fc185.js +1 -0
  359. package/dist/verdocs-web-sdk/p-322fa613.system.js +1 -1
  360. package/dist/verdocs-web-sdk/p-3a8b2213.system.entry.js +1 -0
  361. package/dist/verdocs-web-sdk/p-4291db9f.entry.js +1 -0
  362. package/dist/verdocs-web-sdk/{p-84f477d1.entry.js → p-42ec5f5b.entry.js} +1 -1
  363. package/dist/verdocs-web-sdk/{p-aaa5c11a.system.entry.js → p-43962d76.system.entry.js} +1 -1
  364. package/dist/verdocs-web-sdk/p-4542fd4b.entry.js +1 -0
  365. package/dist/verdocs-web-sdk/p-45cf0ab5.entry.js +1 -0
  366. package/dist/verdocs-web-sdk/p-4df630c2.system.entry.js +1 -0
  367. package/dist/verdocs-web-sdk/{p-35859fe1.system.entry.js → p-5070ad92.system.entry.js} +1 -1
  368. package/dist/verdocs-web-sdk/p-515ee177.system.entry.js +1 -0
  369. package/dist/verdocs-web-sdk/{p-4cd628a3.system.entry.js → p-5309a156.system.entry.js} +1 -1
  370. package/dist/verdocs-web-sdk/p-540d9467.entry.js +1 -0
  371. package/dist/verdocs-web-sdk/{p-4424d71f.system.entry.js → p-597bd8aa.system.entry.js} +1 -1
  372. package/dist/verdocs-web-sdk/{p-ac014bc9.system.entry.js → p-5be462d9.system.entry.js} +1 -1
  373. package/dist/verdocs-web-sdk/{p-6d1bdae8.system.js → p-5bec8b75.system.js} +1 -1
  374. package/dist/verdocs-web-sdk/{p-e92688db.entry.js → p-5df130eb.entry.js} +1 -1
  375. package/dist/verdocs-web-sdk/p-5e3e9c4a.system.js +1 -0
  376. package/dist/verdocs-web-sdk/{p-a88760cd.entry.js → p-62728531.entry.js} +1 -1
  377. package/dist/verdocs-web-sdk/{p-35157a14.js → p-627f774b.js} +1 -1
  378. package/dist/verdocs-web-sdk/p-62af2ee6.system.entry.js +1 -0
  379. package/dist/verdocs-web-sdk/{p-83d0f5e1.entry.js → p-67c3b3d1.entry.js} +1 -1
  380. package/dist/verdocs-web-sdk/{p-8fbf27ec.entry.js → p-6c5aee88.entry.js} +1 -1
  381. package/dist/verdocs-web-sdk/{p-7b009ca9.entry.js → p-71eeeff4.entry.js} +1 -1
  382. package/dist/verdocs-web-sdk/p-72c7e548.entry.js +1 -0
  383. package/dist/verdocs-web-sdk/p-73042665.entry.js +1 -0
  384. package/dist/verdocs-web-sdk/p-748ed4ef.entry.js +1 -0
  385. package/dist/verdocs-web-sdk/{p-ca71117e.system.entry.js → p-76297fa0.system.entry.js} +1 -1
  386. package/dist/verdocs-web-sdk/p-7b222135.system.entry.js +1 -0
  387. package/dist/verdocs-web-sdk/{p-7a9b4f83.entry.js → p-7b8ae86c.entry.js} +1 -1
  388. package/dist/verdocs-web-sdk/p-7c3b1e47.entry.js +1 -0
  389. package/dist/verdocs-web-sdk/{p-7ab60efa.entry.js → p-7e6fa885.entry.js} +1 -1
  390. package/dist/verdocs-web-sdk/{p-9a57eba9.entry.js → p-7ed27280.entry.js} +1 -1
  391. package/dist/verdocs-web-sdk/{p-db6a7e39.entry.js → p-7fe48d2e.entry.js} +1 -1
  392. package/dist/verdocs-web-sdk/{p-943c7b8f.system.entry.js → p-84781ec3.system.entry.js} +1 -1
  393. package/dist/verdocs-web-sdk/{p-c6645da7.system.entry.js → p-84caf3e1.system.entry.js} +1 -1
  394. package/dist/verdocs-web-sdk/{p-94c638b9.system.js → p-85519037.system.js} +1 -1
  395. package/dist/verdocs-web-sdk/p-900006b0.system.js +1 -0
  396. package/dist/verdocs-web-sdk/{p-756791df.system.entry.js → p-95e90092.system.entry.js} +1 -1
  397. package/dist/verdocs-web-sdk/{p-819fb18d.entry.js → p-96352ec7.entry.js} +1 -1
  398. package/dist/verdocs-web-sdk/p-971ab2d1.entry.js +1 -0
  399. package/dist/verdocs-web-sdk/{p-794109d4.entry.js → p-973a8142.entry.js} +1 -1
  400. package/dist/verdocs-web-sdk/{p-da7d343c.system.entry.js → p-98928410.system.entry.js} +1 -1
  401. package/dist/verdocs-web-sdk/{p-5f8341f5.system.entry.js → p-99510d53.system.entry.js} +1 -1
  402. package/dist/verdocs-web-sdk/p-9c05218b.entry.js +1 -0
  403. package/dist/verdocs-web-sdk/p-9ec464df.js +1 -0
  404. package/dist/verdocs-web-sdk/{p-e8e2bf33.entry.js → p-a5c6eac3.entry.js} +1 -1
  405. package/dist/verdocs-web-sdk/p-a908ebeb.system.entry.js +1 -0
  406. package/dist/verdocs-web-sdk/p-ac7d07de.system.entry.js +1 -0
  407. package/dist/verdocs-web-sdk/{p-79a5e9a6.entry.js → p-ad2814b4.entry.js} +1 -1
  408. package/dist/verdocs-web-sdk/p-afbbdc2f.system.js +1 -0
  409. package/dist/verdocs-web-sdk/p-b0df559c.entry.js +1 -0
  410. package/dist/verdocs-web-sdk/p-b3eab86c.entry.js +1 -0
  411. package/dist/verdocs-web-sdk/p-b699eeef.system.entry.js +1 -0
  412. package/dist/verdocs-web-sdk/{p-4297282e.system.entry.js → p-ba675574.system.entry.js} +1 -1
  413. package/dist/verdocs-web-sdk/{p-71a93045.system.entry.js → p-bb0ed696.system.entry.js} +1 -1
  414. package/dist/verdocs-web-sdk/p-bb1dc544.system.entry.js +1 -0
  415. package/dist/verdocs-web-sdk/{p-6fe0d270.entry.js → p-bbae0a6c.entry.js} +1 -1
  416. package/dist/verdocs-web-sdk/p-bf4a9089.system.entry.js +1 -0
  417. package/dist/verdocs-web-sdk/{p-7d035035.system.entry.js → p-bf8e7b5a.system.entry.js} +1 -1
  418. package/dist/verdocs-web-sdk/p-c28c4e43.js +1 -0
  419. package/dist/verdocs-web-sdk/{p-165bbc34.system.entry.js → p-c598ea74.system.entry.js} +1 -1
  420. package/dist/verdocs-web-sdk/{p-7b397f3a.js → p-cc32d84f.js} +1 -1
  421. package/dist/verdocs-web-sdk/p-ccdb7d88.system.entry.js +1 -0
  422. package/dist/verdocs-web-sdk/{p-8b5d40b6.system.entry.js → p-cf06ba29.system.entry.js} +1 -1
  423. package/dist/verdocs-web-sdk/{p-b259c449.system.entry.js → p-d4331e4f.system.entry.js} +1 -1
  424. package/dist/verdocs-web-sdk/p-d61235cf.entry.js +1 -0
  425. package/dist/verdocs-web-sdk/{p-164d9eb4.system.entry.js → p-e6992b79.system.entry.js} +1 -1
  426. package/dist/verdocs-web-sdk/p-e7b29b46.system.entry.js +1 -0
  427. package/dist/verdocs-web-sdk/{p-6a88d98b.entry.js → p-eaf4de2f.entry.js} +1 -1
  428. package/dist/verdocs-web-sdk/p-f05a3654.system.entry.js +1 -0
  429. package/dist/verdocs-web-sdk/{p-80d24da1.system.entry.js → p-f1d41587.system.entry.js} +1 -1
  430. package/dist/verdocs-web-sdk/p-f2f6c646.system.entry.js +1 -0
  431. package/dist/verdocs-web-sdk/{p-99c29b9c.system.entry.js → p-f54b4cc0.system.entry.js} +1 -1
  432. package/dist/verdocs-web-sdk/p-f69d8d39.js +1 -0
  433. package/dist/verdocs-web-sdk/{p-0bd91b17.entry.js → p-f91f3248.entry.js} +1 -1
  434. package/dist/verdocs-web-sdk/p-f9ffe6b9.entry.js +1 -0
  435. package/dist/verdocs-web-sdk/verdocs-web-sdk.esm.js +1 -1
  436. package/package.json +2 -2
  437. package/dist/cjs/verdocs-floating-menu.cjs.entry.js +0 -107
  438. package/dist/cjs/verdocs-toolbar-icon.cjs.entry.js +0 -52
  439. package/dist/collection/components/controls/verdocs-floating-menu/verdocs-floating-menu.css +0 -102
  440. package/dist/collection/components/controls/verdocs-floating-menu/verdocs-floating-menu.js +0 -162
  441. package/dist/components/verdocs-floating-menu.d.ts +0 -11
  442. package/dist/components/verdocs-floating-menu.js +0 -128
  443. package/dist/custom-elements.json +0 -2134
  444. package/dist/esm/verdocs-floating-menu.entry.js +0 -103
  445. package/dist/esm/verdocs-toolbar-icon.entry.js +0 -48
  446. package/dist/esm-es5/TemplateFieldStore-d7516adf.js +0 -1
  447. package/dist/esm-es5/TemplateRoleStore-ddc3b96f.js +0 -1
  448. package/dist/esm-es5/TemplateStore-df5484bb.js +0 -1
  449. package/dist/esm-es5/verdocs-checkbox_5.entry.js +0 -1
  450. package/dist/esm-es5/verdocs-field-attachment_14.entry.js +0 -1
  451. package/dist/esm-es5/verdocs-floating-menu.entry.js +0 -1
  452. package/dist/esm-es5/verdocs-organization-card.entry.js +0 -1
  453. package/dist/esm-es5/verdocs-toolbar-icon.entry.js +0 -1
  454. package/dist/types/components/controls/verdocs-floating-menu/verdocs-floating-menu.d.ts +0 -31
  455. package/dist/verdocs-web-sdk/p-039c572c.entry.js +0 -1
  456. package/dist/verdocs-web-sdk/p-05cfdd58.js +0 -1
  457. package/dist/verdocs-web-sdk/p-0ac52131.system.entry.js +0 -1
  458. package/dist/verdocs-web-sdk/p-0e74b009.entry.js +0 -1
  459. package/dist/verdocs-web-sdk/p-1200552e.system.entry.js +0 -1
  460. package/dist/verdocs-web-sdk/p-17801797.js +0 -1
  461. package/dist/verdocs-web-sdk/p-192fe783.system.entry.js +0 -1
  462. package/dist/verdocs-web-sdk/p-216757ff.entry.js +0 -1
  463. package/dist/verdocs-web-sdk/p-28d5af49.system.entry.js +0 -1
  464. package/dist/verdocs-web-sdk/p-36800dd4.js +0 -1
  465. package/dist/verdocs-web-sdk/p-3c3570cc.entry.js +0 -1
  466. package/dist/verdocs-web-sdk/p-50035423.entry.js +0 -1
  467. package/dist/verdocs-web-sdk/p-5714caa0.system.entry.js +0 -1
  468. package/dist/verdocs-web-sdk/p-5727dd92.system.entry.js +0 -1
  469. package/dist/verdocs-web-sdk/p-5b9c0b5d.system.entry.js +0 -1
  470. package/dist/verdocs-web-sdk/p-65d71829.entry.js +0 -1
  471. package/dist/verdocs-web-sdk/p-660a17c3.entry.js +0 -1
  472. package/dist/verdocs-web-sdk/p-6a82e278.system.js +0 -1
  473. package/dist/verdocs-web-sdk/p-6cd31085.system.entry.js +0 -1
  474. package/dist/verdocs-web-sdk/p-6f1df8e8.system.entry.js +0 -1
  475. package/dist/verdocs-web-sdk/p-721edea6.entry.js +0 -1
  476. package/dist/verdocs-web-sdk/p-727f9a9a.system.js +0 -1
  477. package/dist/verdocs-web-sdk/p-780c095e.entry.js +0 -1
  478. package/dist/verdocs-web-sdk/p-8e831c4b.system.entry.js +0 -1
  479. package/dist/verdocs-web-sdk/p-907bf2f3.entry.js +0 -1
  480. package/dist/verdocs-web-sdk/p-95e2ff59.system.entry.js +0 -1
  481. package/dist/verdocs-web-sdk/p-98f14855.system.js +0 -1
  482. package/dist/verdocs-web-sdk/p-a0857afa.entry.js +0 -1
  483. package/dist/verdocs-web-sdk/p-a0a08e62.system.entry.js +0 -1
  484. package/dist/verdocs-web-sdk/p-a164376d.system.entry.js +0 -1
  485. package/dist/verdocs-web-sdk/p-a1f6189b.system.js +0 -1
  486. package/dist/verdocs-web-sdk/p-ae6a23ba.system.entry.js +0 -1
  487. package/dist/verdocs-web-sdk/p-c22eccdd.entry.js +0 -1
  488. package/dist/verdocs-web-sdk/p-cdb8b832.entry.js +0 -1
  489. package/dist/verdocs-web-sdk/p-da9d0886.system.entry.js +0 -1
  490. package/dist/verdocs-web-sdk/p-ea798c11.entry.js +0 -1
  491. package/dist/verdocs-web-sdk/p-eb86419b.entry.js +0 -1
  492. package/dist/verdocs-web-sdk/p-ecfe6d7e.system.entry.js +0 -1
  493. package/dist/verdocs-web-sdk/p-f070e923.js +0 -1
@@ -12,7 +12,6 @@ import { TVerdocsBuildStep } from "./components/embeds/verdocs-build/verdocs-bui
12
12
  import { IContactSearchEvent, IContactSelectEvent, IEmailContact, IPhoneContact } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
13
13
  import { IMenuOption } from "./components/controls/verdocs-dropdown/verdocs-dropdown";
14
14
  import { IDocumentPageInfo, IPageLayer } from "./utils/Types";
15
- import { IOption } from "./components/controls/verdocs-floating-menu/verdocs-floating-menu";
16
15
  import { IFilterOption } from "./components/controls/verdocs-quick-filter/verdocs-quick-filter";
17
16
  import { ISearchEvent, TContentType } from "./components/elements/verdocs-search-box/verdocs-search-box";
18
17
  import { IContactSearchEvent as IContactSearchEvent1 } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
@@ -29,7 +28,6 @@ export { TVerdocsBuildStep } from "./components/embeds/verdocs-build/verdocs-bui
29
28
  export { IContactSearchEvent, IContactSelectEvent, IEmailContact, IPhoneContact } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
30
29
  export { IMenuOption } from "./components/controls/verdocs-dropdown/verdocs-dropdown";
31
30
  export { IDocumentPageInfo, IPageLayer } from "./utils/Types";
32
- export { IOption } from "./components/controls/verdocs-floating-menu/verdocs-floating-menu";
33
31
  export { IFilterOption } from "./components/controls/verdocs-quick-filter/verdocs-quick-filter";
34
32
  export { ISearchEvent, TContentType } from "./components/elements/verdocs-search-box/verdocs-search-box";
35
33
  export { IContactSearchEvent as IContactSearchEvent1 } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
@@ -64,26 +62,15 @@ export namespace Components {
64
62
  "view"?: 'completed' | 'action' | 'waiting';
65
63
  }
66
64
  /**
67
- * Display an authentication dialog that allows the user to login or sign up. Callbacks are provided for events that
68
- * occur during the process (especially successful completion). If the user is already authenticated with a valid
69
- * session, this component will hide itself and fire the success callback immediately. It is up to the host application
70
- * to render the next appropriate view for the application.
71
- * To simplify some types of authentication flows, a visibility flag can force this component to never display. This
72
- * allows you to susbcribe to notifications from the
65
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
66
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
67
+ * host application to render the next appropriate view for the application.
68
+ * To simplify UI development, a visibility flag can force this component to never display. This
69
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
73
70
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
74
71
  * container to allow sufficient space for the required forms.
75
- * As noted below, the primary event is `authenticated`. This will always be fired at least once, immediately after
76
- * the widget is rendered and the user's status has been checked. It may be fired again as the user completes (or
77
- * cancels) authentication steps.
78
- * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
79
- * embed. This Element will reuse the same session produced by logging in via that Embed.
80
- * ```typescript
81
- * interface IAuthStatus {
82
- * // If true, the user is authenticated with a valid session
83
- * authenticated: boolean;
84
- * // Details for the user's session
85
- * session: IActiveSession | null;
86
- * }
72
+ * ```ts
73
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
87
74
  * ```
88
75
  */
89
76
  interface VerdocsAuth {
@@ -102,6 +89,9 @@ export namespace Components {
102
89
  }
103
90
  /**
104
91
  * Display a template building experience.
92
+ * ```ts
93
+ * <verdocs-build templateId={templateId} />
94
+ * ```
105
95
  */
106
96
  interface VerdocsBuild {
107
97
  /**
@@ -118,9 +108,9 @@ export namespace Components {
118
108
  "templateId": string | null;
119
109
  }
120
110
  /**
121
- * A simple button
122
- * ```jsx
123
- * <verdocs-button label="Click Me" />
111
+ * A simple button, with consistent styling to other controls in the design system.
112
+ * ```ts
113
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
124
114
  * ```
125
115
  */
126
116
  interface VerdocsButton {
@@ -156,6 +146,17 @@ export namespace Components {
156
146
  /**
157
147
  * Display an icon button that triggers a drop-down panel that can display
158
148
  * arbitrary child content, such as metadata, forms, or other controls.
149
+ * ```ts
150
+ * <verdocs-button-panel .icon=${icon}>
151
+ * <h6>Field Settings</h6>
152
+ * <form>
153
+ * <p>
154
+ * <label>Field Name</label>
155
+ * <input type="text" placeholder="Field Name..." />
156
+ * </p>
157
+ * </form>
158
+ * </verdocs-button-panel>
159
+ * ```
159
160
  */
160
161
  interface VerdocsButtonPanel {
161
162
  "hidePanel": () => Promise<void>;
@@ -172,7 +173,7 @@ export namespace Components {
172
173
  * box for UI displays e.g. dialog boxes.
173
174
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
174
175
  * handler. Sample usage:
175
- * ```html
176
+ * ```ts
176
177
  * <verdocs-checkbox
177
178
  * value="on"
178
179
  * name="thingEnabled"
@@ -246,7 +247,7 @@ export namespace Components {
246
247
  /**
247
248
  * Display a drop-down menu button. A menu of the specified options will be displayed when the button is pressed. The menu will be hidden
248
249
  * when the button is pressed again, or an option is selected. Separators may be created by supplying an entry with an empty label.
249
- * ```html
250
+ * ```ts
250
251
  * <verdocs-dropdown
251
252
  * options={[
252
253
  * {label: 'Option 1', disabled: true},
@@ -410,6 +411,10 @@ export namespace Components {
410
411
  * If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be changed, so it should typically only be enabled in the Builder.
411
412
  */
412
413
  "editable"?: boolean;
414
+ /**
415
+ * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used. This component self-manages its resize (width) behavior when in edit-template mode, and uses this endpoint to save changes.
416
+ */
417
+ "endpoint": VerdocsEndpoint;
413
418
  /**
414
419
  * The name of the field to display.
415
420
  */
@@ -534,8 +539,7 @@ export namespace Components {
534
539
  "yscale"?: number;
535
540
  }
536
541
  /**
537
- * Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as
538
- * input types like text and checkbox.
542
+ * Displays a dropdown field that allows the user to choose one of a list of options.
539
543
  */
540
544
  interface VerdocsFieldDropdown {
541
545
  /**
@@ -579,8 +583,12 @@ export namespace Components {
579
583
  "yscale"?: number;
580
584
  }
581
585
  /**
582
- * Displays an initial field. If an initial already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
583
- * button will be shown. Clicking the button will show a dialog to adopt an initial.
586
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
587
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
588
+ * show a dialog to adopt an initial.
589
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
590
+ * This requires operation against a live, valid envelope. If you are testing this component
591
+ * in Storybook, it will not be visible here.
584
592
  */
585
593
  interface VerdocsFieldInitial {
586
594
  /**
@@ -724,8 +732,12 @@ export namespace Components {
724
732
  "yscale"?: number;
725
733
  }
726
734
  /**
727
- * Displays a signature field. If a signature already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
728
- * button will be shown. Clicking the button will show a dialog to adopt a signature.
735
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
736
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
737
+ * show a dialog to adopt a signature.
738
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
739
+ * This requires operation against a live, valid envelope. If you are testing this component
740
+ * in Storybook, it will not be visible here.
729
741
  */
730
742
  interface VerdocsFieldSignature {
731
743
  /**
@@ -773,7 +785,8 @@ export namespace Components {
773
785
  "yscale"?: number;
774
786
  }
775
787
  /**
776
- * Display a multi-line text input field.
788
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
789
+ * as the BOTTOM-LEFT corner.
777
790
  */
778
791
  interface VerdocsFieldTextarea {
779
792
  /**
@@ -821,7 +834,7 @@ export namespace Components {
821
834
  "yscale"?: number;
822
835
  }
823
836
  /**
824
- * Display a text input field.
837
+ * Display a simple 1-line text input field.
825
838
  */
826
839
  interface VerdocsFieldTextbox {
827
840
  /**
@@ -869,7 +882,8 @@ export namespace Components {
869
882
  "yscale"?: number;
870
883
  }
871
884
  /**
872
- * Display a timestamp field.
885
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
886
+ * filled when the signer submits the document.
873
887
  */
874
888
  interface VerdocsFieldTimestamp {
875
889
  /**
@@ -915,6 +929,9 @@ export namespace Components {
915
929
  /**
916
930
  * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
917
931
  * provide the actual upload functionality.
932
+ * ```ts
933
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
934
+ * ```
918
935
  */
919
936
  interface VerdocsFileChooser {
920
937
  /**
@@ -922,19 +939,11 @@ export namespace Components {
922
939
  */
923
940
  "endpoint": VerdocsEndpoint;
924
941
  }
925
- /**
926
- * Floating Action Button style menu. For proper placement, this should be added to the DOM inside a container that is set to
927
- * `overflow-y: scroll;`. The component will detect that placement and position itself in the bottom-right corner on top of the
928
- * container. It will be absolutely positioned so it will be unaffected by scrolling the container.
929
- */
930
- interface VerdocsFloatingMenu {
931
- /**
932
- * The role that this contact will be assigned to.
933
- */
934
- "options": IOption[];
935
- }
936
942
  /**
937
943
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
944
+ * ```ts
945
+ * <verdocs-help-icon text="Sample help text" />
946
+ * ```
938
947
  */
939
948
  interface VerdocsHelpIcon {
940
949
  /**
@@ -957,9 +966,7 @@ export namespace Components {
957
966
  "initials": string;
958
967
  }
959
968
  /**
960
- * Display a text input field. This adds a partially-transparent overlay and screen-centered dialog
961
- * box with a message and optional header/title. An OK button is shown that will dismiss the message.
962
- * It can also be dismissed by clicking the background overlay.
969
+ * Prompt the user to confirm their identity with a series of questions.
963
970
  */
964
971
  interface VerdocsKbaDialog {
965
972
  /**
@@ -997,6 +1004,9 @@ export namespace Components {
997
1004
  }
998
1005
  /**
999
1006
  * Animated loader placeholder. There are currently no configuration options for this control.
1007
+ * ```ts
1008
+ * <verdocs-loader />
1009
+ * ```
1000
1010
  */
1001
1011
  interface VerdocsLoader {
1002
1012
  }
@@ -1024,7 +1034,10 @@ export namespace Components {
1024
1034
  "showCancel": boolean;
1025
1035
  }
1026
1036
  /**
1027
- * Display a small summary card describing an organization
1037
+ * Display a small summary card describing an organization.
1038
+ * ```ts
1039
+ * <verdocs-organization-card organization={organization} />
1040
+ * ```
1028
1041
  */
1029
1042
  interface VerdocsOrganizationCard {
1030
1043
  /**
@@ -1034,6 +1047,14 @@ export namespace Components {
1034
1047
  }
1035
1048
  /**
1036
1049
  * Display a simple pagination control with individual buttons to move through the data set.
1050
+ * ```ts
1051
+ * <verdocs-pagination
1052
+ * selectedPage={1}
1053
+ * itemCount={50}
1054
+ * perPage={10}
1055
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
1056
+ * />
1057
+ * ```
1037
1058
  */
1038
1059
  interface VerdocsPagination {
1039
1060
  /**
@@ -1056,6 +1077,16 @@ export namespace Components {
1056
1077
  * technique. This has been altered in a few ways to make it more friendly
1057
1078
  * to cases where there may be multiple portals on the page and provide more
1058
1079
  * alignment options for the child to be displayed.
1080
+ * ```ts
1081
+ * <div style="padding: 40px">
1082
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
1083
+ * Tooltip Anchor
1084
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
1085
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
1086
+ * </verdocs-portal>
1087
+ * </div>
1088
+ * </div>
1089
+ * ```
1059
1090
  */
1060
1091
  interface VerdocsPortal {
1061
1092
  /**
@@ -1075,6 +1106,9 @@ export namespace Components {
1075
1106
  * Display a template preview experience. This will display the template's attached
1076
1107
  * documents with signing fields overlaid on each page. Fields will be color-coded
1077
1108
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
1109
+ * ```ts
1110
+ * <verdocs-preview templateId={templateId} />
1111
+ * ```
1078
1112
  */
1079
1113
  interface VerdocsPreview {
1080
1114
  /**
@@ -1087,7 +1121,10 @@ export namespace Components {
1087
1121
  "templateId": string | null;
1088
1122
  }
1089
1123
  /**
1090
- * A simple progress bar.
1124
+ * Display a simple progress bar in a style consistent with the design system.
1125
+ * ```ts
1126
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
1127
+ * ```
1091
1128
  */
1092
1129
  interface VerdocsProgressBar {
1093
1130
  /**
@@ -1105,6 +1142,9 @@ export namespace Components {
1105
1142
  }
1106
1143
  /**
1107
1144
  * Display a drop-down menu of quick filter options.
1145
+ * ```ts
1146
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
1147
+ * ```
1108
1148
  */
1109
1149
  interface VerdocsQuickFilter {
1110
1150
  "label": string;
@@ -1132,7 +1172,7 @@ export namespace Components {
1132
1172
  * simple radio button for UI displays e.g. dialog boxes.
1133
1173
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
1134
1174
  * handler. Sample usage:
1135
- * ```html
1175
+ * ```ts
1136
1176
  * <verdocs-radio-button
1137
1177
  * value="val1"
1138
1178
  * name="someProperty"
@@ -1199,7 +1239,11 @@ export namespace Components {
1199
1239
  /**
1200
1240
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
1201
1241
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
1202
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
1242
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
1243
+ * ```ts
1244
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
1245
+ * @input ={() => {}} />
1246
+ * ```
1203
1247
  */
1204
1248
  interface VerdocsSelectInput {
1205
1249
  /**
@@ -1220,12 +1264,18 @@ export namespace Components {
1220
1264
  "value": string;
1221
1265
  }
1222
1266
  /**
1223
- * Display a form to collect recipient information for a new Envelope. If used anonymously, the specified `templateId` must be public.
1224
- * Because most applications have custom workflow requirements to trigger after sending an Envelope, this component does not actually
1225
- * perform that operation. Parent applications should listen for the `onSend` event, and can pass the contents of `event.detail`
1226
- * directly to the `createEnvelope()` call in JS-SDK.
1227
- * Host applications should ensure the template is "sendable" before displaying this component. To be sendable, a template must have
1228
- * at least one document attached, at least one participant defined, and at least one field assigned to every "signer" participant.
1267
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
1268
+ * that because most applications have custom workflow requirements to trigger after sending an
1269
+ * Envelope, this component does not actually perform that operation. Parent applications should
1270
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
1271
+ * `createEnvelope()` call in JS-SDK.
1272
+ * Host applications should ensure the template is "sendable" before displaying this component.
1273
+ * To be sendable, a template must have at least one document attached, at least one participant
1274
+ * defined, and at least one field assigned to every "signer" participant. This component will
1275
+ * hide itself if the template is not sendable.
1276
+ * ```ts
1277
+ * <verdocs-send templateId={templateId} />
1278
+ * ```
1229
1279
  */
1230
1280
  interface VerdocsSend {
1231
1281
  /**
@@ -1246,6 +1296,9 @@ export namespace Components {
1246
1296
  * Display a template preview experience. This will display the template's attached
1247
1297
  * documents with signing fields overlaid on each page. Fields will be color-coded
1248
1298
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
1299
+ * ```ts
1300
+ * <verdocs-settings />
1301
+ * ```
1249
1302
  */
1250
1303
  interface VerdocsSettings {
1251
1304
  /**
@@ -1334,6 +1387,9 @@ export namespace Components {
1334
1387
  }
1335
1388
  /**
1336
1389
  * Display a small loading spinner.
1390
+ * ```ts
1391
+ * <verdocs-spinner />
1392
+ * ```
1337
1393
  */
1338
1394
  interface VerdocsSpinner {
1339
1395
  "mode": 'light' | 'dark';
@@ -1367,6 +1423,9 @@ export namespace Components {
1367
1423
  /**
1368
1424
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
1369
1425
  * support creating interactive table layouts.
1426
+ * ```ts
1427
+ * <verdocs-table columns={[...columns]} data={[...data]} />
1428
+ * ```
1370
1429
  */
1371
1430
  interface VerdocsTable {
1372
1431
  /**
@@ -1381,6 +1440,9 @@ export namespace Components {
1381
1440
  /**
1382
1441
  * Display a simple row of selectable tabs. This is a controlled element.
1383
1442
  * The parent must adjust selectedTab as selection events are fired.
1443
+ * ```ts
1444
+ * <verdocs-tabs tabs={[...tabs]} />
1445
+ * ```
1384
1446
  */
1385
1447
  interface VerdocsTabs {
1386
1448
  /**
@@ -1684,7 +1746,10 @@ export namespace Components {
1684
1746
  /**
1685
1747
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
1686
1748
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
1687
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
1749
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
1750
+ * ```ts
1751
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
1752
+ * ```
1688
1753
  */
1689
1754
  interface VerdocsTextInput {
1690
1755
  /**
@@ -1729,7 +1794,10 @@ export namespace Components {
1729
1794
  "value": string;
1730
1795
  }
1731
1796
  /**
1732
- * Displays a label and a set of buttons, also allowing a default selection of a button
1797
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
1798
+ * ```ts
1799
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
1800
+ * ```
1733
1801
  */
1734
1802
  interface VerdocsToggle {
1735
1803
  /**
@@ -1743,6 +1811,9 @@ export namespace Components {
1743
1811
  }
1744
1812
  /**
1745
1813
  * Displays a single button that can be toggled on or off by clicking it.
1814
+ * ```ts
1815
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
1816
+ * ```
1746
1817
  */
1747
1818
  interface VerdocsToggleButton {
1748
1819
  "active": boolean;
@@ -1761,6 +1832,9 @@ export namespace Components {
1761
1832
  }
1762
1833
  /**
1763
1834
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
1835
+ * ```ts
1836
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
1837
+ * ```
1764
1838
  */
1765
1839
  interface VerdocsToolbarIcon {
1766
1840
  /**
@@ -1893,10 +1967,6 @@ export interface VerdocsFileChooserCustomEvent<T> extends CustomEvent<T> {
1893
1967
  detail: T;
1894
1968
  target: HTMLVerdocsFileChooserElement;
1895
1969
  }
1896
- export interface VerdocsFloatingMenuCustomEvent<T> extends CustomEvent<T> {
1897
- detail: T;
1898
- target: HTMLVerdocsFloatingMenuElement;
1899
- }
1900
1970
  export interface VerdocsInitialDialogCustomEvent<T> extends CustomEvent<T> {
1901
1971
  detail: T;
1902
1972
  target: HTMLVerdocsInitialDialogElement;
@@ -2071,26 +2141,15 @@ declare global {
2071
2141
  "sdkError": SDKError;
2072
2142
  }
2073
2143
  /**
2074
- * Display an authentication dialog that allows the user to login or sign up. Callbacks are provided for events that
2075
- * occur during the process (especially successful completion). If the user is already authenticated with a valid
2076
- * session, this component will hide itself and fire the success callback immediately. It is up to the host application
2077
- * to render the next appropriate view for the application.
2078
- * To simplify some types of authentication flows, a visibility flag can force this component to never display. This
2079
- * allows you to susbcribe to notifications from the
2144
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
2145
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
2146
+ * host application to render the next appropriate view for the application.
2147
+ * To simplify UI development, a visibility flag can force this component to never display. This
2148
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
2080
2149
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
2081
2150
  * container to allow sufficient space for the required forms.
2082
- * As noted below, the primary event is `authenticated`. This will always be fired at least once, immediately after
2083
- * the widget is rendered and the user's status has been checked. It may be fired again as the user completes (or
2084
- * cancels) authentication steps.
2085
- * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
2086
- * embed. This Element will reuse the same session produced by logging in via that Embed.
2087
- * ```typescript
2088
- * interface IAuthStatus {
2089
- * // If true, the user is authenticated with a valid session
2090
- * authenticated: boolean;
2091
- * // Details for the user's session
2092
- * session: IActiveSession | null;
2093
- * }
2151
+ * ```ts
2152
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
2094
2153
  * ```
2095
2154
  */
2096
2155
  interface HTMLVerdocsAuthElement extends Components.VerdocsAuth, HTMLStencilElement {
@@ -2117,6 +2176,9 @@ declare global {
2117
2176
  }
2118
2177
  /**
2119
2178
  * Display a template building experience.
2179
+ * ```ts
2180
+ * <verdocs-build templateId={templateId} />
2181
+ * ```
2120
2182
  */
2121
2183
  interface HTMLVerdocsBuildElement extends Components.VerdocsBuild, HTMLStencilElement {
2122
2184
  addEventListener<K extends keyof HTMLVerdocsBuildElementEventMap>(type: K, listener: (this: HTMLVerdocsBuildElement, ev: VerdocsBuildCustomEvent<HTMLVerdocsBuildElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2133,9 +2195,9 @@ declare global {
2133
2195
  new (): HTMLVerdocsBuildElement;
2134
2196
  };
2135
2197
  /**
2136
- * A simple button
2137
- * ```jsx
2138
- * <verdocs-button label="Click Me" />
2198
+ * A simple button, with consistent styling to other controls in the design system.
2199
+ * ```ts
2200
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
2139
2201
  * ```
2140
2202
  */
2141
2203
  interface HTMLVerdocsButtonElement extends Components.VerdocsButton, HTMLStencilElement {
@@ -2147,6 +2209,17 @@ declare global {
2147
2209
  /**
2148
2210
  * Display an icon button that triggers a drop-down panel that can display
2149
2211
  * arbitrary child content, such as metadata, forms, or other controls.
2212
+ * ```ts
2213
+ * <verdocs-button-panel .icon=${icon}>
2214
+ * <h6>Field Settings</h6>
2215
+ * <form>
2216
+ * <p>
2217
+ * <label>Field Name</label>
2218
+ * <input type="text" placeholder="Field Name..." />
2219
+ * </p>
2220
+ * </form>
2221
+ * </verdocs-button-panel>
2222
+ * ```
2150
2223
  */
2151
2224
  interface HTMLVerdocsButtonPanelElement extends Components.VerdocsButtonPanel, HTMLStencilElement {
2152
2225
  }
@@ -2160,7 +2233,7 @@ declare global {
2160
2233
  * box for UI displays e.g. dialog boxes.
2161
2234
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
2162
2235
  * handler. Sample usage:
2163
- * ```html
2236
+ * ```ts
2164
2237
  * <verdocs-checkbox
2165
2238
  * value="on"
2166
2239
  * name="thingEnabled"
@@ -2237,7 +2310,7 @@ declare global {
2237
2310
  /**
2238
2311
  * Display a drop-down menu button. A menu of the specified options will be displayed when the button is pressed. The menu will be hidden
2239
2312
  * when the button is pressed again, or an option is selected. Separators may be created by supplying an entry with an empty label.
2240
- * ```html
2313
+ * ```ts
2241
2314
  * <verdocs-dropdown
2242
2315
  * options={[
2243
2316
  * {label: 'Option 1', disabled: true},
@@ -2383,7 +2456,7 @@ declare global {
2383
2456
  interface HTMLVerdocsFieldAttachmentElementEventMap {
2384
2457
  "settingsChanged": {fieldName: string; settings: ITemplateFieldSetting; field: ITemplateField};
2385
2458
  "deleted": {fieldName: string};
2386
- "attached": {data: string; lastModified: number; name: string; size: number; type: string};
2459
+ "attached": ISelectedFile;
2387
2460
  }
2388
2461
  /**
2389
2462
  * Displays an attachment field.
@@ -2451,8 +2524,7 @@ declare global {
2451
2524
  "deleted": {fieldName: string};
2452
2525
  }
2453
2526
  /**
2454
- * Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as
2455
- * input types like text and checkbox.
2527
+ * Displays a dropdown field that allows the user to choose one of a list of options.
2456
2528
  */
2457
2529
  interface HTMLVerdocsFieldDropdownElement extends Components.VerdocsFieldDropdown, HTMLStencilElement {
2458
2530
  addEventListener<K extends keyof HTMLVerdocsFieldDropdownElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldDropdownElement, ev: VerdocsFieldDropdownCustomEvent<HTMLVerdocsFieldDropdownElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2477,8 +2549,12 @@ declare global {
2477
2549
  "deleted": {fieldName: string};
2478
2550
  }
2479
2551
  /**
2480
- * Displays an initial field. If an initial already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
2481
- * button will be shown. Clicking the button will show a dialog to adopt an initial.
2552
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
2553
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
2554
+ * show a dialog to adopt an initial.
2555
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
2556
+ * This requires operation against a live, valid envelope. If you are testing this component
2557
+ * in Storybook, it will not be visible here.
2482
2558
  */
2483
2559
  interface HTMLVerdocsFieldInitialElement extends Components.VerdocsFieldInitial, HTMLStencilElement {
2484
2560
  addEventListener<K extends keyof HTMLVerdocsFieldInitialElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldInitialElement, ev: VerdocsFieldInitialCustomEvent<HTMLVerdocsFieldInitialElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2546,8 +2622,12 @@ declare global {
2546
2622
  "deleted": {fieldName: string};
2547
2623
  }
2548
2624
  /**
2549
- * Displays a signature field. If a signature already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
2550
- * button will be shown. Clicking the button will show a dialog to adopt a signature.
2625
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
2626
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
2627
+ * show a dialog to adopt a signature.
2628
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
2629
+ * This requires operation against a live, valid envelope. If you are testing this component
2630
+ * in Storybook, it will not be visible here.
2551
2631
  */
2552
2632
  interface HTMLVerdocsFieldSignatureElement extends Components.VerdocsFieldSignature, HTMLStencilElement {
2553
2633
  addEventListener<K extends keyof HTMLVerdocsFieldSignatureElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldSignatureElement, ev: VerdocsFieldSignatureCustomEvent<HTMLVerdocsFieldSignatureElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2568,7 +2648,8 @@ declare global {
2568
2648
  "deleted": {fieldName: string};
2569
2649
  }
2570
2650
  /**
2571
- * Display a multi-line text input field.
2651
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
2652
+ * as the BOTTOM-LEFT corner.
2572
2653
  */
2573
2654
  interface HTMLVerdocsFieldTextareaElement extends Components.VerdocsFieldTextarea, HTMLStencilElement {
2574
2655
  addEventListener<K extends keyof HTMLVerdocsFieldTextareaElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldTextareaElement, ev: VerdocsFieldTextareaCustomEvent<HTMLVerdocsFieldTextareaElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2589,7 +2670,7 @@ declare global {
2589
2670
  "deleted": {fieldName: string};
2590
2671
  }
2591
2672
  /**
2592
- * Display a text input field.
2673
+ * Display a simple 1-line text input field.
2593
2674
  */
2594
2675
  interface HTMLVerdocsFieldTextboxElement extends Components.VerdocsFieldTextbox, HTMLStencilElement {
2595
2676
  addEventListener<K extends keyof HTMLVerdocsFieldTextboxElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldTextboxElement, ev: VerdocsFieldTextboxCustomEvent<HTMLVerdocsFieldTextboxElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2610,7 +2691,8 @@ declare global {
2610
2691
  "deleted": {fieldName: string};
2611
2692
  }
2612
2693
  /**
2613
- * Display a timestamp field.
2694
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
2695
+ * filled when the signer submits the document.
2614
2696
  */
2615
2697
  interface HTMLVerdocsFieldTimestampElement extends Components.VerdocsFieldTimestamp, HTMLStencilElement {
2616
2698
  addEventListener<K extends keyof HTMLVerdocsFieldTimestampElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldTimestampElement, ev: VerdocsFieldTimestampCustomEvent<HTMLVerdocsFieldTimestampElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2632,6 +2714,9 @@ declare global {
2632
2714
  /**
2633
2715
  * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
2634
2716
  * provide the actual upload functionality.
2717
+ * ```ts
2718
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
2719
+ * ```
2635
2720
  */
2636
2721
  interface HTMLVerdocsFileChooserElement extends Components.VerdocsFileChooser, HTMLStencilElement {
2637
2722
  addEventListener<K extends keyof HTMLVerdocsFileChooserElementEventMap>(type: K, listener: (this: HTMLVerdocsFileChooserElement, ev: VerdocsFileChooserCustomEvent<HTMLVerdocsFileChooserElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2647,30 +2732,11 @@ declare global {
2647
2732
  prototype: HTMLVerdocsFileChooserElement;
2648
2733
  new (): HTMLVerdocsFileChooserElement;
2649
2734
  };
2650
- interface HTMLVerdocsFloatingMenuElementEventMap {
2651
- "optionSelected": IOption;
2652
- }
2653
- /**
2654
- * Floating Action Button style menu. For proper placement, this should be added to the DOM inside a container that is set to
2655
- * `overflow-y: scroll;`. The component will detect that placement and position itself in the bottom-right corner on top of the
2656
- * container. It will be absolutely positioned so it will be unaffected by scrolling the container.
2657
- */
2658
- interface HTMLVerdocsFloatingMenuElement extends Components.VerdocsFloatingMenu, HTMLStencilElement {
2659
- addEventListener<K extends keyof HTMLVerdocsFloatingMenuElementEventMap>(type: K, listener: (this: HTMLVerdocsFloatingMenuElement, ev: VerdocsFloatingMenuCustomEvent<HTMLVerdocsFloatingMenuElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
2660
- addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
2661
- addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
2662
- addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
2663
- removeEventListener<K extends keyof HTMLVerdocsFloatingMenuElementEventMap>(type: K, listener: (this: HTMLVerdocsFloatingMenuElement, ev: VerdocsFloatingMenuCustomEvent<HTMLVerdocsFloatingMenuElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
2664
- removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
2665
- removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
2666
- removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
2667
- }
2668
- var HTMLVerdocsFloatingMenuElement: {
2669
- prototype: HTMLVerdocsFloatingMenuElement;
2670
- new (): HTMLVerdocsFloatingMenuElement;
2671
- };
2672
2735
  /**
2673
2736
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
2737
+ * ```ts
2738
+ * <verdocs-help-icon text="Sample help text" />
2739
+ * ```
2674
2740
  */
2675
2741
  interface HTMLVerdocsHelpIconElement extends Components.VerdocsHelpIcon, HTMLStencilElement {
2676
2742
  }
@@ -2705,9 +2771,7 @@ declare global {
2705
2771
  "next": string;
2706
2772
  }
2707
2773
  /**
2708
- * Display a text input field. This adds a partially-transparent overlay and screen-centered dialog
2709
- * box with a message and optional header/title. An OK button is shown that will dismiss the message.
2710
- * It can also be dismissed by clicking the background overlay.
2774
+ * Prompt the user to confirm their identity with a series of questions.
2711
2775
  */
2712
2776
  interface HTMLVerdocsKbaDialogElement extends Components.VerdocsKbaDialog, HTMLStencilElement {
2713
2777
  addEventListener<K extends keyof HTMLVerdocsKbaDialogElementEventMap>(type: K, listener: (this: HTMLVerdocsKbaDialogElement, ev: VerdocsKbaDialogCustomEvent<HTMLVerdocsKbaDialogElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2725,6 +2789,9 @@ declare global {
2725
2789
  };
2726
2790
  /**
2727
2791
  * Animated loader placeholder. There are currently no configuration options for this control.
2792
+ * ```ts
2793
+ * <verdocs-loader />
2794
+ * ```
2728
2795
  */
2729
2796
  interface HTMLVerdocsLoaderElement extends Components.VerdocsLoader, HTMLStencilElement {
2730
2797
  }
@@ -2756,7 +2823,10 @@ declare global {
2756
2823
  new (): HTMLVerdocsOkDialogElement;
2757
2824
  };
2758
2825
  /**
2759
- * Display a small summary card describing an organization
2826
+ * Display a small summary card describing an organization.
2827
+ * ```ts
2828
+ * <verdocs-organization-card organization={organization} />
2829
+ * ```
2760
2830
  */
2761
2831
  interface HTMLVerdocsOrganizationCardElement extends Components.VerdocsOrganizationCard, HTMLStencilElement {
2762
2832
  }
@@ -2769,6 +2839,14 @@ declare global {
2769
2839
  }
2770
2840
  /**
2771
2841
  * Display a simple pagination control with individual buttons to move through the data set.
2842
+ * ```ts
2843
+ * <verdocs-pagination
2844
+ * selectedPage={1}
2845
+ * itemCount={50}
2846
+ * perPage={10}
2847
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
2848
+ * />
2849
+ * ```
2772
2850
  */
2773
2851
  interface HTMLVerdocsPaginationElement extends Components.VerdocsPagination, HTMLStencilElement {
2774
2852
  addEventListener<K extends keyof HTMLVerdocsPaginationElementEventMap>(type: K, listener: (this: HTMLVerdocsPaginationElement, ev: VerdocsPaginationCustomEvent<HTMLVerdocsPaginationElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2794,6 +2872,16 @@ declare global {
2794
2872
  * technique. This has been altered in a few ways to make it more friendly
2795
2873
  * to cases where there may be multiple portals on the page and provide more
2796
2874
  * alignment options for the child to be displayed.
2875
+ * ```ts
2876
+ * <div style="padding: 40px">
2877
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
2878
+ * Tooltip Anchor
2879
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
2880
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
2881
+ * </verdocs-portal>
2882
+ * </div>
2883
+ * </div>
2884
+ * ```
2797
2885
  */
2798
2886
  interface HTMLVerdocsPortalElement extends Components.VerdocsPortal, HTMLStencilElement {
2799
2887
  addEventListener<K extends keyof HTMLVerdocsPortalElementEventMap>(type: K, listener: (this: HTMLVerdocsPortalElement, ev: VerdocsPortalCustomEvent<HTMLVerdocsPortalElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2816,6 +2904,9 @@ declare global {
2816
2904
  * Display a template preview experience. This will display the template's attached
2817
2905
  * documents with signing fields overlaid on each page. Fields will be color-coded
2818
2906
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
2907
+ * ```ts
2908
+ * <verdocs-preview templateId={templateId} />
2909
+ * ```
2819
2910
  */
2820
2911
  interface HTMLVerdocsPreviewElement extends Components.VerdocsPreview, HTMLStencilElement {
2821
2912
  addEventListener<K extends keyof HTMLVerdocsPreviewElementEventMap>(type: K, listener: (this: HTMLVerdocsPreviewElement, ev: VerdocsPreviewCustomEvent<HTMLVerdocsPreviewElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2832,7 +2923,10 @@ declare global {
2832
2923
  new (): HTMLVerdocsPreviewElement;
2833
2924
  };
2834
2925
  /**
2835
- * A simple progress bar.
2926
+ * Display a simple progress bar in a style consistent with the design system.
2927
+ * ```ts
2928
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
2929
+ * ```
2836
2930
  */
2837
2931
  interface HTMLVerdocsProgressBarElement extends Components.VerdocsProgressBar, HTMLStencilElement {
2838
2932
  }
@@ -2845,6 +2939,9 @@ declare global {
2845
2939
  }
2846
2940
  /**
2847
2941
  * Display a drop-down menu of quick filter options.
2942
+ * ```ts
2943
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
2944
+ * ```
2848
2945
  */
2849
2946
  interface HTMLVerdocsQuickFilterElement extends Components.VerdocsQuickFilter, HTMLStencilElement {
2850
2947
  addEventListener<K extends keyof HTMLVerdocsQuickFilterElementEventMap>(type: K, listener: (this: HTMLVerdocsQuickFilterElement, ev: VerdocsQuickFilterCustomEvent<HTMLVerdocsQuickFilterElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2889,7 +2986,7 @@ declare global {
2889
2986
  * simple radio button for UI displays e.g. dialog boxes.
2890
2987
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
2891
2988
  * handler. Sample usage:
2892
- * ```html
2989
+ * ```ts
2893
2990
  * <verdocs-radio-button
2894
2991
  * value="val1"
2895
2992
  * name="someProperty"
@@ -2944,7 +3041,11 @@ declare global {
2944
3041
  /**
2945
3042
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
2946
3043
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
2947
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
3044
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
3045
+ * ```ts
3046
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
3047
+ * @input ={() => {}} />
3048
+ * ```
2948
3049
  */
2949
3050
  interface HTMLVerdocsSelectInputElement extends Components.VerdocsSelectInput, HTMLStencilElement {
2950
3051
  }
@@ -2960,12 +3061,18 @@ declare global {
2960
3061
  "searchContacts": IContactSearchEvent1;
2961
3062
  }
2962
3063
  /**
2963
- * Display a form to collect recipient information for a new Envelope. If used anonymously, the specified `templateId` must be public.
2964
- * Because most applications have custom workflow requirements to trigger after sending an Envelope, this component does not actually
2965
- * perform that operation. Parent applications should listen for the `onSend` event, and can pass the contents of `event.detail`
2966
- * directly to the `createEnvelope()` call in JS-SDK.
2967
- * Host applications should ensure the template is "sendable" before displaying this component. To be sendable, a template must have
2968
- * at least one document attached, at least one participant defined, and at least one field assigned to every "signer" participant.
3064
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
3065
+ * that because most applications have custom workflow requirements to trigger after sending an
3066
+ * Envelope, this component does not actually perform that operation. Parent applications should
3067
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
3068
+ * `createEnvelope()` call in JS-SDK.
3069
+ * Host applications should ensure the template is "sendable" before displaying this component.
3070
+ * To be sendable, a template must have at least one document attached, at least one participant
3071
+ * defined, and at least one field assigned to every "signer" participant. This component will
3072
+ * hide itself if the template is not sendable.
3073
+ * ```ts
3074
+ * <verdocs-send templateId={templateId} />
3075
+ * ```
2969
3076
  */
2970
3077
  interface HTMLVerdocsSendElement extends Components.VerdocsSend, HTMLStencilElement {
2971
3078
  addEventListener<K extends keyof HTMLVerdocsSendElementEventMap>(type: K, listener: (this: HTMLVerdocsSendElement, ev: VerdocsSendCustomEvent<HTMLVerdocsSendElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2988,6 +3095,9 @@ declare global {
2988
3095
  * Display a template preview experience. This will display the template's attached
2989
3096
  * documents with signing fields overlaid on each page. Fields will be color-coded
2990
3097
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
3098
+ * ```ts
3099
+ * <verdocs-settings />
3100
+ * ```
2991
3101
  */
2992
3102
  interface HTMLVerdocsSettingsElement extends Components.VerdocsSettings, HTMLStencilElement {
2993
3103
  addEventListener<K extends keyof HTMLVerdocsSettingsElementEventMap>(type: K, listener: (this: HTMLVerdocsSettingsElement, ev: VerdocsSettingsCustomEvent<HTMLVerdocsSettingsElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3149,6 +3259,9 @@ declare global {
3149
3259
  };
3150
3260
  /**
3151
3261
  * Display a small loading spinner.
3262
+ * ```ts
3263
+ * <verdocs-spinner />
3264
+ * ```
3152
3265
  */
3153
3266
  interface HTMLVerdocsSpinnerElement extends Components.VerdocsSpinner, HTMLStencilElement {
3154
3267
  }
@@ -3176,6 +3289,9 @@ declare global {
3176
3289
  /**
3177
3290
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
3178
3291
  * support creating interactive table layouts.
3292
+ * ```ts
3293
+ * <verdocs-table columns={[...columns]} data={[...data]} />
3294
+ * ```
3179
3295
  */
3180
3296
  interface HTMLVerdocsTableElement extends Components.VerdocsTable, HTMLStencilElement {
3181
3297
  addEventListener<K extends keyof HTMLVerdocsTableElementEventMap>(type: K, listener: (this: HTMLVerdocsTableElement, ev: VerdocsTableCustomEvent<HTMLVerdocsTableElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3197,6 +3313,9 @@ declare global {
3197
3313
  /**
3198
3314
  * Display a simple row of selectable tabs. This is a controlled element.
3199
3315
  * The parent must adjust selectedTab as selection events are fired.
3316
+ * ```ts
3317
+ * <verdocs-tabs tabs={[...tabs]} />
3318
+ * ```
3200
3319
  */
3201
3320
  interface HTMLVerdocsTabsElement extends Components.VerdocsTabs, HTMLStencilElement {
3202
3321
  addEventListener<K extends keyof HTMLVerdocsTabsElementEventMap>(type: K, listener: (this: HTMLVerdocsTabsElement, ev: VerdocsTabsCustomEvent<HTMLVerdocsTabsElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3552,7 +3671,10 @@ declare global {
3552
3671
  /**
3553
3672
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
3554
3673
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
3555
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
3674
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
3675
+ * ```ts
3676
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
3677
+ * ```
3556
3678
  */
3557
3679
  interface HTMLVerdocsTextInputElement extends Components.VerdocsTextInput, HTMLStencilElement {
3558
3680
  }
@@ -3561,7 +3683,10 @@ declare global {
3561
3683
  new (): HTMLVerdocsTextInputElement;
3562
3684
  };
3563
3685
  /**
3564
- * Displays a label and a set of buttons, also allowing a default selection of a button
3686
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
3687
+ * ```ts
3688
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
3689
+ * ```
3565
3690
  */
3566
3691
  interface HTMLVerdocsToggleElement extends Components.VerdocsToggle, HTMLStencilElement {
3567
3692
  }
@@ -3574,6 +3699,9 @@ declare global {
3574
3699
  }
3575
3700
  /**
3576
3701
  * Displays a single button that can be toggled on or off by clicking it.
3702
+ * ```ts
3703
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
3704
+ * ```
3577
3705
  */
3578
3706
  interface HTMLVerdocsToggleButtonElement extends Components.VerdocsToggleButton, HTMLStencilElement {
3579
3707
  addEventListener<K extends keyof HTMLVerdocsToggleButtonElementEventMap>(type: K, listener: (this: HTMLVerdocsToggleButtonElement, ev: VerdocsToggleButtonCustomEvent<HTMLVerdocsToggleButtonElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3591,6 +3719,9 @@ declare global {
3591
3719
  };
3592
3720
  /**
3593
3721
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
3722
+ * ```ts
3723
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
3724
+ * ```
3594
3725
  */
3595
3726
  interface HTMLVerdocsToolbarIconElement extends Components.VerdocsToolbarIcon, HTMLStencilElement {
3596
3727
  }
@@ -3673,7 +3804,6 @@ declare global {
3673
3804
  "verdocs-field-textbox": HTMLVerdocsFieldTextboxElement;
3674
3805
  "verdocs-field-timestamp": HTMLVerdocsFieldTimestampElement;
3675
3806
  "verdocs-file-chooser": HTMLVerdocsFileChooserElement;
3676
- "verdocs-floating-menu": HTMLVerdocsFloatingMenuElement;
3677
3807
  "verdocs-help-icon": HTMLVerdocsHelpIconElement;
3678
3808
  "verdocs-initial-dialog": HTMLVerdocsInitialDialogElement;
3679
3809
  "verdocs-kba-dialog": HTMLVerdocsKbaDialogElement;
@@ -3764,26 +3894,15 @@ declare namespace LocalJSX {
3764
3894
  "view"?: 'completed' | 'action' | 'waiting';
3765
3895
  }
3766
3896
  /**
3767
- * Display an authentication dialog that allows the user to login or sign up. Callbacks are provided for events that
3768
- * occur during the process (especially successful completion). If the user is already authenticated with a valid
3769
- * session, this component will hide itself and fire the success callback immediately. It is up to the host application
3770
- * to render the next appropriate view for the application.
3771
- * To simplify some types of authentication flows, a visibility flag can force this component to never display. This
3772
- * allows you to susbcribe to notifications from the
3897
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
3898
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
3899
+ * host application to render the next appropriate view for the application.
3900
+ * To simplify UI development, a visibility flag can force this component to never display. This
3901
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
3773
3902
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
3774
3903
  * container to allow sufficient space for the required forms.
3775
- * As noted below, the primary event is `authenticated`. This will always be fired at least once, immediately after
3776
- * the widget is rendered and the user's status has been checked. It may be fired again as the user completes (or
3777
- * cancels) authentication steps.
3778
- * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
3779
- * embed. This Element will reuse the same session produced by logging in via that Embed.
3780
- * ```typescript
3781
- * interface IAuthStatus {
3782
- * // If true, the user is authenticated with a valid session
3783
- * authenticated: boolean;
3784
- * // Details for the user's session
3785
- * session: IActiveSession | null;
3786
- * }
3904
+ * ```ts
3905
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
3787
3906
  * ```
3788
3907
  */
3789
3908
  interface VerdocsAuth {
@@ -3796,7 +3915,7 @@ declare namespace LocalJSX {
3796
3915
  */
3797
3916
  "logo"?: string;
3798
3917
  /**
3799
- * Event fired when session authentication process has completed. Check the event contents for completion status.
3918
+ * Event fired when session authentication process has completed. Check the event contents for completion status. This event will always be called at least once, when the component is first rendered.
3800
3919
  */
3801
3920
  "onAuthenticated"?: (event: VerdocsAuthCustomEvent<IAuthStatus>) => void;
3802
3921
  /**
@@ -3810,6 +3929,9 @@ declare namespace LocalJSX {
3810
3929
  }
3811
3930
  /**
3812
3931
  * Display a template building experience.
3932
+ * ```ts
3933
+ * <verdocs-build templateId={templateId} />
3934
+ * ```
3813
3935
  */
3814
3936
  interface VerdocsBuild {
3815
3937
  /**
@@ -3850,9 +3972,9 @@ declare namespace LocalJSX {
3850
3972
  "templateId"?: string | null;
3851
3973
  }
3852
3974
  /**
3853
- * A simple button
3854
- * ```jsx
3855
- * <verdocs-button label="Click Me" />
3975
+ * A simple button, with consistent styling to other controls in the design system.
3976
+ * ```ts
3977
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
3856
3978
  * ```
3857
3979
  */
3858
3980
  interface VerdocsButton {
@@ -3888,6 +4010,17 @@ declare namespace LocalJSX {
3888
4010
  /**
3889
4011
  * Display an icon button that triggers a drop-down panel that can display
3890
4012
  * arbitrary child content, such as metadata, forms, or other controls.
4013
+ * ```ts
4014
+ * <verdocs-button-panel .icon=${icon}>
4015
+ * <h6>Field Settings</h6>
4016
+ * <form>
4017
+ * <p>
4018
+ * <label>Field Name</label>
4019
+ * <input type="text" placeholder="Field Name..." />
4020
+ * </p>
4021
+ * </form>
4022
+ * </verdocs-button-panel>
4023
+ * ```
3891
4024
  */
3892
4025
  interface VerdocsButtonPanel {
3893
4026
  /**
@@ -3901,7 +4034,7 @@ declare namespace LocalJSX {
3901
4034
  * box for UI displays e.g. dialog boxes.
3902
4035
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
3903
4036
  * handler. Sample usage:
3904
- * ```html
4037
+ * ```ts
3905
4038
  * <verdocs-checkbox
3906
4039
  * value="on"
3907
4040
  * name="thingEnabled"
@@ -3991,7 +4124,7 @@ declare namespace LocalJSX {
3991
4124
  /**
3992
4125
  * Display a drop-down menu button. A menu of the specified options will be displayed when the button is pressed. The menu will be hidden
3993
4126
  * when the button is pressed again, or an option is selected. Separators may be created by supplying an entry with an empty label.
3994
- * ```html
4127
+ * ```ts
3995
4128
  * <verdocs-dropdown
3996
4129
  * options={[
3997
4130
  * {label: 'Option 1', disabled: true},
@@ -4231,6 +4364,10 @@ declare namespace LocalJSX {
4231
4364
  * If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be changed, so it should typically only be enabled in the Builder.
4232
4365
  */
4233
4366
  "editable"?: boolean;
4367
+ /**
4368
+ * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used. This component self-manages its resize (width) behavior when in edit-template mode, and uses this endpoint to save changes.
4369
+ */
4370
+ "endpoint"?: VerdocsEndpoint;
4234
4371
  /**
4235
4372
  * The name of the field to display.
4236
4373
  */
@@ -4242,7 +4379,7 @@ declare namespace LocalJSX {
4242
4379
  /**
4243
4380
  * Event fired when the field is deleted.
4244
4381
  */
4245
- "onAttached"?: (event: VerdocsFieldAttachmentCustomEvent<{data: string; lastModified: number; name: string; size: number; type: string}>) => void;
4382
+ "onAttached"?: (event: VerdocsFieldAttachmentCustomEvent<ISelectedFile>) => void;
4246
4383
  /**
4247
4384
  * Event fired when the field is deleted.
4248
4385
  */
@@ -4379,8 +4516,7 @@ declare namespace LocalJSX {
4379
4516
  "yscale"?: number;
4380
4517
  }
4381
4518
  /**
4382
- * Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as
4383
- * input types like text and checkbox.
4519
+ * Displays a dropdown field that allows the user to choose one of a list of options.
4384
4520
  */
4385
4521
  interface VerdocsFieldDropdown {
4386
4522
  /**
@@ -4433,8 +4569,12 @@ declare namespace LocalJSX {
4433
4569
  "yscale"?: number;
4434
4570
  }
4435
4571
  /**
4436
- * Displays an initial field. If an initial already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
4437
- * button will be shown. Clicking the button will show a dialog to adopt an initial.
4572
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
4573
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
4574
+ * show a dialog to adopt an initial.
4575
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
4576
+ * This requires operation against a live, valid envelope. If you are testing this component
4577
+ * in Storybook, it will not be visible here.
4438
4578
  */
4439
4579
  interface VerdocsFieldInitial {
4440
4580
  /**
@@ -4610,8 +4750,12 @@ declare namespace LocalJSX {
4610
4750
  "yscale"?: number;
4611
4751
  }
4612
4752
  /**
4613
- * Displays a signature field. If a signature already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
4614
- * button will be shown. Clicking the button will show a dialog to adopt a signature.
4753
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
4754
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
4755
+ * show a dialog to adopt a signature.
4756
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
4757
+ * This requires operation against a live, valid envelope. If you are testing this component
4758
+ * in Storybook, it will not be visible here.
4615
4759
  */
4616
4760
  interface VerdocsFieldSignature {
4617
4761
  /**
@@ -4672,7 +4816,8 @@ declare namespace LocalJSX {
4672
4816
  "yscale"?: number;
4673
4817
  }
4674
4818
  /**
4675
- * Display a multi-line text input field.
4819
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
4820
+ * as the BOTTOM-LEFT corner.
4676
4821
  */
4677
4822
  interface VerdocsFieldTextarea {
4678
4823
  /**
@@ -4725,7 +4870,7 @@ declare namespace LocalJSX {
4725
4870
  "yscale"?: number;
4726
4871
  }
4727
4872
  /**
4728
- * Display a text input field.
4873
+ * Display a simple 1-line text input field.
4729
4874
  */
4730
4875
  interface VerdocsFieldTextbox {
4731
4876
  /**
@@ -4778,7 +4923,8 @@ declare namespace LocalJSX {
4778
4923
  "yscale"?: number;
4779
4924
  }
4780
4925
  /**
4781
- * Display a timestamp field.
4926
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
4927
+ * filled when the signer submits the document.
4782
4928
  */
4783
4929
  interface VerdocsFieldTimestamp {
4784
4930
  /**
@@ -4829,6 +4975,9 @@ declare namespace LocalJSX {
4829
4975
  /**
4830
4976
  * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
4831
4977
  * provide the actual upload functionality.
4978
+ * ```ts
4979
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
4980
+ * ```
4832
4981
  */
4833
4982
  interface VerdocsFileChooser {
4834
4983
  /**
@@ -4840,23 +4989,11 @@ declare namespace LocalJSX {
4840
4989
  */
4841
4990
  "onFileSelected"?: (event: VerdocsFileChooserCustomEvent<{file: File | null}>) => void;
4842
4991
  }
4843
- /**
4844
- * Floating Action Button style menu. For proper placement, this should be added to the DOM inside a container that is set to
4845
- * `overflow-y: scroll;`. The component will detect that placement and position itself in the bottom-right corner on top of the
4846
- * container. It will be absolutely positioned so it will be unaffected by scrolling the container.
4847
- */
4848
- interface VerdocsFloatingMenu {
4849
- /**
4850
- * Event fired when a menu option is clicked. Web Component events need to be "composed" to cross the Shadow DOM and be received by parent frameworks.
4851
- */
4852
- "onOptionSelected"?: (event: VerdocsFloatingMenuCustomEvent<IOption>) => void;
4853
- /**
4854
- * The role that this contact will be assigned to.
4855
- */
4856
- "options"?: IOption[];
4857
- }
4858
4992
  /**
4859
4993
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
4994
+ * ```ts
4995
+ * <verdocs-help-icon text="Sample help text" />
4996
+ * ```
4860
4997
  */
4861
4998
  interface VerdocsHelpIcon {
4862
4999
  /**
@@ -4887,9 +5024,7 @@ declare namespace LocalJSX {
4887
5024
  "onNext"?: (event: VerdocsInitialDialogCustomEvent<string>) => void;
4888
5025
  }
4889
5026
  /**
4890
- * Display a text input field. This adds a partially-transparent overlay and screen-centered dialog
4891
- * box with a message and optional header/title. An OK button is shown that will dismiss the message.
4892
- * It can also be dismissed by clicking the background overlay.
5027
+ * Prompt the user to confirm their identity with a series of questions.
4893
5028
  */
4894
5029
  interface VerdocsKbaDialog {
4895
5030
  /**
@@ -4935,6 +5070,9 @@ declare namespace LocalJSX {
4935
5070
  }
4936
5071
  /**
4937
5072
  * Animated loader placeholder. There are currently no configuration options for this control.
5073
+ * ```ts
5074
+ * <verdocs-loader />
5075
+ * ```
4938
5076
  */
4939
5077
  interface VerdocsLoader {
4940
5078
  }
@@ -4970,7 +5108,10 @@ declare namespace LocalJSX {
4970
5108
  "showCancel"?: boolean;
4971
5109
  }
4972
5110
  /**
4973
- * Display a small summary card describing an organization
5111
+ * Display a small summary card describing an organization.
5112
+ * ```ts
5113
+ * <verdocs-organization-card organization={organization} />
5114
+ * ```
4974
5115
  */
4975
5116
  interface VerdocsOrganizationCard {
4976
5117
  /**
@@ -4980,6 +5121,14 @@ declare namespace LocalJSX {
4980
5121
  }
4981
5122
  /**
4982
5123
  * Display a simple pagination control with individual buttons to move through the data set.
5124
+ * ```ts
5125
+ * <verdocs-pagination
5126
+ * selectedPage={1}
5127
+ * itemCount={50}
5128
+ * perPage={10}
5129
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
5130
+ * />
5131
+ * ```
4983
5132
  */
4984
5133
  interface VerdocsPagination {
4985
5134
  /**
@@ -5006,6 +5155,16 @@ declare namespace LocalJSX {
5006
5155
  * technique. This has been altered in a few ways to make it more friendly
5007
5156
  * to cases where there may be multiple portals on the page and provide more
5008
5157
  * alignment options for the child to be displayed.
5158
+ * ```ts
5159
+ * <div style="padding: 40px">
5160
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
5161
+ * Tooltip Anchor
5162
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
5163
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
5164
+ * </verdocs-portal>
5165
+ * </div>
5166
+ * </div>
5167
+ * ```
5009
5168
  */
5010
5169
  interface VerdocsPortal {
5011
5170
  /**
@@ -5026,6 +5185,9 @@ declare namespace LocalJSX {
5026
5185
  * Display a template preview experience. This will display the template's attached
5027
5186
  * documents with signing fields overlaid on each page. Fields will be color-coded
5028
5187
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
5188
+ * ```ts
5189
+ * <verdocs-preview templateId={templateId} />
5190
+ * ```
5029
5191
  */
5030
5192
  interface VerdocsPreview {
5031
5193
  /**
@@ -5042,7 +5204,10 @@ declare namespace LocalJSX {
5042
5204
  "templateId"?: string | null;
5043
5205
  }
5044
5206
  /**
5045
- * A simple progress bar.
5207
+ * Display a simple progress bar in a style consistent with the design system.
5208
+ * ```ts
5209
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
5210
+ * ```
5046
5211
  */
5047
5212
  interface VerdocsProgressBar {
5048
5213
  /**
@@ -5060,6 +5225,9 @@ declare namespace LocalJSX {
5060
5225
  }
5061
5226
  /**
5062
5227
  * Display a drop-down menu of quick filter options.
5228
+ * ```ts
5229
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
5230
+ * ```
5063
5231
  */
5064
5232
  interface VerdocsQuickFilter {
5065
5233
  "label"?: string;
@@ -5099,7 +5267,7 @@ declare namespace LocalJSX {
5099
5267
  * simple radio button for UI displays e.g. dialog boxes.
5100
5268
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
5101
5269
  * handler. Sample usage:
5102
- * ```html
5270
+ * ```ts
5103
5271
  * <verdocs-radio-button
5104
5272
  * value="val1"
5105
5273
  * name="someProperty"
@@ -5177,7 +5345,11 @@ declare namespace LocalJSX {
5177
5345
  /**
5178
5346
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
5179
5347
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
5180
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
5348
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
5349
+ * ```ts
5350
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
5351
+ * @input ={() => {}} />
5352
+ * ```
5181
5353
  */
5182
5354
  interface VerdocsSelectInput {
5183
5355
  /**
@@ -5198,12 +5370,18 @@ declare namespace LocalJSX {
5198
5370
  "value"?: string;
5199
5371
  }
5200
5372
  /**
5201
- * Display a form to collect recipient information for a new Envelope. If used anonymously, the specified `templateId` must be public.
5202
- * Because most applications have custom workflow requirements to trigger after sending an Envelope, this component does not actually
5203
- * perform that operation. Parent applications should listen for the `onSend` event, and can pass the contents of `event.detail`
5204
- * directly to the `createEnvelope()` call in JS-SDK.
5205
- * Host applications should ensure the template is "sendable" before displaying this component. To be sendable, a template must have
5206
- * at least one document attached, at least one participant defined, and at least one field assigned to every "signer" participant.
5373
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
5374
+ * that because most applications have custom workflow requirements to trigger after sending an
5375
+ * Envelope, this component does not actually perform that operation. Parent applications should
5376
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
5377
+ * `createEnvelope()` call in JS-SDK.
5378
+ * Host applications should ensure the template is "sendable" before displaying this component.
5379
+ * To be sendable, a template must have at least one document attached, at least one participant
5380
+ * defined, and at least one field assigned to every "signer" participant. This component will
5381
+ * hide itself if the template is not sendable.
5382
+ * ```ts
5383
+ * <verdocs-send templateId={templateId} />
5384
+ * ```
5207
5385
  */
5208
5386
  interface VerdocsSend {
5209
5387
  /**
@@ -5243,6 +5421,9 @@ declare namespace LocalJSX {
5243
5421
  * Display a template preview experience. This will display the template's attached
5244
5422
  * documents with signing fields overlaid on each page. Fields will be color-coded
5245
5423
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
5424
+ * ```ts
5425
+ * <verdocs-settings />
5426
+ * ```
5246
5427
  */
5247
5428
  interface VerdocsSettings {
5248
5429
  /**
@@ -5403,6 +5584,9 @@ declare namespace LocalJSX {
5403
5584
  }
5404
5585
  /**
5405
5586
  * Display a small loading spinner.
5587
+ * ```ts
5588
+ * <verdocs-spinner />
5589
+ * ```
5406
5590
  */
5407
5591
  interface VerdocsSpinner {
5408
5592
  "mode"?: 'light' | 'dark';
@@ -5436,6 +5620,9 @@ declare namespace LocalJSX {
5436
5620
  /**
5437
5621
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
5438
5622
  * support creating interactive table layouts.
5623
+ * ```ts
5624
+ * <verdocs-table columns={[...columns]} data={[...data]} />
5625
+ * ```
5439
5626
  */
5440
5627
  interface VerdocsTable {
5441
5628
  /**
@@ -5458,6 +5645,9 @@ declare namespace LocalJSX {
5458
5645
  /**
5459
5646
  * Display a simple row of selectable tabs. This is a controlled element.
5460
5647
  * The parent must adjust selectedTab as selection events are fired.
5648
+ * ```ts
5649
+ * <verdocs-tabs tabs={[...tabs]} />
5650
+ * ```
5461
5651
  */
5462
5652
  interface VerdocsTabs {
5463
5653
  /**
@@ -5954,7 +6144,10 @@ declare namespace LocalJSX {
5954
6144
  /**
5955
6145
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
5956
6146
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
5957
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
6147
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
6148
+ * ```ts
6149
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
6150
+ * ```
5958
6151
  */
5959
6152
  interface VerdocsTextInput {
5960
6153
  /**
@@ -5999,7 +6192,10 @@ declare namespace LocalJSX {
5999
6192
  "value"?: string;
6000
6193
  }
6001
6194
  /**
6002
- * Displays a label and a set of buttons, also allowing a default selection of a button
6195
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
6196
+ * ```ts
6197
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
6198
+ * ```
6003
6199
  */
6004
6200
  interface VerdocsToggle {
6005
6201
  /**
@@ -6013,6 +6209,9 @@ declare namespace LocalJSX {
6013
6209
  }
6014
6210
  /**
6015
6211
  * Displays a single button that can be toggled on or off by clicking it.
6212
+ * ```ts
6213
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
6214
+ * ```
6016
6215
  */
6017
6216
  interface VerdocsToggleButton {
6018
6217
  "active"?: boolean;
@@ -6035,6 +6234,9 @@ declare namespace LocalJSX {
6035
6234
  }
6036
6235
  /**
6037
6236
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
6237
+ * ```ts
6238
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
6239
+ * ```
6038
6240
  */
6039
6241
  interface VerdocsToolbarIcon {
6040
6242
  /**
@@ -6130,7 +6332,6 @@ declare namespace LocalJSX {
6130
6332
  "verdocs-field-textbox": VerdocsFieldTextbox;
6131
6333
  "verdocs-field-timestamp": VerdocsFieldTimestamp;
6132
6334
  "verdocs-file-chooser": VerdocsFileChooser;
6133
- "verdocs-floating-menu": VerdocsFloatingMenu;
6134
6335
  "verdocs-help-icon": VerdocsHelpIcon;
6135
6336
  "verdocs-initial-dialog": VerdocsInitialDialog;
6136
6337
  "verdocs-kba-dialog": VerdocsKbaDialog;
@@ -6195,43 +6396,46 @@ declare module "@stencil/core" {
6195
6396
  */
6196
6397
  "verdocs-activity-box": LocalJSX.VerdocsActivityBox & JSXBase.HTMLAttributes<HTMLVerdocsActivityBoxElement>;
6197
6398
  /**
6198
- * Display an authentication dialog that allows the user to login or sign up. Callbacks are provided for events that
6199
- * occur during the process (especially successful completion). If the user is already authenticated with a valid
6200
- * session, this component will hide itself and fire the success callback immediately. It is up to the host application
6201
- * to render the next appropriate view for the application.
6202
- * To simplify some types of authentication flows, a visibility flag can force this component to never display. This
6203
- * allows you to susbcribe to notifications from the
6399
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
6400
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
6401
+ * host application to render the next appropriate view for the application.
6402
+ * To simplify UI development, a visibility flag can force this component to never display. This
6403
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
6204
6404
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
6205
6405
  * container to allow sufficient space for the required forms.
6206
- * As noted below, the primary event is `authenticated`. This will always be fired at least once, immediately after
6207
- * the widget is rendered and the user's status has been checked. It may be fired again as the user completes (or
6208
- * cancels) authentication steps.
6209
- * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
6210
- * embed. This Element will reuse the same session produced by logging in via that Embed.
6211
- * ```typescript
6212
- * interface IAuthStatus {
6213
- * // If true, the user is authenticated with a valid session
6214
- * authenticated: boolean;
6215
- * // Details for the user's session
6216
- * session: IActiveSession | null;
6217
- * }
6406
+ * ```ts
6407
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
6218
6408
  * ```
6219
6409
  */
6220
6410
  "verdocs-auth": LocalJSX.VerdocsAuth & JSXBase.HTMLAttributes<HTMLVerdocsAuthElement>;
6221
6411
  /**
6222
6412
  * Display a template building experience.
6413
+ * ```ts
6414
+ * <verdocs-build templateId={templateId} />
6415
+ * ```
6223
6416
  */
6224
6417
  "verdocs-build": LocalJSX.VerdocsBuild & JSXBase.HTMLAttributes<HTMLVerdocsBuildElement>;
6225
6418
  /**
6226
- * A simple button
6227
- * ```jsx
6228
- * <verdocs-button label="Click Me" />
6419
+ * A simple button, with consistent styling to other controls in the design system.
6420
+ * ```ts
6421
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
6229
6422
  * ```
6230
6423
  */
6231
6424
  "verdocs-button": LocalJSX.VerdocsButton & JSXBase.HTMLAttributes<HTMLVerdocsButtonElement>;
6232
6425
  /**
6233
6426
  * Display an icon button that triggers a drop-down panel that can display
6234
6427
  * arbitrary child content, such as metadata, forms, or other controls.
6428
+ * ```ts
6429
+ * <verdocs-button-panel .icon=${icon}>
6430
+ * <h6>Field Settings</h6>
6431
+ * <form>
6432
+ * <p>
6433
+ * <label>Field Name</label>
6434
+ * <input type="text" placeholder="Field Name..." />
6435
+ * </p>
6436
+ * </form>
6437
+ * </verdocs-button-panel>
6438
+ * ```
6235
6439
  */
6236
6440
  "verdocs-button-panel": LocalJSX.VerdocsButtonPanel & JSXBase.HTMLAttributes<HTMLVerdocsButtonPanelElement>;
6237
6441
  /**
@@ -6240,7 +6444,7 @@ declare module "@stencil/core" {
6240
6444
  * box for UI displays e.g. dialog boxes.
6241
6445
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
6242
6446
  * handler. Sample usage:
6243
- * ```html
6447
+ * ```ts
6244
6448
  * <verdocs-checkbox
6245
6449
  * value="on"
6246
6450
  * name="thingEnabled"
@@ -6270,7 +6474,7 @@ declare module "@stencil/core" {
6270
6474
  /**
6271
6475
  * Display a drop-down menu button. A menu of the specified options will be displayed when the button is pressed. The menu will be hidden
6272
6476
  * when the button is pressed again, or an option is selected. Separators may be created by supplying an entry with an empty label.
6273
- * ```html
6477
+ * ```ts
6274
6478
  * <verdocs-dropdown
6275
6479
  * options={[
6276
6480
  * {label: 'Option 1', disabled: true},
@@ -6320,13 +6524,16 @@ declare module "@stencil/core" {
6320
6524
  */
6321
6525
  "verdocs-field-date": LocalJSX.VerdocsFieldDate & JSXBase.HTMLAttributes<HTMLVerdocsFieldDateElement>;
6322
6526
  /**
6323
- * Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as
6324
- * input types like text and checkbox.
6527
+ * Displays a dropdown field that allows the user to choose one of a list of options.
6325
6528
  */
6326
6529
  "verdocs-field-dropdown": LocalJSX.VerdocsFieldDropdown & JSXBase.HTMLAttributes<HTMLVerdocsFieldDropdownElement>;
6327
6530
  /**
6328
- * Displays an initial field. If an initial already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
6329
- * button will be shown. Clicking the button will show a dialog to adopt an initial.
6531
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
6532
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
6533
+ * show a dialog to adopt an initial.
6534
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
6535
+ * This requires operation against a live, valid envelope. If you are testing this component
6536
+ * in Storybook, it will not be visible here.
6330
6537
  */
6331
6538
  "verdocs-field-initial": LocalJSX.VerdocsFieldInitial & JSXBase.HTMLAttributes<HTMLVerdocsFieldInitialElement>;
6332
6539
  /**
@@ -6339,35 +6546,41 @@ declare module "@stencil/core" {
6339
6546
  */
6340
6547
  "verdocs-field-radio-button": LocalJSX.VerdocsFieldRadioButton & JSXBase.HTMLAttributes<HTMLVerdocsFieldRadioButtonElement>;
6341
6548
  /**
6342
- * Displays a signature field. If a signature already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
6343
- * button will be shown. Clicking the button will show a dialog to adopt a signature.
6549
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
6550
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
6551
+ * show a dialog to adopt a signature.
6552
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
6553
+ * This requires operation against a live, valid envelope. If you are testing this component
6554
+ * in Storybook, it will not be visible here.
6344
6555
  */
6345
6556
  "verdocs-field-signature": LocalJSX.VerdocsFieldSignature & JSXBase.HTMLAttributes<HTMLVerdocsFieldSignatureElement>;
6346
6557
  /**
6347
- * Display a multi-line text input field.
6558
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
6559
+ * as the BOTTOM-LEFT corner.
6348
6560
  */
6349
6561
  "verdocs-field-textarea": LocalJSX.VerdocsFieldTextarea & JSXBase.HTMLAttributes<HTMLVerdocsFieldTextareaElement>;
6350
6562
  /**
6351
- * Display a text input field.
6563
+ * Display a simple 1-line text input field.
6352
6564
  */
6353
6565
  "verdocs-field-textbox": LocalJSX.VerdocsFieldTextbox & JSXBase.HTMLAttributes<HTMLVerdocsFieldTextboxElement>;
6354
6566
  /**
6355
- * Display a timestamp field.
6567
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
6568
+ * filled when the signer submits the document.
6356
6569
  */
6357
6570
  "verdocs-field-timestamp": LocalJSX.VerdocsFieldTimestamp & JSXBase.HTMLAttributes<HTMLVerdocsFieldTimestampElement>;
6358
6571
  /**
6359
6572
  * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
6360
6573
  * provide the actual upload functionality.
6574
+ * ```ts
6575
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
6576
+ * ```
6361
6577
  */
6362
6578
  "verdocs-file-chooser": LocalJSX.VerdocsFileChooser & JSXBase.HTMLAttributes<HTMLVerdocsFileChooserElement>;
6363
- /**
6364
- * Floating Action Button style menu. For proper placement, this should be added to the DOM inside a container that is set to
6365
- * `overflow-y: scroll;`. The component will detect that placement and position itself in the bottom-right corner on top of the
6366
- * container. It will be absolutely positioned so it will be unaffected by scrolling the container.
6367
- */
6368
- "verdocs-floating-menu": LocalJSX.VerdocsFloatingMenu & JSXBase.HTMLAttributes<HTMLVerdocsFloatingMenuElement>;
6369
6579
  /**
6370
6580
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
6581
+ * ```ts
6582
+ * <verdocs-help-icon text="Sample help text" />
6583
+ * ```
6371
6584
  */
6372
6585
  "verdocs-help-icon": LocalJSX.VerdocsHelpIcon & JSXBase.HTMLAttributes<HTMLVerdocsHelpIconElement>;
6373
6586
  /**
@@ -6376,13 +6589,14 @@ declare module "@stencil/core" {
6376
6589
  */
6377
6590
  "verdocs-initial-dialog": LocalJSX.VerdocsInitialDialog & JSXBase.HTMLAttributes<HTMLVerdocsInitialDialogElement>;
6378
6591
  /**
6379
- * Display a text input field. This adds a partially-transparent overlay and screen-centered dialog
6380
- * box with a message and optional header/title. An OK button is shown that will dismiss the message.
6381
- * It can also be dismissed by clicking the background overlay.
6592
+ * Prompt the user to confirm their identity with a series of questions.
6382
6593
  */
6383
6594
  "verdocs-kba-dialog": LocalJSX.VerdocsKbaDialog & JSXBase.HTMLAttributes<HTMLVerdocsKbaDialogElement>;
6384
6595
  /**
6385
6596
  * Animated loader placeholder. There are currently no configuration options for this control.
6597
+ * ```ts
6598
+ * <verdocs-loader />
6599
+ * ```
6386
6600
  */
6387
6601
  "verdocs-loader": LocalJSX.VerdocsLoader & JSXBase.HTMLAttributes<HTMLVerdocsLoaderElement>;
6388
6602
  /**
@@ -6392,11 +6606,22 @@ declare module "@stencil/core" {
6392
6606
  */
6393
6607
  "verdocs-ok-dialog": LocalJSX.VerdocsOkDialog & JSXBase.HTMLAttributes<HTMLVerdocsOkDialogElement>;
6394
6608
  /**
6395
- * Display a small summary card describing an organization
6609
+ * Display a small summary card describing an organization.
6610
+ * ```ts
6611
+ * <verdocs-organization-card organization={organization} />
6612
+ * ```
6396
6613
  */
6397
6614
  "verdocs-organization-card": LocalJSX.VerdocsOrganizationCard & JSXBase.HTMLAttributes<HTMLVerdocsOrganizationCardElement>;
6398
6615
  /**
6399
6616
  * Display a simple pagination control with individual buttons to move through the data set.
6617
+ * ```ts
6618
+ * <verdocs-pagination
6619
+ * selectedPage={1}
6620
+ * itemCount={50}
6621
+ * perPage={10}
6622
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
6623
+ * />
6624
+ * ```
6400
6625
  */
6401
6626
  "verdocs-pagination": LocalJSX.VerdocsPagination & JSXBase.HTMLAttributes<HTMLVerdocsPaginationElement>;
6402
6627
  /**
@@ -6406,20 +6631,39 @@ declare module "@stencil/core" {
6406
6631
  * technique. This has been altered in a few ways to make it more friendly
6407
6632
  * to cases where there may be multiple portals on the page and provide more
6408
6633
  * alignment options for the child to be displayed.
6634
+ * ```ts
6635
+ * <div style="padding: 40px">
6636
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
6637
+ * Tooltip Anchor
6638
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
6639
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
6640
+ * </verdocs-portal>
6641
+ * </div>
6642
+ * </div>
6643
+ * ```
6409
6644
  */
6410
6645
  "verdocs-portal": LocalJSX.VerdocsPortal & JSXBase.HTMLAttributes<HTMLVerdocsPortalElement>;
6411
6646
  /**
6412
6647
  * Display a template preview experience. This will display the template's attached
6413
6648
  * documents with signing fields overlaid on each page. Fields will be color-coded
6414
6649
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
6650
+ * ```ts
6651
+ * <verdocs-preview templateId={templateId} />
6652
+ * ```
6415
6653
  */
6416
6654
  "verdocs-preview": LocalJSX.VerdocsPreview & JSXBase.HTMLAttributes<HTMLVerdocsPreviewElement>;
6417
6655
  /**
6418
- * A simple progress bar.
6656
+ * Display a simple progress bar in a style consistent with the design system.
6657
+ * ```ts
6658
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
6659
+ * ```
6419
6660
  */
6420
6661
  "verdocs-progress-bar": LocalJSX.VerdocsProgressBar & JSXBase.HTMLAttributes<HTMLVerdocsProgressBarElement>;
6421
6662
  /**
6422
6663
  * Display a drop-down menu of quick filter options.
6664
+ * ```ts
6665
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
6666
+ * ```
6423
6667
  */
6424
6668
  "verdocs-quick-filter": LocalJSX.VerdocsQuickFilter & JSXBase.HTMLAttributes<HTMLVerdocsQuickFilterElement>;
6425
6669
  /**
@@ -6434,7 +6678,7 @@ declare module "@stencil/core" {
6434
6678
  * simple radio button for UI displays e.g. dialog boxes.
6435
6679
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
6436
6680
  * handler. Sample usage:
6437
- * ```html
6681
+ * ```ts
6438
6682
  * <verdocs-radio-button
6439
6683
  * value="val1"
6440
6684
  * name="someProperty"
@@ -6456,22 +6700,35 @@ declare module "@stencil/core" {
6456
6700
  /**
6457
6701
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
6458
6702
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
6459
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
6703
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
6704
+ * ```ts
6705
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
6706
+ * @input ={() => {}} />
6707
+ * ```
6460
6708
  */
6461
6709
  "verdocs-select-input": LocalJSX.VerdocsSelectInput & JSXBase.HTMLAttributes<HTMLVerdocsSelectInputElement>;
6462
6710
  /**
6463
- * Display a form to collect recipient information for a new Envelope. If used anonymously, the specified `templateId` must be public.
6464
- * Because most applications have custom workflow requirements to trigger after sending an Envelope, this component does not actually
6465
- * perform that operation. Parent applications should listen for the `onSend` event, and can pass the contents of `event.detail`
6466
- * directly to the `createEnvelope()` call in JS-SDK.
6467
- * Host applications should ensure the template is "sendable" before displaying this component. To be sendable, a template must have
6468
- * at least one document attached, at least one participant defined, and at least one field assigned to every "signer" participant.
6711
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
6712
+ * that because most applications have custom workflow requirements to trigger after sending an
6713
+ * Envelope, this component does not actually perform that operation. Parent applications should
6714
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
6715
+ * `createEnvelope()` call in JS-SDK.
6716
+ * Host applications should ensure the template is "sendable" before displaying this component.
6717
+ * To be sendable, a template must have at least one document attached, at least one participant
6718
+ * defined, and at least one field assigned to every "signer" participant. This component will
6719
+ * hide itself if the template is not sendable.
6720
+ * ```ts
6721
+ * <verdocs-send templateId={templateId} />
6722
+ * ```
6469
6723
  */
6470
6724
  "verdocs-send": LocalJSX.VerdocsSend & JSXBase.HTMLAttributes<HTMLVerdocsSendElement>;
6471
6725
  /**
6472
6726
  * Display a template preview experience. This will display the template's attached
6473
6727
  * documents with signing fields overlaid on each page. Fields will be color-coded
6474
6728
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
6729
+ * ```ts
6730
+ * <verdocs-settings />
6731
+ * ```
6475
6732
  */
6476
6733
  "verdocs-settings": LocalJSX.VerdocsSettings & JSXBase.HTMLAttributes<HTMLVerdocsSettingsElement>;
6477
6734
  /**
@@ -6513,6 +6770,9 @@ declare module "@stencil/core" {
6513
6770
  "verdocs-signature-dialog": LocalJSX.VerdocsSignatureDialog & JSXBase.HTMLAttributes<HTMLVerdocsSignatureDialogElement>;
6514
6771
  /**
6515
6772
  * Display a small loading spinner.
6773
+ * ```ts
6774
+ * <verdocs-spinner />
6775
+ * ```
6516
6776
  */
6517
6777
  "verdocs-spinner": LocalJSX.VerdocsSpinner & JSXBase.HTMLAttributes<HTMLVerdocsSpinnerElement>;
6518
6778
  /**
@@ -6526,11 +6786,17 @@ declare module "@stencil/core" {
6526
6786
  /**
6527
6787
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
6528
6788
  * support creating interactive table layouts.
6789
+ * ```ts
6790
+ * <verdocs-table columns={[...columns]} data={[...data]} />
6791
+ * ```
6529
6792
  */
6530
6793
  "verdocs-table": LocalJSX.VerdocsTable & JSXBase.HTMLAttributes<HTMLVerdocsTableElement>;
6531
6794
  /**
6532
6795
  * Display a simple row of selectable tabs. This is a controlled element.
6533
6796
  * The parent must adjust selectedTab as selection events are fired.
6797
+ * ```ts
6798
+ * <verdocs-tabs tabs={[...tabs]} />
6799
+ * ```
6534
6800
  */
6535
6801
  "verdocs-tabs": LocalJSX.VerdocsTabs & JSXBase.HTMLAttributes<HTMLVerdocsTabsElement>;
6536
6802
  /**
@@ -6605,19 +6871,31 @@ declare module "@stencil/core" {
6605
6871
  /**
6606
6872
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
6607
6873
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
6608
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
6874
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
6875
+ * ```ts
6876
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
6877
+ * ```
6609
6878
  */
6610
6879
  "verdocs-text-input": LocalJSX.VerdocsTextInput & JSXBase.HTMLAttributes<HTMLVerdocsTextInputElement>;
6611
6880
  /**
6612
- * Displays a label and a set of buttons, also allowing a default selection of a button
6881
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
6882
+ * ```ts
6883
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
6884
+ * ```
6613
6885
  */
6614
6886
  "verdocs-toggle": LocalJSX.VerdocsToggle & JSXBase.HTMLAttributes<HTMLVerdocsToggleElement>;
6615
6887
  /**
6616
6888
  * Displays a single button that can be toggled on or off by clicking it.
6889
+ * ```ts
6890
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
6891
+ * ```
6617
6892
  */
6618
6893
  "verdocs-toggle-button": LocalJSX.VerdocsToggleButton & JSXBase.HTMLAttributes<HTMLVerdocsToggleButtonElement>;
6619
6894
  /**
6620
6895
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
6896
+ * ```ts
6897
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
6898
+ * ```
6621
6899
  */
6622
6900
  "verdocs-toolbar-icon": LocalJSX.VerdocsToolbarIcon & JSXBase.HTMLAttributes<HTMLVerdocsToolbarIconElement>;
6623
6901
  /**