@verdocs/web-sdk 4.0.9 → 4.1.3

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 +1 -2
  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 +119 -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/custom-elements.json +32 -40
  209. package/dist/esm/{EnvelopeStore-fefba6fd.js → EnvelopeStore-9df042b5.js} +10 -0
  210. package/dist/esm/{TemplateFieldStore-d7516adf.js → TemplateFieldStore-32329b5a.js} +2 -6
  211. package/dist/esm/{TemplateRoleStore-ddc3b96f.js → TemplateRoleStore-0a4f98cb.js} +0 -5
  212. package/dist/esm/{TemplateStore-df5484bb.js → TemplateStore-78ad24d7.js} +20 -5
  213. package/dist/esm/index-b89cf6a4.js +18 -18
  214. package/dist/esm/{interact.min-b055a9b6.js → interact.min-4fac3f2b.js} +1 -1
  215. package/dist/esm/loader.js +1 -1
  216. package/dist/esm/{utils-61c1093b.js → utils-d1c95309.js} +6 -13
  217. package/dist/esm/verdocs-auth.entry.js +2 -2
  218. package/dist/esm/verdocs-build.entry.js +29 -24
  219. package/dist/esm/verdocs-button-panel.entry.js +2 -2
  220. package/dist/esm/verdocs-button_3.entry.js +5 -5
  221. package/dist/esm/{verdocs-checkbox_5.entry.js → verdocs-checkbox_3.entry.js} +6 -92
  222. package/dist/esm/verdocs-component-error.entry.js +17 -0
  223. package/dist/esm/verdocs-contact-picker_2.entry.js +30 -11
  224. package/dist/esm/verdocs-dialog_2.entry.js +4 -6
  225. package/dist/esm/verdocs-dropdown.entry.js +1 -1
  226. package/dist/esm/verdocs-envelope-document-page.entry.js +2 -2
  227. package/dist/esm/verdocs-envelope-recipient-link_2.entry.js +1 -1
  228. package/dist/esm/verdocs-envelope-sidebar.entry.js +1 -1
  229. package/dist/esm/verdocs-envelopes-list.entry.js +7 -7
  230. package/dist/esm/{verdocs-field-attachment_14.entry.js → verdocs-field-attachment_13.entry.js} +205 -379
  231. package/dist/esm/verdocs-field-payment.entry.js +3 -3
  232. package/dist/esm/verdocs-file-chooser_2.entry.js +3 -3
  233. package/dist/esm/verdocs-kba-dialog.entry.js +5 -5
  234. package/dist/esm/verdocs-loader.entry.js +1 -1
  235. package/dist/esm/verdocs-ok-dialog.entry.js +2 -2
  236. package/dist/esm/{verdocs-organization-card.entry.js → verdocs-organization-card_2.entry.js} +86 -7
  237. package/dist/esm/verdocs-pagination_2.entry.js +3 -3
  238. package/dist/esm/verdocs-preview_10.entry.js +156 -79
  239. package/dist/esm/verdocs-quick-functions_2.entry.js +2 -2
  240. package/dist/esm/verdocs-radio-button_3.entry.js +12 -12
  241. package/dist/esm/verdocs-search-tabs.entry.js +1 -1
  242. package/dist/esm/verdocs-search.entry.js +1 -1
  243. package/dist/esm/verdocs-settings-api-keys_4.entry.js +11 -24
  244. package/dist/esm/verdocs-settings.entry.js +1 -2
  245. package/dist/esm/verdocs-sign.entry.js +2 -2
  246. package/dist/esm/verdocs-spinner.entry.js +1 -1
  247. package/dist/esm/verdocs-status-indicator.entry.js +11 -3
  248. package/dist/esm/verdocs-tabs.entry.js +2 -2
  249. package/dist/esm/verdocs-template-card.entry.js +1 -1
  250. package/dist/esm/verdocs-template-document-page_2.entry.js +205 -0
  251. package/dist/esm/verdocs-template-star.entry.js +1 -1
  252. package/dist/esm/verdocs-template-tags.entry.js +1 -1
  253. package/dist/esm/verdocs-templates-list.entry.js +7 -7
  254. package/dist/esm/verdocs-toggle.entry.js +1 -1
  255. package/dist/esm/verdocs-view.entry.js +1 -1
  256. package/dist/esm/verdocs-web-sdk.js +1 -1
  257. package/dist/esm-es5/{EnvelopeStore-fefba6fd.js → EnvelopeStore-9df042b5.js} +1 -1
  258. package/dist/esm-es5/TemplateFieldStore-32329b5a.js +1 -0
  259. package/dist/esm-es5/TemplateRoleStore-0a4f98cb.js +1 -0
  260. package/dist/esm-es5/TemplateStore-78ad24d7.js +1 -0
  261. package/dist/esm-es5/index-b89cf6a4.js +1 -1
  262. package/dist/esm-es5/{interact.min-b055a9b6.js → interact.min-4fac3f2b.js} +1 -1
  263. package/dist/esm-es5/loader.js +1 -1
  264. package/dist/esm-es5/{utils-61c1093b.js → utils-d1c95309.js} +1 -1
  265. package/dist/esm-es5/verdocs-auth.entry.js +1 -1
  266. package/dist/esm-es5/verdocs-build.entry.js +1 -1
  267. package/dist/esm-es5/verdocs-button-panel.entry.js +1 -1
  268. package/dist/esm-es5/verdocs-button_3.entry.js +1 -1
  269. package/dist/esm-es5/verdocs-checkbox_3.entry.js +1 -0
  270. package/dist/esm-es5/verdocs-component-error.entry.js +1 -0
  271. package/dist/esm-es5/verdocs-contact-picker_2.entry.js +1 -1
  272. package/dist/esm-es5/verdocs-dialog_2.entry.js +1 -1
  273. package/dist/esm-es5/verdocs-dropdown.entry.js +1 -1
  274. package/dist/esm-es5/verdocs-envelope-document-page.entry.js +1 -1
  275. package/dist/esm-es5/verdocs-envelope-recipient-link_2.entry.js +1 -1
  276. package/dist/esm-es5/verdocs-envelope-sidebar.entry.js +1 -1
  277. package/dist/esm-es5/verdocs-envelopes-list.entry.js +1 -1
  278. package/dist/esm-es5/verdocs-field-attachment_13.entry.js +1 -0
  279. package/dist/esm-es5/verdocs-field-payment.entry.js +1 -1
  280. package/dist/esm-es5/verdocs-file-chooser_2.entry.js +1 -1
  281. package/dist/esm-es5/verdocs-kba-dialog.entry.js +1 -1
  282. package/dist/esm-es5/verdocs-loader.entry.js +1 -1
  283. package/dist/esm-es5/verdocs-ok-dialog.entry.js +1 -1
  284. package/dist/esm-es5/verdocs-organization-card_2.entry.js +1 -0
  285. package/dist/esm-es5/verdocs-pagination_2.entry.js +1 -1
  286. package/dist/esm-es5/verdocs-preview_10.entry.js +1 -1
  287. package/dist/esm-es5/verdocs-quick-functions_2.entry.js +1 -1
  288. package/dist/esm-es5/verdocs-radio-button_3.entry.js +1 -1
  289. package/dist/esm-es5/verdocs-search-tabs.entry.js +1 -1
  290. package/dist/esm-es5/verdocs-search.entry.js +1 -1
  291. package/dist/esm-es5/verdocs-settings-api-keys_4.entry.js +1 -1
  292. package/dist/esm-es5/verdocs-settings.entry.js +1 -1
  293. package/dist/esm-es5/verdocs-sign.entry.js +1 -1
  294. package/dist/esm-es5/verdocs-spinner.entry.js +1 -1
  295. package/dist/esm-es5/verdocs-status-indicator.entry.js +1 -1
  296. package/dist/esm-es5/verdocs-tabs.entry.js +1 -1
  297. package/dist/esm-es5/verdocs-template-card.entry.js +1 -1
  298. package/dist/esm-es5/verdocs-template-document-page_2.entry.js +1 -0
  299. package/dist/esm-es5/verdocs-template-star.entry.js +1 -1
  300. package/dist/esm-es5/verdocs-template-tags.entry.js +1 -1
  301. package/dist/esm-es5/verdocs-templates-list.entry.js +1 -1
  302. package/dist/esm-es5/verdocs-toggle.entry.js +1 -1
  303. package/dist/esm-es5/verdocs-view.entry.js +1 -1
  304. package/dist/esm-es5/verdocs-web-sdk.js +1 -1
  305. package/dist/types/components/controls/verdocs-button/verdocs-button.d.ts +3 -3
  306. package/dist/types/components/controls/verdocs-button-panel/verdocs-button-panel.d.ts +12 -0
  307. package/dist/types/components/controls/verdocs-checkbox/verdocs-checkbox.d.ts +1 -1
  308. package/dist/types/components/controls/verdocs-dropdown/verdocs-dropdown.d.ts +1 -1
  309. package/dist/types/components/controls/verdocs-file-chooser/verdocs-file-chooser.d.ts +4 -0
  310. package/dist/types/components/controls/verdocs-help-icon/verdocs-help-icon.d.ts +4 -0
  311. package/dist/types/components/controls/verdocs-loader/verdocs-loader.d.ts +4 -0
  312. package/dist/types/components/controls/verdocs-organization-card/verdocs-organization-card.d.ts +9 -2
  313. package/dist/types/components/controls/verdocs-pagination/verdocs-pagination.d.ts +9 -0
  314. package/dist/types/components/controls/verdocs-portal/verdocs-portal.d.ts +11 -0
  315. package/dist/types/components/controls/verdocs-progress-bar/verdocs-progress-bar.d.ts +5 -1
  316. package/dist/types/components/controls/verdocs-quick-filter/verdocs-quick-filter.d.ts +4 -0
  317. package/dist/types/components/controls/verdocs-radio-button/verdocs-radio-button.d.ts +1 -1
  318. package/dist/types/components/controls/verdocs-select-input/verdocs-select-input.d.ts +5 -1
  319. package/dist/types/components/controls/verdocs-spinner/verdocs-spinner.d.ts +4 -0
  320. package/dist/types/components/controls/verdocs-table/verdocs-table.d.ts +4 -0
  321. package/dist/types/components/controls/verdocs-tabs/verdocs-tabs.d.ts +4 -0
  322. package/dist/types/components/controls/verdocs-text-input/verdocs-text-input.d.ts +5 -1
  323. package/dist/types/components/controls/verdocs-toggle/verdocs-toggle.d.ts +5 -1
  324. package/dist/types/components/controls/verdocs-toggle-button/verdocs-toggle-button.d.ts +4 -0
  325. package/dist/types/components/controls/verdocs-toolbar-icon/verdocs-toolbar-icon.d.ts +4 -0
  326. package/dist/types/components/dialogs/verdocs-kba-dialog/verdocs-kba-dialog.d.ts +1 -3
  327. package/dist/types/components/embeds/verdocs-auth/verdocs-auth.d.ts +10 -22
  328. package/dist/types/components/embeds/verdocs-build/verdocs-build.d.ts +8 -4
  329. package/dist/types/components/embeds/verdocs-preview/verdocs-preview.d.ts +6 -0
  330. package/dist/types/components/embeds/verdocs-send/verdocs-send.d.ts +17 -7
  331. package/dist/types/components/embeds/verdocs-settings/verdocs-settings.d.ts +4 -0
  332. package/dist/types/components/envelopes/verdocs-contact-picker/verdocs-contact-picker.d.ts +3 -0
  333. package/dist/types/components/fields/verdocs-field-attachment/verdocs-field-attachment.d.ts +24 -10
  334. package/dist/types/components/fields/verdocs-field-date/verdocs-field-date.d.ts +3 -3
  335. package/dist/types/components/fields/verdocs-field-dropdown/verdocs-field-dropdown.d.ts +1 -2
  336. package/dist/types/components/fields/verdocs-field-initial/verdocs-field-initial.d.ts +7 -2
  337. package/dist/types/components/fields/verdocs-field-signature/verdocs-field-signature.d.ts +7 -2
  338. package/dist/types/components/fields/verdocs-field-textarea/verdocs-field-textarea.d.ts +2 -1
  339. package/dist/types/components/fields/verdocs-field-textbox/verdocs-field-textbox.d.ts +1 -1
  340. package/dist/types/components/fields/verdocs-field-timestamp/verdocs-field-timestamp.d.ts +2 -1
  341. package/dist/types/components/settings/verdocs-settings-organization/verdocs-settings-organization.d.ts +0 -1
  342. package/dist/types/components/templates/verdocs-template-build-tabs/verdocs-template-build-tabs.d.ts +5 -3
  343. package/dist/types/components.d.ts +533 -253
  344. package/dist/types/utils/TemplateFieldStore.d.ts +0 -1
  345. package/dist/verdocs-web-sdk/{p-0003dac3.entry.js → p-000b8414.entry.js} +1 -1
  346. package/dist/verdocs-web-sdk/p-05c9b6c9.system.entry.js +1 -0
  347. package/dist/verdocs-web-sdk/{p-db9ef2cc.entry.js → p-0a0ac65f.entry.js} +1 -1
  348. package/dist/verdocs-web-sdk/p-0d5fb952.system.js +1 -0
  349. package/dist/verdocs-web-sdk/{p-79407dd8.entry.js → p-0ff14c4d.entry.js} +1 -1
  350. package/dist/verdocs-web-sdk/p-13450dcd.system.entry.js +1 -0
  351. package/dist/verdocs-web-sdk/{p-c1f7cfff.system.entry.js → p-16850eac.system.entry.js} +1 -1
  352. package/dist/verdocs-web-sdk/{p-82fbf5b5.entry.js → p-1dd1d686.entry.js} +1 -1
  353. package/dist/verdocs-web-sdk/{p-79cef953.system.entry.js → p-1fec2d1e.system.entry.js} +1 -1
  354. package/dist/verdocs-web-sdk/{p-483cc30b.entry.js → p-203d8ff0.entry.js} +1 -1
  355. package/dist/verdocs-web-sdk/{p-c543852a.entry.js → p-225418c7.entry.js} +1 -1
  356. package/dist/verdocs-web-sdk/p-2b6566eb.entry.js +1 -0
  357. package/dist/verdocs-web-sdk/{p-c244e090.entry.js → p-3093ede7.entry.js} +1 -1
  358. package/dist/verdocs-web-sdk/{p-819187c7.system.entry.js → p-314321b8.system.entry.js} +1 -1
  359. package/dist/verdocs-web-sdk/p-316fc185.js +1 -0
  360. package/dist/verdocs-web-sdk/p-322fa613.system.js +1 -1
  361. package/dist/verdocs-web-sdk/p-3a8b2213.system.entry.js +1 -0
  362. package/dist/verdocs-web-sdk/p-4291db9f.entry.js +1 -0
  363. package/dist/verdocs-web-sdk/{p-84f477d1.entry.js → p-42ec5f5b.entry.js} +1 -1
  364. package/dist/verdocs-web-sdk/{p-aaa5c11a.system.entry.js → p-43962d76.system.entry.js} +1 -1
  365. package/dist/verdocs-web-sdk/p-4542fd4b.entry.js +1 -0
  366. package/dist/verdocs-web-sdk/p-45cf0ab5.entry.js +1 -0
  367. package/dist/verdocs-web-sdk/p-4df630c2.system.entry.js +1 -0
  368. package/dist/verdocs-web-sdk/{p-35859fe1.system.entry.js → p-5070ad92.system.entry.js} +1 -1
  369. package/dist/verdocs-web-sdk/p-515ee177.system.entry.js +1 -0
  370. package/dist/verdocs-web-sdk/{p-4cd628a3.system.entry.js → p-5309a156.system.entry.js} +1 -1
  371. package/dist/verdocs-web-sdk/p-540d9467.entry.js +1 -0
  372. package/dist/verdocs-web-sdk/{p-4424d71f.system.entry.js → p-597bd8aa.system.entry.js} +1 -1
  373. package/dist/verdocs-web-sdk/{p-ac014bc9.system.entry.js → p-5be462d9.system.entry.js} +1 -1
  374. package/dist/verdocs-web-sdk/{p-6d1bdae8.system.js → p-5bec8b75.system.js} +1 -1
  375. package/dist/verdocs-web-sdk/{p-e92688db.entry.js → p-5df130eb.entry.js} +1 -1
  376. package/dist/verdocs-web-sdk/p-5e3e9c4a.system.js +1 -0
  377. package/dist/verdocs-web-sdk/{p-a88760cd.entry.js → p-62728531.entry.js} +1 -1
  378. package/dist/verdocs-web-sdk/{p-35157a14.js → p-627f774b.js} +1 -1
  379. package/dist/verdocs-web-sdk/p-62af2ee6.system.entry.js +1 -0
  380. package/dist/verdocs-web-sdk/{p-83d0f5e1.entry.js → p-67c3b3d1.entry.js} +1 -1
  381. package/dist/verdocs-web-sdk/{p-8fbf27ec.entry.js → p-6c5aee88.entry.js} +1 -1
  382. package/dist/verdocs-web-sdk/{p-7b009ca9.entry.js → p-71eeeff4.entry.js} +1 -1
  383. package/dist/verdocs-web-sdk/p-72c7e548.entry.js +1 -0
  384. package/dist/verdocs-web-sdk/p-73042665.entry.js +1 -0
  385. package/dist/verdocs-web-sdk/p-748ed4ef.entry.js +1 -0
  386. package/dist/verdocs-web-sdk/{p-ca71117e.system.entry.js → p-76297fa0.system.entry.js} +1 -1
  387. package/dist/verdocs-web-sdk/p-7b222135.system.entry.js +1 -0
  388. package/dist/verdocs-web-sdk/{p-7a9b4f83.entry.js → p-7b8ae86c.entry.js} +1 -1
  389. package/dist/verdocs-web-sdk/p-7c3b1e47.entry.js +1 -0
  390. package/dist/verdocs-web-sdk/{p-7ab60efa.entry.js → p-7e6fa885.entry.js} +1 -1
  391. package/dist/verdocs-web-sdk/{p-9a57eba9.entry.js → p-7ed27280.entry.js} +1 -1
  392. package/dist/verdocs-web-sdk/{p-db6a7e39.entry.js → p-7fe48d2e.entry.js} +1 -1
  393. package/dist/verdocs-web-sdk/{p-943c7b8f.system.entry.js → p-84781ec3.system.entry.js} +1 -1
  394. package/dist/verdocs-web-sdk/{p-c6645da7.system.entry.js → p-84caf3e1.system.entry.js} +1 -1
  395. package/dist/verdocs-web-sdk/{p-94c638b9.system.js → p-85519037.system.js} +1 -1
  396. package/dist/verdocs-web-sdk/p-900006b0.system.js +1 -0
  397. package/dist/verdocs-web-sdk/{p-756791df.system.entry.js → p-95e90092.system.entry.js} +1 -1
  398. package/dist/verdocs-web-sdk/{p-819fb18d.entry.js → p-96352ec7.entry.js} +1 -1
  399. package/dist/verdocs-web-sdk/p-971ab2d1.entry.js +1 -0
  400. package/dist/verdocs-web-sdk/{p-794109d4.entry.js → p-973a8142.entry.js} +1 -1
  401. package/dist/verdocs-web-sdk/{p-da7d343c.system.entry.js → p-98928410.system.entry.js} +1 -1
  402. package/dist/verdocs-web-sdk/{p-5f8341f5.system.entry.js → p-99510d53.system.entry.js} +1 -1
  403. package/dist/verdocs-web-sdk/p-9c05218b.entry.js +1 -0
  404. package/dist/verdocs-web-sdk/p-9ec464df.js +1 -0
  405. package/dist/verdocs-web-sdk/{p-e8e2bf33.entry.js → p-a5c6eac3.entry.js} +1 -1
  406. package/dist/verdocs-web-sdk/p-a908ebeb.system.entry.js +1 -0
  407. package/dist/verdocs-web-sdk/p-ac7d07de.system.entry.js +1 -0
  408. package/dist/verdocs-web-sdk/{p-79a5e9a6.entry.js → p-ad2814b4.entry.js} +1 -1
  409. package/dist/verdocs-web-sdk/p-afbbdc2f.system.js +1 -0
  410. package/dist/verdocs-web-sdk/p-b0df559c.entry.js +1 -0
  411. package/dist/verdocs-web-sdk/p-b3eab86c.entry.js +1 -0
  412. package/dist/verdocs-web-sdk/p-b699eeef.system.entry.js +1 -0
  413. package/dist/verdocs-web-sdk/{p-4297282e.system.entry.js → p-ba675574.system.entry.js} +1 -1
  414. package/dist/verdocs-web-sdk/{p-71a93045.system.entry.js → p-bb0ed696.system.entry.js} +1 -1
  415. package/dist/verdocs-web-sdk/p-bb1dc544.system.entry.js +1 -0
  416. package/dist/verdocs-web-sdk/{p-6fe0d270.entry.js → p-bbae0a6c.entry.js} +1 -1
  417. package/dist/verdocs-web-sdk/p-bf4a9089.system.entry.js +1 -0
  418. package/dist/verdocs-web-sdk/{p-7d035035.system.entry.js → p-bf8e7b5a.system.entry.js} +1 -1
  419. package/dist/verdocs-web-sdk/p-c28c4e43.js +1 -0
  420. package/dist/verdocs-web-sdk/{p-165bbc34.system.entry.js → p-c598ea74.system.entry.js} +1 -1
  421. package/dist/verdocs-web-sdk/{p-7b397f3a.js → p-cc32d84f.js} +1 -1
  422. package/dist/verdocs-web-sdk/p-ccdb7d88.system.entry.js +1 -0
  423. package/dist/verdocs-web-sdk/{p-8b5d40b6.system.entry.js → p-cf06ba29.system.entry.js} +1 -1
  424. package/dist/verdocs-web-sdk/{p-b259c449.system.entry.js → p-d4331e4f.system.entry.js} +1 -1
  425. package/dist/verdocs-web-sdk/p-d61235cf.entry.js +1 -0
  426. package/dist/verdocs-web-sdk/{p-164d9eb4.system.entry.js → p-e6992b79.system.entry.js} +1 -1
  427. package/dist/verdocs-web-sdk/p-e7b29b46.system.entry.js +1 -0
  428. package/dist/verdocs-web-sdk/{p-6a88d98b.entry.js → p-eaf4de2f.entry.js} +1 -1
  429. package/dist/verdocs-web-sdk/p-f05a3654.system.entry.js +1 -0
  430. package/dist/verdocs-web-sdk/{p-80d24da1.system.entry.js → p-f1d41587.system.entry.js} +1 -1
  431. package/dist/verdocs-web-sdk/p-f2f6c646.system.entry.js +1 -0
  432. package/dist/verdocs-web-sdk/{p-99c29b9c.system.entry.js → p-f54b4cc0.system.entry.js} +1 -1
  433. package/dist/verdocs-web-sdk/p-f69d8d39.js +1 -0
  434. package/dist/verdocs-web-sdk/{p-0bd91b17.entry.js → p-f91f3248.entry.js} +1 -1
  435. package/dist/verdocs-web-sdk/p-f9ffe6b9.entry.js +1 -0
  436. package/dist/verdocs-web-sdk/verdocs-web-sdk.esm.js +1 -1
  437. package/package.json +2 -2
  438. package/dist/cjs/verdocs-floating-menu.cjs.entry.js +0 -107
  439. package/dist/cjs/verdocs-toolbar-icon.cjs.entry.js +0 -52
  440. package/dist/collection/components/controls/verdocs-floating-menu/verdocs-floating-menu.css +0 -102
  441. package/dist/collection/components/controls/verdocs-floating-menu/verdocs-floating-menu.js +0 -162
  442. package/dist/components/verdocs-floating-menu.d.ts +0 -11
  443. package/dist/components/verdocs-floating-menu.js +0 -128
  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,7 @@ 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";
15
+ import { ISelectedFile } from "./components/fields/verdocs-field-attachment/verdocs-field-attachment";
16
16
  import { IFilterOption } from "./components/controls/verdocs-quick-filter/verdocs-quick-filter";
17
17
  import { ISearchEvent, TContentType } from "./components/elements/verdocs-search-box/verdocs-search-box";
18
18
  import { IContactSearchEvent as IContactSearchEvent1 } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
@@ -29,7 +29,7 @@ export { TVerdocsBuildStep } from "./components/embeds/verdocs-build/verdocs-bui
29
29
  export { IContactSearchEvent, IContactSelectEvent, IEmailContact, IPhoneContact } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
30
30
  export { IMenuOption } from "./components/controls/verdocs-dropdown/verdocs-dropdown";
31
31
  export { IDocumentPageInfo, IPageLayer } from "./utils/Types";
32
- export { IOption } from "./components/controls/verdocs-floating-menu/verdocs-floating-menu";
32
+ export { ISelectedFile } from "./components/fields/verdocs-field-attachment/verdocs-field-attachment";
33
33
  export { IFilterOption } from "./components/controls/verdocs-quick-filter/verdocs-quick-filter";
34
34
  export { ISearchEvent, TContentType } from "./components/elements/verdocs-search-box/verdocs-search-box";
35
35
  export { IContactSearchEvent as IContactSearchEvent1 } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
@@ -64,26 +64,15 @@ export namespace Components {
64
64
  "view"?: 'completed' | 'action' | 'waiting';
65
65
  }
66
66
  /**
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
67
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
68
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
69
+ * host application to render the next appropriate view for the application.
70
+ * To simplify UI development, a visibility flag can force this component to never display. This
71
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
73
72
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
74
73
  * 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
- * }
74
+ * ```ts
75
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
87
76
  * ```
88
77
  */
89
78
  interface VerdocsAuth {
@@ -102,6 +91,9 @@ export namespace Components {
102
91
  }
103
92
  /**
104
93
  * Display a template building experience.
94
+ * ```ts
95
+ * <verdocs-build templateId={templateId} />
96
+ * ```
105
97
  */
106
98
  interface VerdocsBuild {
107
99
  /**
@@ -118,9 +110,9 @@ export namespace Components {
118
110
  "templateId": string | null;
119
111
  }
120
112
  /**
121
- * A simple button
122
- * ```jsx
123
- * <verdocs-button label="Click Me" />
113
+ * A simple button, with consistent styling to other controls in the design system.
114
+ * ```ts
115
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
124
116
  * ```
125
117
  */
126
118
  interface VerdocsButton {
@@ -156,6 +148,17 @@ export namespace Components {
156
148
  /**
157
149
  * Display an icon button that triggers a drop-down panel that can display
158
150
  * arbitrary child content, such as metadata, forms, or other controls.
151
+ * ```ts
152
+ * <verdocs-button-panel .icon=${icon}>
153
+ * <h6>Field Settings</h6>
154
+ * <form>
155
+ * <p>
156
+ * <label>Field Name</label>
157
+ * <input type="text" placeholder="Field Name..." />
158
+ * </p>
159
+ * </form>
160
+ * </verdocs-button-panel>
161
+ * ```
159
162
  */
160
163
  interface VerdocsButtonPanel {
161
164
  "hidePanel": () => Promise<void>;
@@ -172,7 +175,7 @@ export namespace Components {
172
175
  * box for UI displays e.g. dialog boxes.
173
176
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
174
177
  * handler. Sample usage:
175
- * ```html
178
+ * ```ts
176
179
  * <verdocs-checkbox
177
180
  * value="on"
178
181
  * name="thingEnabled"
@@ -246,7 +249,7 @@ export namespace Components {
246
249
  /**
247
250
  * 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
251
  * 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
252
+ * ```ts
250
253
  * <verdocs-dropdown
251
254
  * options={[
252
255
  * {label: 'Option 1', disabled: true},
@@ -410,6 +413,10 @@ export namespace Components {
410
413
  * 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
414
  */
412
415
  "editable"?: boolean;
416
+ /**
417
+ * 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.
418
+ */
419
+ "endpoint": VerdocsEndpoint;
413
420
  /**
414
421
  * The name of the field to display.
415
422
  */
@@ -534,8 +541,7 @@ export namespace Components {
534
541
  "yscale"?: number;
535
542
  }
536
543
  /**
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.
544
+ * Displays a dropdown field that allows the user to choose one of a list of options.
539
545
  */
540
546
  interface VerdocsFieldDropdown {
541
547
  /**
@@ -579,8 +585,12 @@ export namespace Components {
579
585
  "yscale"?: number;
580
586
  }
581
587
  /**
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.
588
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
589
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
590
+ * show a dialog to adopt an initial.
591
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
592
+ * This requires operation against a live, valid envelope. If you are testing this component
593
+ * in Storybook, it will not be visible here.
584
594
  */
585
595
  interface VerdocsFieldInitial {
586
596
  /**
@@ -724,8 +734,12 @@ export namespace Components {
724
734
  "yscale"?: number;
725
735
  }
726
736
  /**
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.
737
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
738
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
739
+ * show a dialog to adopt a signature.
740
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
741
+ * This requires operation against a live, valid envelope. If you are testing this component
742
+ * in Storybook, it will not be visible here.
729
743
  */
730
744
  interface VerdocsFieldSignature {
731
745
  /**
@@ -773,7 +787,8 @@ export namespace Components {
773
787
  "yscale"?: number;
774
788
  }
775
789
  /**
776
- * Display a multi-line text input field.
790
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
791
+ * as the BOTTOM-LEFT corner.
777
792
  */
778
793
  interface VerdocsFieldTextarea {
779
794
  /**
@@ -821,7 +836,7 @@ export namespace Components {
821
836
  "yscale"?: number;
822
837
  }
823
838
  /**
824
- * Display a text input field.
839
+ * Display a simple 1-line text input field.
825
840
  */
826
841
  interface VerdocsFieldTextbox {
827
842
  /**
@@ -869,7 +884,8 @@ export namespace Components {
869
884
  "yscale"?: number;
870
885
  }
871
886
  /**
872
- * Display a timestamp field.
887
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
888
+ * filled when the signer submits the document.
873
889
  */
874
890
  interface VerdocsFieldTimestamp {
875
891
  /**
@@ -915,6 +931,9 @@ export namespace Components {
915
931
  /**
916
932
  * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
917
933
  * provide the actual upload functionality.
934
+ * ```ts
935
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
936
+ * ```
918
937
  */
919
938
  interface VerdocsFileChooser {
920
939
  /**
@@ -922,19 +941,11 @@ export namespace Components {
922
941
  */
923
942
  "endpoint": VerdocsEndpoint;
924
943
  }
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
944
  /**
937
945
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
946
+ * ```ts
947
+ * <verdocs-help-icon text="Sample help text" />
948
+ * ```
938
949
  */
939
950
  interface VerdocsHelpIcon {
940
951
  /**
@@ -957,9 +968,7 @@ export namespace Components {
957
968
  "initials": string;
958
969
  }
959
970
  /**
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.
971
+ * Prompt the user to confirm their identity with a series of questions.
963
972
  */
964
973
  interface VerdocsKbaDialog {
965
974
  /**
@@ -997,6 +1006,9 @@ export namespace Components {
997
1006
  }
998
1007
  /**
999
1008
  * Animated loader placeholder. There are currently no configuration options for this control.
1009
+ * ```ts
1010
+ * <verdocs-loader />
1011
+ * ```
1000
1012
  */
1001
1013
  interface VerdocsLoader {
1002
1014
  }
@@ -1024,7 +1036,10 @@ export namespace Components {
1024
1036
  "showCancel": boolean;
1025
1037
  }
1026
1038
  /**
1027
- * Display a small summary card describing an organization
1039
+ * Display a small summary card describing an organization.
1040
+ * ```ts
1041
+ * <verdocs-organization-card organization={organization} />
1042
+ * ```
1028
1043
  */
1029
1044
  interface VerdocsOrganizationCard {
1030
1045
  /**
@@ -1034,6 +1049,14 @@ export namespace Components {
1034
1049
  }
1035
1050
  /**
1036
1051
  * Display a simple pagination control with individual buttons to move through the data set.
1052
+ * ```ts
1053
+ * <verdocs-pagination
1054
+ * selectedPage={1}
1055
+ * itemCount={50}
1056
+ * perPage={10}
1057
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
1058
+ * />
1059
+ * ```
1037
1060
  */
1038
1061
  interface VerdocsPagination {
1039
1062
  /**
@@ -1056,6 +1079,16 @@ export namespace Components {
1056
1079
  * technique. This has been altered in a few ways to make it more friendly
1057
1080
  * to cases where there may be multiple portals on the page and provide more
1058
1081
  * alignment options for the child to be displayed.
1082
+ * ```ts
1083
+ * <div style="padding: 40px">
1084
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
1085
+ * Tooltip Anchor
1086
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
1087
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
1088
+ * </verdocs-portal>
1089
+ * </div>
1090
+ * </div>
1091
+ * ```
1059
1092
  */
1060
1093
  interface VerdocsPortal {
1061
1094
  /**
@@ -1075,6 +1108,9 @@ export namespace Components {
1075
1108
  * Display a template preview experience. This will display the template's attached
1076
1109
  * documents with signing fields overlaid on each page. Fields will be color-coded
1077
1110
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
1111
+ * ```ts
1112
+ * <verdocs-preview templateId={templateId} />
1113
+ * ```
1078
1114
  */
1079
1115
  interface VerdocsPreview {
1080
1116
  /**
@@ -1087,7 +1123,10 @@ export namespace Components {
1087
1123
  "templateId": string | null;
1088
1124
  }
1089
1125
  /**
1090
- * A simple progress bar.
1126
+ * Display a simple progress bar in a style consistent with the design system.
1127
+ * ```ts
1128
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
1129
+ * ```
1091
1130
  */
1092
1131
  interface VerdocsProgressBar {
1093
1132
  /**
@@ -1105,6 +1144,9 @@ export namespace Components {
1105
1144
  }
1106
1145
  /**
1107
1146
  * Display a drop-down menu of quick filter options.
1147
+ * ```ts
1148
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
1149
+ * ```
1108
1150
  */
1109
1151
  interface VerdocsQuickFilter {
1110
1152
  "label": string;
@@ -1132,7 +1174,7 @@ export namespace Components {
1132
1174
  * simple radio button for UI displays e.g. dialog boxes.
1133
1175
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
1134
1176
  * handler. Sample usage:
1135
- * ```html
1177
+ * ```ts
1136
1178
  * <verdocs-radio-button
1137
1179
  * value="val1"
1138
1180
  * name="someProperty"
@@ -1199,7 +1241,11 @@ export namespace Components {
1199
1241
  /**
1200
1242
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
1201
1243
  * 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.
1244
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
1245
+ * ```ts
1246
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
1247
+ * @input ={() => {}} />
1248
+ * ```
1203
1249
  */
1204
1250
  interface VerdocsSelectInput {
1205
1251
  /**
@@ -1220,12 +1266,18 @@ export namespace Components {
1220
1266
  "value": string;
1221
1267
  }
1222
1268
  /**
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.
1269
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
1270
+ * that because most applications have custom workflow requirements to trigger after sending an
1271
+ * Envelope, this component does not actually perform that operation. Parent applications should
1272
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
1273
+ * `createEnvelope()` call in JS-SDK.
1274
+ * Host applications should ensure the template is "sendable" before displaying this component.
1275
+ * To be sendable, a template must have at least one document attached, at least one participant
1276
+ * defined, and at least one field assigned to every "signer" participant. This component will
1277
+ * hide itself if the template is not sendable.
1278
+ * ```ts
1279
+ * <verdocs-send templateId={templateId} />
1280
+ * ```
1229
1281
  */
1230
1282
  interface VerdocsSend {
1231
1283
  /**
@@ -1246,6 +1298,9 @@ export namespace Components {
1246
1298
  * Display a template preview experience. This will display the template's attached
1247
1299
  * documents with signing fields overlaid on each page. Fields will be color-coded
1248
1300
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
1301
+ * ```ts
1302
+ * <verdocs-settings />
1303
+ * ```
1249
1304
  */
1250
1305
  interface VerdocsSettings {
1251
1306
  /**
@@ -1334,6 +1389,9 @@ export namespace Components {
1334
1389
  }
1335
1390
  /**
1336
1391
  * Display a small loading spinner.
1392
+ * ```ts
1393
+ * <verdocs-spinner />
1394
+ * ```
1337
1395
  */
1338
1396
  interface VerdocsSpinner {
1339
1397
  "mode": 'light' | 'dark';
@@ -1367,6 +1425,9 @@ export namespace Components {
1367
1425
  /**
1368
1426
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
1369
1427
  * support creating interactive table layouts.
1428
+ * ```ts
1429
+ * <verdocs-table columns={[...columns]} data={[...data]} />
1430
+ * ```
1370
1431
  */
1371
1432
  interface VerdocsTable {
1372
1433
  /**
@@ -1381,6 +1442,9 @@ export namespace Components {
1381
1442
  /**
1382
1443
  * Display a simple row of selectable tabs. This is a controlled element.
1383
1444
  * The parent must adjust selectedTab as selection events are fired.
1445
+ * ```ts
1446
+ * <verdocs-tabs tabs={[...tabs]} />
1447
+ * ```
1384
1448
  */
1385
1449
  interface VerdocsTabs {
1386
1450
  /**
@@ -1684,7 +1748,10 @@ export namespace Components {
1684
1748
  /**
1685
1749
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
1686
1750
  * 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.
1751
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
1752
+ * ```ts
1753
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
1754
+ * ```
1688
1755
  */
1689
1756
  interface VerdocsTextInput {
1690
1757
  /**
@@ -1729,7 +1796,10 @@ export namespace Components {
1729
1796
  "value": string;
1730
1797
  }
1731
1798
  /**
1732
- * Displays a label and a set of buttons, also allowing a default selection of a button
1799
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
1800
+ * ```ts
1801
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
1802
+ * ```
1733
1803
  */
1734
1804
  interface VerdocsToggle {
1735
1805
  /**
@@ -1743,6 +1813,9 @@ export namespace Components {
1743
1813
  }
1744
1814
  /**
1745
1815
  * Displays a single button that can be toggled on or off by clicking it.
1816
+ * ```ts
1817
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
1818
+ * ```
1746
1819
  */
1747
1820
  interface VerdocsToggleButton {
1748
1821
  "active": boolean;
@@ -1761,6 +1834,9 @@ export namespace Components {
1761
1834
  }
1762
1835
  /**
1763
1836
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
1837
+ * ```ts
1838
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
1839
+ * ```
1764
1840
  */
1765
1841
  interface VerdocsToolbarIcon {
1766
1842
  /**
@@ -1893,10 +1969,6 @@ export interface VerdocsFileChooserCustomEvent<T> extends CustomEvent<T> {
1893
1969
  detail: T;
1894
1970
  target: HTMLVerdocsFileChooserElement;
1895
1971
  }
1896
- export interface VerdocsFloatingMenuCustomEvent<T> extends CustomEvent<T> {
1897
- detail: T;
1898
- target: HTMLVerdocsFloatingMenuElement;
1899
- }
1900
1972
  export interface VerdocsInitialDialogCustomEvent<T> extends CustomEvent<T> {
1901
1973
  detail: T;
1902
1974
  target: HTMLVerdocsInitialDialogElement;
@@ -2071,26 +2143,15 @@ declare global {
2071
2143
  "sdkError": SDKError;
2072
2144
  }
2073
2145
  /**
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
2146
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
2147
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
2148
+ * host application to render the next appropriate view for the application.
2149
+ * To simplify UI development, a visibility flag can force this component to never display. This
2150
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
2080
2151
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
2081
2152
  * 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
- * }
2153
+ * ```ts
2154
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
2094
2155
  * ```
2095
2156
  */
2096
2157
  interface HTMLVerdocsAuthElement extends Components.VerdocsAuth, HTMLStencilElement {
@@ -2117,6 +2178,9 @@ declare global {
2117
2178
  }
2118
2179
  /**
2119
2180
  * Display a template building experience.
2181
+ * ```ts
2182
+ * <verdocs-build templateId={templateId} />
2183
+ * ```
2120
2184
  */
2121
2185
  interface HTMLVerdocsBuildElement extends Components.VerdocsBuild, HTMLStencilElement {
2122
2186
  addEventListener<K extends keyof HTMLVerdocsBuildElementEventMap>(type: K, listener: (this: HTMLVerdocsBuildElement, ev: VerdocsBuildCustomEvent<HTMLVerdocsBuildElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2133,9 +2197,9 @@ declare global {
2133
2197
  new (): HTMLVerdocsBuildElement;
2134
2198
  };
2135
2199
  /**
2136
- * A simple button
2137
- * ```jsx
2138
- * <verdocs-button label="Click Me" />
2200
+ * A simple button, with consistent styling to other controls in the design system.
2201
+ * ```ts
2202
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
2139
2203
  * ```
2140
2204
  */
2141
2205
  interface HTMLVerdocsButtonElement extends Components.VerdocsButton, HTMLStencilElement {
@@ -2147,6 +2211,17 @@ declare global {
2147
2211
  /**
2148
2212
  * Display an icon button that triggers a drop-down panel that can display
2149
2213
  * arbitrary child content, such as metadata, forms, or other controls.
2214
+ * ```ts
2215
+ * <verdocs-button-panel .icon=${icon}>
2216
+ * <h6>Field Settings</h6>
2217
+ * <form>
2218
+ * <p>
2219
+ * <label>Field Name</label>
2220
+ * <input type="text" placeholder="Field Name..." />
2221
+ * </p>
2222
+ * </form>
2223
+ * </verdocs-button-panel>
2224
+ * ```
2150
2225
  */
2151
2226
  interface HTMLVerdocsButtonPanelElement extends Components.VerdocsButtonPanel, HTMLStencilElement {
2152
2227
  }
@@ -2160,7 +2235,7 @@ declare global {
2160
2235
  * box for UI displays e.g. dialog boxes.
2161
2236
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
2162
2237
  * handler. Sample usage:
2163
- * ```html
2238
+ * ```ts
2164
2239
  * <verdocs-checkbox
2165
2240
  * value="on"
2166
2241
  * name="thingEnabled"
@@ -2237,7 +2312,7 @@ declare global {
2237
2312
  /**
2238
2313
  * 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
2314
  * 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
2315
+ * ```ts
2241
2316
  * <verdocs-dropdown
2242
2317
  * options={[
2243
2318
  * {label: 'Option 1', disabled: true},
@@ -2383,7 +2458,7 @@ declare global {
2383
2458
  interface HTMLVerdocsFieldAttachmentElementEventMap {
2384
2459
  "settingsChanged": {fieldName: string; settings: ITemplateFieldSetting; field: ITemplateField};
2385
2460
  "deleted": {fieldName: string};
2386
- "attached": {data: string; lastModified: number; name: string; size: number; type: string};
2461
+ "attached": ISelectedFile;
2387
2462
  }
2388
2463
  /**
2389
2464
  * Displays an attachment field.
@@ -2451,8 +2526,7 @@ declare global {
2451
2526
  "deleted": {fieldName: string};
2452
2527
  }
2453
2528
  /**
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.
2529
+ * Displays a dropdown field that allows the user to choose one of a list of options.
2456
2530
  */
2457
2531
  interface HTMLVerdocsFieldDropdownElement extends Components.VerdocsFieldDropdown, HTMLStencilElement {
2458
2532
  addEventListener<K extends keyof HTMLVerdocsFieldDropdownElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldDropdownElement, ev: VerdocsFieldDropdownCustomEvent<HTMLVerdocsFieldDropdownElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2477,8 +2551,12 @@ declare global {
2477
2551
  "deleted": {fieldName: string};
2478
2552
  }
2479
2553
  /**
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.
2554
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
2555
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
2556
+ * show a dialog to adopt an initial.
2557
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
2558
+ * This requires operation against a live, valid envelope. If you are testing this component
2559
+ * in Storybook, it will not be visible here.
2482
2560
  */
2483
2561
  interface HTMLVerdocsFieldInitialElement extends Components.VerdocsFieldInitial, HTMLStencilElement {
2484
2562
  addEventListener<K extends keyof HTMLVerdocsFieldInitialElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldInitialElement, ev: VerdocsFieldInitialCustomEvent<HTMLVerdocsFieldInitialElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2546,8 +2624,12 @@ declare global {
2546
2624
  "deleted": {fieldName: string};
2547
2625
  }
2548
2626
  /**
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.
2627
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
2628
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
2629
+ * show a dialog to adopt a signature.
2630
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
2631
+ * This requires operation against a live, valid envelope. If you are testing this component
2632
+ * in Storybook, it will not be visible here.
2551
2633
  */
2552
2634
  interface HTMLVerdocsFieldSignatureElement extends Components.VerdocsFieldSignature, HTMLStencilElement {
2553
2635
  addEventListener<K extends keyof HTMLVerdocsFieldSignatureElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldSignatureElement, ev: VerdocsFieldSignatureCustomEvent<HTMLVerdocsFieldSignatureElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2568,7 +2650,8 @@ declare global {
2568
2650
  "deleted": {fieldName: string};
2569
2651
  }
2570
2652
  /**
2571
- * Display a multi-line text input field.
2653
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
2654
+ * as the BOTTOM-LEFT corner.
2572
2655
  */
2573
2656
  interface HTMLVerdocsFieldTextareaElement extends Components.VerdocsFieldTextarea, HTMLStencilElement {
2574
2657
  addEventListener<K extends keyof HTMLVerdocsFieldTextareaElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldTextareaElement, ev: VerdocsFieldTextareaCustomEvent<HTMLVerdocsFieldTextareaElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2589,7 +2672,7 @@ declare global {
2589
2672
  "deleted": {fieldName: string};
2590
2673
  }
2591
2674
  /**
2592
- * Display a text input field.
2675
+ * Display a simple 1-line text input field.
2593
2676
  */
2594
2677
  interface HTMLVerdocsFieldTextboxElement extends Components.VerdocsFieldTextbox, HTMLStencilElement {
2595
2678
  addEventListener<K extends keyof HTMLVerdocsFieldTextboxElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldTextboxElement, ev: VerdocsFieldTextboxCustomEvent<HTMLVerdocsFieldTextboxElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2610,7 +2693,8 @@ declare global {
2610
2693
  "deleted": {fieldName: string};
2611
2694
  }
2612
2695
  /**
2613
- * Display a timestamp field.
2696
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
2697
+ * filled when the signer submits the document.
2614
2698
  */
2615
2699
  interface HTMLVerdocsFieldTimestampElement extends Components.VerdocsFieldTimestamp, HTMLStencilElement {
2616
2700
  addEventListener<K extends keyof HTMLVerdocsFieldTimestampElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldTimestampElement, ev: VerdocsFieldTimestampCustomEvent<HTMLVerdocsFieldTimestampElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2632,6 +2716,9 @@ declare global {
2632
2716
  /**
2633
2717
  * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
2634
2718
  * provide the actual upload functionality.
2719
+ * ```ts
2720
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
2721
+ * ```
2635
2722
  */
2636
2723
  interface HTMLVerdocsFileChooserElement extends Components.VerdocsFileChooser, HTMLStencilElement {
2637
2724
  addEventListener<K extends keyof HTMLVerdocsFileChooserElementEventMap>(type: K, listener: (this: HTMLVerdocsFileChooserElement, ev: VerdocsFileChooserCustomEvent<HTMLVerdocsFileChooserElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2647,30 +2734,11 @@ declare global {
2647
2734
  prototype: HTMLVerdocsFileChooserElement;
2648
2735
  new (): HTMLVerdocsFileChooserElement;
2649
2736
  };
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
2737
  /**
2673
2738
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
2739
+ * ```ts
2740
+ * <verdocs-help-icon text="Sample help text" />
2741
+ * ```
2674
2742
  */
2675
2743
  interface HTMLVerdocsHelpIconElement extends Components.VerdocsHelpIcon, HTMLStencilElement {
2676
2744
  }
@@ -2705,9 +2773,7 @@ declare global {
2705
2773
  "next": string;
2706
2774
  }
2707
2775
  /**
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.
2776
+ * Prompt the user to confirm their identity with a series of questions.
2711
2777
  */
2712
2778
  interface HTMLVerdocsKbaDialogElement extends Components.VerdocsKbaDialog, HTMLStencilElement {
2713
2779
  addEventListener<K extends keyof HTMLVerdocsKbaDialogElementEventMap>(type: K, listener: (this: HTMLVerdocsKbaDialogElement, ev: VerdocsKbaDialogCustomEvent<HTMLVerdocsKbaDialogElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2725,6 +2791,9 @@ declare global {
2725
2791
  };
2726
2792
  /**
2727
2793
  * Animated loader placeholder. There are currently no configuration options for this control.
2794
+ * ```ts
2795
+ * <verdocs-loader />
2796
+ * ```
2728
2797
  */
2729
2798
  interface HTMLVerdocsLoaderElement extends Components.VerdocsLoader, HTMLStencilElement {
2730
2799
  }
@@ -2756,7 +2825,10 @@ declare global {
2756
2825
  new (): HTMLVerdocsOkDialogElement;
2757
2826
  };
2758
2827
  /**
2759
- * Display a small summary card describing an organization
2828
+ * Display a small summary card describing an organization.
2829
+ * ```ts
2830
+ * <verdocs-organization-card organization={organization} />
2831
+ * ```
2760
2832
  */
2761
2833
  interface HTMLVerdocsOrganizationCardElement extends Components.VerdocsOrganizationCard, HTMLStencilElement {
2762
2834
  }
@@ -2769,6 +2841,14 @@ declare global {
2769
2841
  }
2770
2842
  /**
2771
2843
  * Display a simple pagination control with individual buttons to move through the data set.
2844
+ * ```ts
2845
+ * <verdocs-pagination
2846
+ * selectedPage={1}
2847
+ * itemCount={50}
2848
+ * perPage={10}
2849
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
2850
+ * />
2851
+ * ```
2772
2852
  */
2773
2853
  interface HTMLVerdocsPaginationElement extends Components.VerdocsPagination, HTMLStencilElement {
2774
2854
  addEventListener<K extends keyof HTMLVerdocsPaginationElementEventMap>(type: K, listener: (this: HTMLVerdocsPaginationElement, ev: VerdocsPaginationCustomEvent<HTMLVerdocsPaginationElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2794,6 +2874,16 @@ declare global {
2794
2874
  * technique. This has been altered in a few ways to make it more friendly
2795
2875
  * to cases where there may be multiple portals on the page and provide more
2796
2876
  * alignment options for the child to be displayed.
2877
+ * ```ts
2878
+ * <div style="padding: 40px">
2879
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
2880
+ * Tooltip Anchor
2881
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
2882
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
2883
+ * </verdocs-portal>
2884
+ * </div>
2885
+ * </div>
2886
+ * ```
2797
2887
  */
2798
2888
  interface HTMLVerdocsPortalElement extends Components.VerdocsPortal, HTMLStencilElement {
2799
2889
  addEventListener<K extends keyof HTMLVerdocsPortalElementEventMap>(type: K, listener: (this: HTMLVerdocsPortalElement, ev: VerdocsPortalCustomEvent<HTMLVerdocsPortalElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2816,6 +2906,9 @@ declare global {
2816
2906
  * Display a template preview experience. This will display the template's attached
2817
2907
  * documents with signing fields overlaid on each page. Fields will be color-coded
2818
2908
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
2909
+ * ```ts
2910
+ * <verdocs-preview templateId={templateId} />
2911
+ * ```
2819
2912
  */
2820
2913
  interface HTMLVerdocsPreviewElement extends Components.VerdocsPreview, HTMLStencilElement {
2821
2914
  addEventListener<K extends keyof HTMLVerdocsPreviewElementEventMap>(type: K, listener: (this: HTMLVerdocsPreviewElement, ev: VerdocsPreviewCustomEvent<HTMLVerdocsPreviewElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2832,7 +2925,10 @@ declare global {
2832
2925
  new (): HTMLVerdocsPreviewElement;
2833
2926
  };
2834
2927
  /**
2835
- * A simple progress bar.
2928
+ * Display a simple progress bar in a style consistent with the design system.
2929
+ * ```ts
2930
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
2931
+ * ```
2836
2932
  */
2837
2933
  interface HTMLVerdocsProgressBarElement extends Components.VerdocsProgressBar, HTMLStencilElement {
2838
2934
  }
@@ -2845,6 +2941,9 @@ declare global {
2845
2941
  }
2846
2942
  /**
2847
2943
  * Display a drop-down menu of quick filter options.
2944
+ * ```ts
2945
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
2946
+ * ```
2848
2947
  */
2849
2948
  interface HTMLVerdocsQuickFilterElement extends Components.VerdocsQuickFilter, HTMLStencilElement {
2850
2949
  addEventListener<K extends keyof HTMLVerdocsQuickFilterElementEventMap>(type: K, listener: (this: HTMLVerdocsQuickFilterElement, ev: VerdocsQuickFilterCustomEvent<HTMLVerdocsQuickFilterElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2889,7 +2988,7 @@ declare global {
2889
2988
  * simple radio button for UI displays e.g. dialog boxes.
2890
2989
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
2891
2990
  * handler. Sample usage:
2892
- * ```html
2991
+ * ```ts
2893
2992
  * <verdocs-radio-button
2894
2993
  * value="val1"
2895
2994
  * name="someProperty"
@@ -2944,7 +3043,11 @@ declare global {
2944
3043
  /**
2945
3044
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
2946
3045
  * 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.
3046
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
3047
+ * ```ts
3048
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
3049
+ * @input ={() => {}} />
3050
+ * ```
2948
3051
  */
2949
3052
  interface HTMLVerdocsSelectInputElement extends Components.VerdocsSelectInput, HTMLStencilElement {
2950
3053
  }
@@ -2960,12 +3063,18 @@ declare global {
2960
3063
  "searchContacts": IContactSearchEvent1;
2961
3064
  }
2962
3065
  /**
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.
3066
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
3067
+ * that because most applications have custom workflow requirements to trigger after sending an
3068
+ * Envelope, this component does not actually perform that operation. Parent applications should
3069
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
3070
+ * `createEnvelope()` call in JS-SDK.
3071
+ * Host applications should ensure the template is "sendable" before displaying this component.
3072
+ * To be sendable, a template must have at least one document attached, at least one participant
3073
+ * defined, and at least one field assigned to every "signer" participant. This component will
3074
+ * hide itself if the template is not sendable.
3075
+ * ```ts
3076
+ * <verdocs-send templateId={templateId} />
3077
+ * ```
2969
3078
  */
2970
3079
  interface HTMLVerdocsSendElement extends Components.VerdocsSend, HTMLStencilElement {
2971
3080
  addEventListener<K extends keyof HTMLVerdocsSendElementEventMap>(type: K, listener: (this: HTMLVerdocsSendElement, ev: VerdocsSendCustomEvent<HTMLVerdocsSendElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2988,6 +3097,9 @@ declare global {
2988
3097
  * Display a template preview experience. This will display the template's attached
2989
3098
  * documents with signing fields overlaid on each page. Fields will be color-coded
2990
3099
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
3100
+ * ```ts
3101
+ * <verdocs-settings />
3102
+ * ```
2991
3103
  */
2992
3104
  interface HTMLVerdocsSettingsElement extends Components.VerdocsSettings, HTMLStencilElement {
2993
3105
  addEventListener<K extends keyof HTMLVerdocsSettingsElementEventMap>(type: K, listener: (this: HTMLVerdocsSettingsElement, ev: VerdocsSettingsCustomEvent<HTMLVerdocsSettingsElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3149,6 +3261,9 @@ declare global {
3149
3261
  };
3150
3262
  /**
3151
3263
  * Display a small loading spinner.
3264
+ * ```ts
3265
+ * <verdocs-spinner />
3266
+ * ```
3152
3267
  */
3153
3268
  interface HTMLVerdocsSpinnerElement extends Components.VerdocsSpinner, HTMLStencilElement {
3154
3269
  }
@@ -3176,6 +3291,9 @@ declare global {
3176
3291
  /**
3177
3292
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
3178
3293
  * support creating interactive table layouts.
3294
+ * ```ts
3295
+ * <verdocs-table columns={[...columns]} data={[...data]} />
3296
+ * ```
3179
3297
  */
3180
3298
  interface HTMLVerdocsTableElement extends Components.VerdocsTable, HTMLStencilElement {
3181
3299
  addEventListener<K extends keyof HTMLVerdocsTableElementEventMap>(type: K, listener: (this: HTMLVerdocsTableElement, ev: VerdocsTableCustomEvent<HTMLVerdocsTableElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3197,6 +3315,9 @@ declare global {
3197
3315
  /**
3198
3316
  * Display a simple row of selectable tabs. This is a controlled element.
3199
3317
  * The parent must adjust selectedTab as selection events are fired.
3318
+ * ```ts
3319
+ * <verdocs-tabs tabs={[...tabs]} />
3320
+ * ```
3200
3321
  */
3201
3322
  interface HTMLVerdocsTabsElement extends Components.VerdocsTabs, HTMLStencilElement {
3202
3323
  addEventListener<K extends keyof HTMLVerdocsTabsElementEventMap>(type: K, listener: (this: HTMLVerdocsTabsElement, ev: VerdocsTabsCustomEvent<HTMLVerdocsTabsElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3552,7 +3673,10 @@ declare global {
3552
3673
  /**
3553
3674
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
3554
3675
  * 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.
3676
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
3677
+ * ```ts
3678
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
3679
+ * ```
3556
3680
  */
3557
3681
  interface HTMLVerdocsTextInputElement extends Components.VerdocsTextInput, HTMLStencilElement {
3558
3682
  }
@@ -3561,7 +3685,10 @@ declare global {
3561
3685
  new (): HTMLVerdocsTextInputElement;
3562
3686
  };
3563
3687
  /**
3564
- * Displays a label and a set of buttons, also allowing a default selection of a button
3688
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
3689
+ * ```ts
3690
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
3691
+ * ```
3565
3692
  */
3566
3693
  interface HTMLVerdocsToggleElement extends Components.VerdocsToggle, HTMLStencilElement {
3567
3694
  }
@@ -3574,6 +3701,9 @@ declare global {
3574
3701
  }
3575
3702
  /**
3576
3703
  * Displays a single button that can be toggled on or off by clicking it.
3704
+ * ```ts
3705
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
3706
+ * ```
3577
3707
  */
3578
3708
  interface HTMLVerdocsToggleButtonElement extends Components.VerdocsToggleButton, HTMLStencilElement {
3579
3709
  addEventListener<K extends keyof HTMLVerdocsToggleButtonElementEventMap>(type: K, listener: (this: HTMLVerdocsToggleButtonElement, ev: VerdocsToggleButtonCustomEvent<HTMLVerdocsToggleButtonElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3591,6 +3721,9 @@ declare global {
3591
3721
  };
3592
3722
  /**
3593
3723
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
3724
+ * ```ts
3725
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
3726
+ * ```
3594
3727
  */
3595
3728
  interface HTMLVerdocsToolbarIconElement extends Components.VerdocsToolbarIcon, HTMLStencilElement {
3596
3729
  }
@@ -3673,7 +3806,6 @@ declare global {
3673
3806
  "verdocs-field-textbox": HTMLVerdocsFieldTextboxElement;
3674
3807
  "verdocs-field-timestamp": HTMLVerdocsFieldTimestampElement;
3675
3808
  "verdocs-file-chooser": HTMLVerdocsFileChooserElement;
3676
- "verdocs-floating-menu": HTMLVerdocsFloatingMenuElement;
3677
3809
  "verdocs-help-icon": HTMLVerdocsHelpIconElement;
3678
3810
  "verdocs-initial-dialog": HTMLVerdocsInitialDialogElement;
3679
3811
  "verdocs-kba-dialog": HTMLVerdocsKbaDialogElement;
@@ -3764,26 +3896,15 @@ declare namespace LocalJSX {
3764
3896
  "view"?: 'completed' | 'action' | 'waiting';
3765
3897
  }
3766
3898
  /**
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
3899
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
3900
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
3901
+ * host application to render the next appropriate view for the application.
3902
+ * To simplify UI development, a visibility flag can force this component to never display. This
3903
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
3773
3904
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
3774
3905
  * 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
- * }
3906
+ * ```ts
3907
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
3787
3908
  * ```
3788
3909
  */
3789
3910
  interface VerdocsAuth {
@@ -3796,7 +3917,7 @@ declare namespace LocalJSX {
3796
3917
  */
3797
3918
  "logo"?: string;
3798
3919
  /**
3799
- * Event fired when session authentication process has completed. Check the event contents for completion status.
3920
+ * 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
3921
  */
3801
3922
  "onAuthenticated"?: (event: VerdocsAuthCustomEvent<IAuthStatus>) => void;
3802
3923
  /**
@@ -3810,6 +3931,9 @@ declare namespace LocalJSX {
3810
3931
  }
3811
3932
  /**
3812
3933
  * Display a template building experience.
3934
+ * ```ts
3935
+ * <verdocs-build templateId={templateId} />
3936
+ * ```
3813
3937
  */
3814
3938
  interface VerdocsBuild {
3815
3939
  /**
@@ -3850,9 +3974,9 @@ declare namespace LocalJSX {
3850
3974
  "templateId"?: string | null;
3851
3975
  }
3852
3976
  /**
3853
- * A simple button
3854
- * ```jsx
3855
- * <verdocs-button label="Click Me" />
3977
+ * A simple button, with consistent styling to other controls in the design system.
3978
+ * ```ts
3979
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
3856
3980
  * ```
3857
3981
  */
3858
3982
  interface VerdocsButton {
@@ -3888,6 +4012,17 @@ declare namespace LocalJSX {
3888
4012
  /**
3889
4013
  * Display an icon button that triggers a drop-down panel that can display
3890
4014
  * arbitrary child content, such as metadata, forms, or other controls.
4015
+ * ```ts
4016
+ * <verdocs-button-panel .icon=${icon}>
4017
+ * <h6>Field Settings</h6>
4018
+ * <form>
4019
+ * <p>
4020
+ * <label>Field Name</label>
4021
+ * <input type="text" placeholder="Field Name..." />
4022
+ * </p>
4023
+ * </form>
4024
+ * </verdocs-button-panel>
4025
+ * ```
3891
4026
  */
3892
4027
  interface VerdocsButtonPanel {
3893
4028
  /**
@@ -3901,7 +4036,7 @@ declare namespace LocalJSX {
3901
4036
  * box for UI displays e.g. dialog boxes.
3902
4037
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
3903
4038
  * handler. Sample usage:
3904
- * ```html
4039
+ * ```ts
3905
4040
  * <verdocs-checkbox
3906
4041
  * value="on"
3907
4042
  * name="thingEnabled"
@@ -3991,7 +4126,7 @@ declare namespace LocalJSX {
3991
4126
  /**
3992
4127
  * 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
4128
  * 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
4129
+ * ```ts
3995
4130
  * <verdocs-dropdown
3996
4131
  * options={[
3997
4132
  * {label: 'Option 1', disabled: true},
@@ -4231,6 +4366,10 @@ declare namespace LocalJSX {
4231
4366
  * 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
4367
  */
4233
4368
  "editable"?: boolean;
4369
+ /**
4370
+ * 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.
4371
+ */
4372
+ "endpoint"?: VerdocsEndpoint;
4234
4373
  /**
4235
4374
  * The name of the field to display.
4236
4375
  */
@@ -4242,7 +4381,7 @@ declare namespace LocalJSX {
4242
4381
  /**
4243
4382
  * Event fired when the field is deleted.
4244
4383
  */
4245
- "onAttached"?: (event: VerdocsFieldAttachmentCustomEvent<{data: string; lastModified: number; name: string; size: number; type: string}>) => void;
4384
+ "onAttached"?: (event: VerdocsFieldAttachmentCustomEvent<ISelectedFile>) => void;
4246
4385
  /**
4247
4386
  * Event fired when the field is deleted.
4248
4387
  */
@@ -4379,8 +4518,7 @@ declare namespace LocalJSX {
4379
4518
  "yscale"?: number;
4380
4519
  }
4381
4520
  /**
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.
4521
+ * Displays a dropdown field that allows the user to choose one of a list of options.
4384
4522
  */
4385
4523
  interface VerdocsFieldDropdown {
4386
4524
  /**
@@ -4433,8 +4571,12 @@ declare namespace LocalJSX {
4433
4571
  "yscale"?: number;
4434
4572
  }
4435
4573
  /**
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.
4574
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
4575
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
4576
+ * show a dialog to adopt an initial.
4577
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
4578
+ * This requires operation against a live, valid envelope. If you are testing this component
4579
+ * in Storybook, it will not be visible here.
4438
4580
  */
4439
4581
  interface VerdocsFieldInitial {
4440
4582
  /**
@@ -4610,8 +4752,12 @@ declare namespace LocalJSX {
4610
4752
  "yscale"?: number;
4611
4753
  }
4612
4754
  /**
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.
4755
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
4756
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
4757
+ * show a dialog to adopt a signature.
4758
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
4759
+ * This requires operation against a live, valid envelope. If you are testing this component
4760
+ * in Storybook, it will not be visible here.
4615
4761
  */
4616
4762
  interface VerdocsFieldSignature {
4617
4763
  /**
@@ -4672,7 +4818,8 @@ declare namespace LocalJSX {
4672
4818
  "yscale"?: number;
4673
4819
  }
4674
4820
  /**
4675
- * Display a multi-line text input field.
4821
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
4822
+ * as the BOTTOM-LEFT corner.
4676
4823
  */
4677
4824
  interface VerdocsFieldTextarea {
4678
4825
  /**
@@ -4725,7 +4872,7 @@ declare namespace LocalJSX {
4725
4872
  "yscale"?: number;
4726
4873
  }
4727
4874
  /**
4728
- * Display a text input field.
4875
+ * Display a simple 1-line text input field.
4729
4876
  */
4730
4877
  interface VerdocsFieldTextbox {
4731
4878
  /**
@@ -4778,7 +4925,8 @@ declare namespace LocalJSX {
4778
4925
  "yscale"?: number;
4779
4926
  }
4780
4927
  /**
4781
- * Display a timestamp field.
4928
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
4929
+ * filled when the signer submits the document.
4782
4930
  */
4783
4931
  interface VerdocsFieldTimestamp {
4784
4932
  /**
@@ -4829,6 +4977,9 @@ declare namespace LocalJSX {
4829
4977
  /**
4830
4978
  * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
4831
4979
  * provide the actual upload functionality.
4980
+ * ```ts
4981
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
4982
+ * ```
4832
4983
  */
4833
4984
  interface VerdocsFileChooser {
4834
4985
  /**
@@ -4840,23 +4991,11 @@ declare namespace LocalJSX {
4840
4991
  */
4841
4992
  "onFileSelected"?: (event: VerdocsFileChooserCustomEvent<{file: File | null}>) => void;
4842
4993
  }
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
4994
  /**
4859
4995
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
4996
+ * ```ts
4997
+ * <verdocs-help-icon text="Sample help text" />
4998
+ * ```
4860
4999
  */
4861
5000
  interface VerdocsHelpIcon {
4862
5001
  /**
@@ -4887,9 +5026,7 @@ declare namespace LocalJSX {
4887
5026
  "onNext"?: (event: VerdocsInitialDialogCustomEvent<string>) => void;
4888
5027
  }
4889
5028
  /**
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.
5029
+ * Prompt the user to confirm their identity with a series of questions.
4893
5030
  */
4894
5031
  interface VerdocsKbaDialog {
4895
5032
  /**
@@ -4935,6 +5072,9 @@ declare namespace LocalJSX {
4935
5072
  }
4936
5073
  /**
4937
5074
  * Animated loader placeholder. There are currently no configuration options for this control.
5075
+ * ```ts
5076
+ * <verdocs-loader />
5077
+ * ```
4938
5078
  */
4939
5079
  interface VerdocsLoader {
4940
5080
  }
@@ -4970,7 +5110,10 @@ declare namespace LocalJSX {
4970
5110
  "showCancel"?: boolean;
4971
5111
  }
4972
5112
  /**
4973
- * Display a small summary card describing an organization
5113
+ * Display a small summary card describing an organization.
5114
+ * ```ts
5115
+ * <verdocs-organization-card organization={organization} />
5116
+ * ```
4974
5117
  */
4975
5118
  interface VerdocsOrganizationCard {
4976
5119
  /**
@@ -4980,6 +5123,14 @@ declare namespace LocalJSX {
4980
5123
  }
4981
5124
  /**
4982
5125
  * Display a simple pagination control with individual buttons to move through the data set.
5126
+ * ```ts
5127
+ * <verdocs-pagination
5128
+ * selectedPage={1}
5129
+ * itemCount={50}
5130
+ * perPage={10}
5131
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
5132
+ * />
5133
+ * ```
4983
5134
  */
4984
5135
  interface VerdocsPagination {
4985
5136
  /**
@@ -5006,6 +5157,16 @@ declare namespace LocalJSX {
5006
5157
  * technique. This has been altered in a few ways to make it more friendly
5007
5158
  * to cases where there may be multiple portals on the page and provide more
5008
5159
  * alignment options for the child to be displayed.
5160
+ * ```ts
5161
+ * <div style="padding: 40px">
5162
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
5163
+ * Tooltip Anchor
5164
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
5165
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
5166
+ * </verdocs-portal>
5167
+ * </div>
5168
+ * </div>
5169
+ * ```
5009
5170
  */
5010
5171
  interface VerdocsPortal {
5011
5172
  /**
@@ -5026,6 +5187,9 @@ declare namespace LocalJSX {
5026
5187
  * Display a template preview experience. This will display the template's attached
5027
5188
  * documents with signing fields overlaid on each page. Fields will be color-coded
5028
5189
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
5190
+ * ```ts
5191
+ * <verdocs-preview templateId={templateId} />
5192
+ * ```
5029
5193
  */
5030
5194
  interface VerdocsPreview {
5031
5195
  /**
@@ -5042,7 +5206,10 @@ declare namespace LocalJSX {
5042
5206
  "templateId"?: string | null;
5043
5207
  }
5044
5208
  /**
5045
- * A simple progress bar.
5209
+ * Display a simple progress bar in a style consistent with the design system.
5210
+ * ```ts
5211
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
5212
+ * ```
5046
5213
  */
5047
5214
  interface VerdocsProgressBar {
5048
5215
  /**
@@ -5060,6 +5227,9 @@ declare namespace LocalJSX {
5060
5227
  }
5061
5228
  /**
5062
5229
  * Display a drop-down menu of quick filter options.
5230
+ * ```ts
5231
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
5232
+ * ```
5063
5233
  */
5064
5234
  interface VerdocsQuickFilter {
5065
5235
  "label"?: string;
@@ -5099,7 +5269,7 @@ declare namespace LocalJSX {
5099
5269
  * simple radio button for UI displays e.g. dialog boxes.
5100
5270
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
5101
5271
  * handler. Sample usage:
5102
- * ```html
5272
+ * ```ts
5103
5273
  * <verdocs-radio-button
5104
5274
  * value="val1"
5105
5275
  * name="someProperty"
@@ -5177,7 +5347,11 @@ declare namespace LocalJSX {
5177
5347
  /**
5178
5348
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
5179
5349
  * 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.
5350
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
5351
+ * ```ts
5352
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
5353
+ * @input ={() => {}} />
5354
+ * ```
5181
5355
  */
5182
5356
  interface VerdocsSelectInput {
5183
5357
  /**
@@ -5198,12 +5372,18 @@ declare namespace LocalJSX {
5198
5372
  "value"?: string;
5199
5373
  }
5200
5374
  /**
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.
5375
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
5376
+ * that because most applications have custom workflow requirements to trigger after sending an
5377
+ * Envelope, this component does not actually perform that operation. Parent applications should
5378
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
5379
+ * `createEnvelope()` call in JS-SDK.
5380
+ * Host applications should ensure the template is "sendable" before displaying this component.
5381
+ * To be sendable, a template must have at least one document attached, at least one participant
5382
+ * defined, and at least one field assigned to every "signer" participant. This component will
5383
+ * hide itself if the template is not sendable.
5384
+ * ```ts
5385
+ * <verdocs-send templateId={templateId} />
5386
+ * ```
5207
5387
  */
5208
5388
  interface VerdocsSend {
5209
5389
  /**
@@ -5243,6 +5423,9 @@ declare namespace LocalJSX {
5243
5423
  * Display a template preview experience. This will display the template's attached
5244
5424
  * documents with signing fields overlaid on each page. Fields will be color-coded
5245
5425
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
5426
+ * ```ts
5427
+ * <verdocs-settings />
5428
+ * ```
5246
5429
  */
5247
5430
  interface VerdocsSettings {
5248
5431
  /**
@@ -5403,6 +5586,9 @@ declare namespace LocalJSX {
5403
5586
  }
5404
5587
  /**
5405
5588
  * Display a small loading spinner.
5589
+ * ```ts
5590
+ * <verdocs-spinner />
5591
+ * ```
5406
5592
  */
5407
5593
  interface VerdocsSpinner {
5408
5594
  "mode"?: 'light' | 'dark';
@@ -5436,6 +5622,9 @@ declare namespace LocalJSX {
5436
5622
  /**
5437
5623
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
5438
5624
  * support creating interactive table layouts.
5625
+ * ```ts
5626
+ * <verdocs-table columns={[...columns]} data={[...data]} />
5627
+ * ```
5439
5628
  */
5440
5629
  interface VerdocsTable {
5441
5630
  /**
@@ -5458,6 +5647,9 @@ declare namespace LocalJSX {
5458
5647
  /**
5459
5648
  * Display a simple row of selectable tabs. This is a controlled element.
5460
5649
  * The parent must adjust selectedTab as selection events are fired.
5650
+ * ```ts
5651
+ * <verdocs-tabs tabs={[...tabs]} />
5652
+ * ```
5461
5653
  */
5462
5654
  interface VerdocsTabs {
5463
5655
  /**
@@ -5954,7 +6146,10 @@ declare namespace LocalJSX {
5954
6146
  /**
5955
6147
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
5956
6148
  * 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.
6149
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
6150
+ * ```ts
6151
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
6152
+ * ```
5958
6153
  */
5959
6154
  interface VerdocsTextInput {
5960
6155
  /**
@@ -5999,7 +6194,10 @@ declare namespace LocalJSX {
5999
6194
  "value"?: string;
6000
6195
  }
6001
6196
  /**
6002
- * Displays a label and a set of buttons, also allowing a default selection of a button
6197
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
6198
+ * ```ts
6199
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
6200
+ * ```
6003
6201
  */
6004
6202
  interface VerdocsToggle {
6005
6203
  /**
@@ -6013,6 +6211,9 @@ declare namespace LocalJSX {
6013
6211
  }
6014
6212
  /**
6015
6213
  * Displays a single button that can be toggled on or off by clicking it.
6214
+ * ```ts
6215
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
6216
+ * ```
6016
6217
  */
6017
6218
  interface VerdocsToggleButton {
6018
6219
  "active"?: boolean;
@@ -6035,6 +6236,9 @@ declare namespace LocalJSX {
6035
6236
  }
6036
6237
  /**
6037
6238
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
6239
+ * ```ts
6240
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
6241
+ * ```
6038
6242
  */
6039
6243
  interface VerdocsToolbarIcon {
6040
6244
  /**
@@ -6130,7 +6334,6 @@ declare namespace LocalJSX {
6130
6334
  "verdocs-field-textbox": VerdocsFieldTextbox;
6131
6335
  "verdocs-field-timestamp": VerdocsFieldTimestamp;
6132
6336
  "verdocs-file-chooser": VerdocsFileChooser;
6133
- "verdocs-floating-menu": VerdocsFloatingMenu;
6134
6337
  "verdocs-help-icon": VerdocsHelpIcon;
6135
6338
  "verdocs-initial-dialog": VerdocsInitialDialog;
6136
6339
  "verdocs-kba-dialog": VerdocsKbaDialog;
@@ -6195,43 +6398,46 @@ declare module "@stencil/core" {
6195
6398
  */
6196
6399
  "verdocs-activity-box": LocalJSX.VerdocsActivityBox & JSXBase.HTMLAttributes<HTMLVerdocsActivityBoxElement>;
6197
6400
  /**
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
6401
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
6402
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
6403
+ * host application to render the next appropriate view for the application.
6404
+ * To simplify UI development, a visibility flag can force this component to never display. This
6405
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
6204
6406
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
6205
6407
  * 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
- * }
6408
+ * ```ts
6409
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
6218
6410
  * ```
6219
6411
  */
6220
6412
  "verdocs-auth": LocalJSX.VerdocsAuth & JSXBase.HTMLAttributes<HTMLVerdocsAuthElement>;
6221
6413
  /**
6222
6414
  * Display a template building experience.
6415
+ * ```ts
6416
+ * <verdocs-build templateId={templateId} />
6417
+ * ```
6223
6418
  */
6224
6419
  "verdocs-build": LocalJSX.VerdocsBuild & JSXBase.HTMLAttributes<HTMLVerdocsBuildElement>;
6225
6420
  /**
6226
- * A simple button
6227
- * ```jsx
6228
- * <verdocs-button label="Click Me" />
6421
+ * A simple button, with consistent styling to other controls in the design system.
6422
+ * ```ts
6423
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
6229
6424
  * ```
6230
6425
  */
6231
6426
  "verdocs-button": LocalJSX.VerdocsButton & JSXBase.HTMLAttributes<HTMLVerdocsButtonElement>;
6232
6427
  /**
6233
6428
  * Display an icon button that triggers a drop-down panel that can display
6234
6429
  * arbitrary child content, such as metadata, forms, or other controls.
6430
+ * ```ts
6431
+ * <verdocs-button-panel .icon=${icon}>
6432
+ * <h6>Field Settings</h6>
6433
+ * <form>
6434
+ * <p>
6435
+ * <label>Field Name</label>
6436
+ * <input type="text" placeholder="Field Name..." />
6437
+ * </p>
6438
+ * </form>
6439
+ * </verdocs-button-panel>
6440
+ * ```
6235
6441
  */
6236
6442
  "verdocs-button-panel": LocalJSX.VerdocsButtonPanel & JSXBase.HTMLAttributes<HTMLVerdocsButtonPanelElement>;
6237
6443
  /**
@@ -6240,7 +6446,7 @@ declare module "@stencil/core" {
6240
6446
  * box for UI displays e.g. dialog boxes.
6241
6447
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
6242
6448
  * handler. Sample usage:
6243
- * ```html
6449
+ * ```ts
6244
6450
  * <verdocs-checkbox
6245
6451
  * value="on"
6246
6452
  * name="thingEnabled"
@@ -6270,7 +6476,7 @@ declare module "@stencil/core" {
6270
6476
  /**
6271
6477
  * 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
6478
  * 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
6479
+ * ```ts
6274
6480
  * <verdocs-dropdown
6275
6481
  * options={[
6276
6482
  * {label: 'Option 1', disabled: true},
@@ -6320,13 +6526,16 @@ declare module "@stencil/core" {
6320
6526
  */
6321
6527
  "verdocs-field-date": LocalJSX.VerdocsFieldDate & JSXBase.HTMLAttributes<HTMLVerdocsFieldDateElement>;
6322
6528
  /**
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.
6529
+ * Displays a dropdown field that allows the user to choose one of a list of options.
6325
6530
  */
6326
6531
  "verdocs-field-dropdown": LocalJSX.VerdocsFieldDropdown & JSXBase.HTMLAttributes<HTMLVerdocsFieldDropdownElement>;
6327
6532
  /**
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.
6533
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
6534
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
6535
+ * show a dialog to adopt an initial.
6536
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
6537
+ * This requires operation against a live, valid envelope. If you are testing this component
6538
+ * in Storybook, it will not be visible here.
6330
6539
  */
6331
6540
  "verdocs-field-initial": LocalJSX.VerdocsFieldInitial & JSXBase.HTMLAttributes<HTMLVerdocsFieldInitialElement>;
6332
6541
  /**
@@ -6339,35 +6548,41 @@ declare module "@stencil/core" {
6339
6548
  */
6340
6549
  "verdocs-field-radio-button": LocalJSX.VerdocsFieldRadioButton & JSXBase.HTMLAttributes<HTMLVerdocsFieldRadioButtonElement>;
6341
6550
  /**
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.
6551
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
6552
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
6553
+ * show a dialog to adopt a signature.
6554
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
6555
+ * This requires operation against a live, valid envelope. If you are testing this component
6556
+ * in Storybook, it will not be visible here.
6344
6557
  */
6345
6558
  "verdocs-field-signature": LocalJSX.VerdocsFieldSignature & JSXBase.HTMLAttributes<HTMLVerdocsFieldSignatureElement>;
6346
6559
  /**
6347
- * Display a multi-line text input field.
6560
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
6561
+ * as the BOTTOM-LEFT corner.
6348
6562
  */
6349
6563
  "verdocs-field-textarea": LocalJSX.VerdocsFieldTextarea & JSXBase.HTMLAttributes<HTMLVerdocsFieldTextareaElement>;
6350
6564
  /**
6351
- * Display a text input field.
6565
+ * Display a simple 1-line text input field.
6352
6566
  */
6353
6567
  "verdocs-field-textbox": LocalJSX.VerdocsFieldTextbox & JSXBase.HTMLAttributes<HTMLVerdocsFieldTextboxElement>;
6354
6568
  /**
6355
- * Display a timestamp field.
6569
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
6570
+ * filled when the signer submits the document.
6356
6571
  */
6357
6572
  "verdocs-field-timestamp": LocalJSX.VerdocsFieldTimestamp & JSXBase.HTMLAttributes<HTMLVerdocsFieldTimestampElement>;
6358
6573
  /**
6359
6574
  * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
6360
6575
  * provide the actual upload functionality.
6576
+ * ```ts
6577
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
6578
+ * ```
6361
6579
  */
6362
6580
  "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
6581
  /**
6370
6582
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
6583
+ * ```ts
6584
+ * <verdocs-help-icon text="Sample help text" />
6585
+ * ```
6371
6586
  */
6372
6587
  "verdocs-help-icon": LocalJSX.VerdocsHelpIcon & JSXBase.HTMLAttributes<HTMLVerdocsHelpIconElement>;
6373
6588
  /**
@@ -6376,13 +6591,14 @@ declare module "@stencil/core" {
6376
6591
  */
6377
6592
  "verdocs-initial-dialog": LocalJSX.VerdocsInitialDialog & JSXBase.HTMLAttributes<HTMLVerdocsInitialDialogElement>;
6378
6593
  /**
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.
6594
+ * Prompt the user to confirm their identity with a series of questions.
6382
6595
  */
6383
6596
  "verdocs-kba-dialog": LocalJSX.VerdocsKbaDialog & JSXBase.HTMLAttributes<HTMLVerdocsKbaDialogElement>;
6384
6597
  /**
6385
6598
  * Animated loader placeholder. There are currently no configuration options for this control.
6599
+ * ```ts
6600
+ * <verdocs-loader />
6601
+ * ```
6386
6602
  */
6387
6603
  "verdocs-loader": LocalJSX.VerdocsLoader & JSXBase.HTMLAttributes<HTMLVerdocsLoaderElement>;
6388
6604
  /**
@@ -6392,11 +6608,22 @@ declare module "@stencil/core" {
6392
6608
  */
6393
6609
  "verdocs-ok-dialog": LocalJSX.VerdocsOkDialog & JSXBase.HTMLAttributes<HTMLVerdocsOkDialogElement>;
6394
6610
  /**
6395
- * Display a small summary card describing an organization
6611
+ * Display a small summary card describing an organization.
6612
+ * ```ts
6613
+ * <verdocs-organization-card organization={organization} />
6614
+ * ```
6396
6615
  */
6397
6616
  "verdocs-organization-card": LocalJSX.VerdocsOrganizationCard & JSXBase.HTMLAttributes<HTMLVerdocsOrganizationCardElement>;
6398
6617
  /**
6399
6618
  * Display a simple pagination control with individual buttons to move through the data set.
6619
+ * ```ts
6620
+ * <verdocs-pagination
6621
+ * selectedPage={1}
6622
+ * itemCount={50}
6623
+ * perPage={10}
6624
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
6625
+ * />
6626
+ * ```
6400
6627
  */
6401
6628
  "verdocs-pagination": LocalJSX.VerdocsPagination & JSXBase.HTMLAttributes<HTMLVerdocsPaginationElement>;
6402
6629
  /**
@@ -6406,20 +6633,39 @@ declare module "@stencil/core" {
6406
6633
  * technique. This has been altered in a few ways to make it more friendly
6407
6634
  * to cases where there may be multiple portals on the page and provide more
6408
6635
  * alignment options for the child to be displayed.
6636
+ * ```ts
6637
+ * <div style="padding: 40px">
6638
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
6639
+ * Tooltip Anchor
6640
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
6641
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
6642
+ * </verdocs-portal>
6643
+ * </div>
6644
+ * </div>
6645
+ * ```
6409
6646
  */
6410
6647
  "verdocs-portal": LocalJSX.VerdocsPortal & JSXBase.HTMLAttributes<HTMLVerdocsPortalElement>;
6411
6648
  /**
6412
6649
  * Display a template preview experience. This will display the template's attached
6413
6650
  * documents with signing fields overlaid on each page. Fields will be color-coded
6414
6651
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
6652
+ * ```ts
6653
+ * <verdocs-preview templateId={templateId} />
6654
+ * ```
6415
6655
  */
6416
6656
  "verdocs-preview": LocalJSX.VerdocsPreview & JSXBase.HTMLAttributes<HTMLVerdocsPreviewElement>;
6417
6657
  /**
6418
- * A simple progress bar.
6658
+ * Display a simple progress bar in a style consistent with the design system.
6659
+ * ```ts
6660
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
6661
+ * ```
6419
6662
  */
6420
6663
  "verdocs-progress-bar": LocalJSX.VerdocsProgressBar & JSXBase.HTMLAttributes<HTMLVerdocsProgressBarElement>;
6421
6664
  /**
6422
6665
  * Display a drop-down menu of quick filter options.
6666
+ * ```ts
6667
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
6668
+ * ```
6423
6669
  */
6424
6670
  "verdocs-quick-filter": LocalJSX.VerdocsQuickFilter & JSXBase.HTMLAttributes<HTMLVerdocsQuickFilterElement>;
6425
6671
  /**
@@ -6434,7 +6680,7 @@ declare module "@stencil/core" {
6434
6680
  * simple radio button for UI displays e.g. dialog boxes.
6435
6681
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
6436
6682
  * handler. Sample usage:
6437
- * ```html
6683
+ * ```ts
6438
6684
  * <verdocs-radio-button
6439
6685
  * value="val1"
6440
6686
  * name="someProperty"
@@ -6456,22 +6702,35 @@ declare module "@stencil/core" {
6456
6702
  /**
6457
6703
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
6458
6704
  * 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.
6705
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
6706
+ * ```ts
6707
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
6708
+ * @input ={() => {}} />
6709
+ * ```
6460
6710
  */
6461
6711
  "verdocs-select-input": LocalJSX.VerdocsSelectInput & JSXBase.HTMLAttributes<HTMLVerdocsSelectInputElement>;
6462
6712
  /**
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.
6713
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
6714
+ * that because most applications have custom workflow requirements to trigger after sending an
6715
+ * Envelope, this component does not actually perform that operation. Parent applications should
6716
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
6717
+ * `createEnvelope()` call in JS-SDK.
6718
+ * Host applications should ensure the template is "sendable" before displaying this component.
6719
+ * To be sendable, a template must have at least one document attached, at least one participant
6720
+ * defined, and at least one field assigned to every "signer" participant. This component will
6721
+ * hide itself if the template is not sendable.
6722
+ * ```ts
6723
+ * <verdocs-send templateId={templateId} />
6724
+ * ```
6469
6725
  */
6470
6726
  "verdocs-send": LocalJSX.VerdocsSend & JSXBase.HTMLAttributes<HTMLVerdocsSendElement>;
6471
6727
  /**
6472
6728
  * Display a template preview experience. This will display the template's attached
6473
6729
  * documents with signing fields overlaid on each page. Fields will be color-coded
6474
6730
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
6731
+ * ```ts
6732
+ * <verdocs-settings />
6733
+ * ```
6475
6734
  */
6476
6735
  "verdocs-settings": LocalJSX.VerdocsSettings & JSXBase.HTMLAttributes<HTMLVerdocsSettingsElement>;
6477
6736
  /**
@@ -6513,6 +6772,9 @@ declare module "@stencil/core" {
6513
6772
  "verdocs-signature-dialog": LocalJSX.VerdocsSignatureDialog & JSXBase.HTMLAttributes<HTMLVerdocsSignatureDialogElement>;
6514
6773
  /**
6515
6774
  * Display a small loading spinner.
6775
+ * ```ts
6776
+ * <verdocs-spinner />
6777
+ * ```
6516
6778
  */
6517
6779
  "verdocs-spinner": LocalJSX.VerdocsSpinner & JSXBase.HTMLAttributes<HTMLVerdocsSpinnerElement>;
6518
6780
  /**
@@ -6526,11 +6788,17 @@ declare module "@stencil/core" {
6526
6788
  /**
6527
6789
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
6528
6790
  * support creating interactive table layouts.
6791
+ * ```ts
6792
+ * <verdocs-table columns={[...columns]} data={[...data]} />
6793
+ * ```
6529
6794
  */
6530
6795
  "verdocs-table": LocalJSX.VerdocsTable & JSXBase.HTMLAttributes<HTMLVerdocsTableElement>;
6531
6796
  /**
6532
6797
  * Display a simple row of selectable tabs. This is a controlled element.
6533
6798
  * The parent must adjust selectedTab as selection events are fired.
6799
+ * ```ts
6800
+ * <verdocs-tabs tabs={[...tabs]} />
6801
+ * ```
6534
6802
  */
6535
6803
  "verdocs-tabs": LocalJSX.VerdocsTabs & JSXBase.HTMLAttributes<HTMLVerdocsTabsElement>;
6536
6804
  /**
@@ -6605,19 +6873,31 @@ declare module "@stencil/core" {
6605
6873
  /**
6606
6874
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
6607
6875
  * 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.
6876
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
6877
+ * ```ts
6878
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
6879
+ * ```
6609
6880
  */
6610
6881
  "verdocs-text-input": LocalJSX.VerdocsTextInput & JSXBase.HTMLAttributes<HTMLVerdocsTextInputElement>;
6611
6882
  /**
6612
- * Displays a label and a set of buttons, also allowing a default selection of a button
6883
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
6884
+ * ```ts
6885
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
6886
+ * ```
6613
6887
  */
6614
6888
  "verdocs-toggle": LocalJSX.VerdocsToggle & JSXBase.HTMLAttributes<HTMLVerdocsToggleElement>;
6615
6889
  /**
6616
6890
  * Displays a single button that can be toggled on or off by clicking it.
6891
+ * ```ts
6892
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
6893
+ * ```
6617
6894
  */
6618
6895
  "verdocs-toggle-button": LocalJSX.VerdocsToggleButton & JSXBase.HTMLAttributes<HTMLVerdocsToggleButtonElement>;
6619
6896
  /**
6620
6897
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
6898
+ * ```ts
6899
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
6900
+ * ```
6621
6901
  */
6622
6902
  "verdocs-toolbar-icon": LocalJSX.VerdocsToolbarIcon & JSXBase.HTMLAttributes<HTMLVerdocsToolbarIconElement>;
6623
6903
  /**