@verdocs/web-sdk 4.0.8 → 4.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (527) 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 +20 -20
  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 +16 -19281
  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 +4 -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_2.cjs.entry.js +19374 -0
  29. package/dist/cjs/verdocs-pagination_2.cjs.entry.js +3 -3
  30. package/dist/cjs/verdocs-preview_10.cjs.entry.js +156 -79
  31. package/dist/cjs/verdocs-quick-functions_2.cjs.entry.js +2 -2
  32. package/dist/cjs/verdocs-radio-button_3.cjs.entry.js +12 -12
  33. package/dist/cjs/verdocs-search-tabs.cjs.entry.js +1 -1
  34. package/dist/cjs/verdocs-search.cjs.entry.js +1 -1
  35. package/dist/cjs/verdocs-settings-api-keys_4.cjs.entry.js +11 -24
  36. package/dist/cjs/verdocs-settings.cjs.entry.js +1 -2
  37. package/dist/cjs/verdocs-sign.cjs.entry.js +2 -2
  38. package/dist/cjs/verdocs-spinner.cjs.entry.js +1 -1
  39. package/dist/cjs/verdocs-status-indicator.cjs.entry.js +11 -3
  40. package/dist/cjs/verdocs-tabs.cjs.entry.js +2 -2
  41. package/dist/cjs/verdocs-template-card.cjs.entry.js +1 -1
  42. package/dist/cjs/verdocs-template-document-page_2.cjs.entry.js +210 -0
  43. package/dist/cjs/verdocs-template-star.cjs.entry.js +1 -1
  44. package/dist/cjs/verdocs-template-tags.cjs.entry.js +1 -1
  45. package/dist/cjs/verdocs-templates-list.cjs.entry.js +7 -7
  46. package/dist/cjs/verdocs-toggle.cjs.entry.js +1 -1
  47. package/dist/cjs/verdocs-view.cjs.entry.js +1 -1
  48. package/dist/cjs/verdocs-web-sdk.cjs.js +1 -1
  49. package/dist/collection/collection-manifest.json +0 -1
  50. package/dist/collection/components/controls/verdocs-button/verdocs-button.js +8 -1
  51. package/dist/collection/components/controls/verdocs-button-panel/verdocs-button-panel.js +18 -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 +17 -1
  55. package/dist/collection/components/controls/verdocs-file-chooser/verdocs-file-chooser.js +9 -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 +8 -1
  58. package/dist/collection/components/controls/verdocs-loader/verdocs-loader.js +8 -1
  59. package/dist/collection/components/controls/verdocs-organization-card/verdocs-organization-card.css +26 -22
  60. package/dist/collection/components/controls/verdocs-organization-card/verdocs-organization-card.js +41 -2
  61. package/dist/collection/components/controls/verdocs-pagination/verdocs-pagination.js +13 -1
  62. package/dist/collection/components/controls/verdocs-portal/verdocs-portal.js +21 -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 +9 -1
  65. package/dist/collection/components/controls/verdocs-quick-filter/verdocs-quick-filter.js +5 -1
  66. package/dist/collection/components/controls/verdocs-radio-button/verdocs-radio-button.js +2 -2
  67. package/dist/collection/components/controls/verdocs-select-input/verdocs-select-input.js +6 -2
  68. package/dist/collection/components/controls/verdocs-spinner/verdocs-spinner.js +5 -1
  69. package/dist/collection/components/controls/verdocs-table/verdocs-table.js +7 -5
  70. package/dist/collection/components/controls/verdocs-tabs/verdocs-tabs.css +1 -1
  71. package/dist/collection/components/controls/verdocs-tabs/verdocs-tabs.js +5 -1
  72. package/dist/collection/components/controls/verdocs-text-input/verdocs-text-input.js +7 -3
  73. package/dist/collection/components/controls/verdocs-toggle/verdocs-toggle.js +6 -2
  74. package/dist/collection/components/controls/verdocs-toggle-button/verdocs-toggle-button.js +5 -1
  75. package/dist/collection/components/controls/verdocs-toolbar-icon/verdocs-toolbar-icon.js +5 -1
  76. package/dist/collection/components/dialogs/verdocs-dialog/verdocs-dialog.js +1 -1
  77. package/dist/collection/components/dialogs/verdocs-initial-dialog/verdocs-initial-dialog.js +9 -7
  78. package/dist/collection/components/dialogs/verdocs-kba-dialog/verdocs-kba-dialog.css +11 -0
  79. package/dist/collection/components/dialogs/verdocs-kba-dialog/verdocs-kba-dialog.js +7 -9
  80. package/dist/collection/components/dialogs/verdocs-ok-dialog/verdocs-ok-dialog.css +2 -1
  81. package/dist/collection/components/dialogs/verdocs-ok-dialog/verdocs-ok-dialog.js +1 -1
  82. package/dist/collection/components/dialogs/verdocs-signature-dialog/verdocs-signature-dialog.js +6 -7
  83. package/dist/collection/components/dialogs/verdocs-upload-dialog/verdocs-upload-dialog.js +1 -1
  84. package/dist/collection/components/elements/verdocs-quick-functions/verdocs-quick-functions.js +1 -1
  85. package/dist/collection/components/elements/verdocs-search-box/verdocs-search-box.js +1 -1
  86. package/dist/collection/components/elements/verdocs-search-tabs/verdocs-search-tabs.js +1 -1
  87. package/dist/collection/components/embeds/verdocs-auth/verdocs-auth.js +10 -24
  88. package/dist/collection/components/embeds/verdocs-build/verdocs-build.js +31 -22
  89. package/dist/collection/components/embeds/verdocs-preview/verdocs-preview.js +42 -19
  90. package/dist/collection/components/embeds/verdocs-search/verdocs-search.js +1 -1
  91. package/dist/collection/components/embeds/verdocs-send/verdocs-send.js +85 -36
  92. package/dist/collection/components/embeds/verdocs-settings/verdocs-settings.js +5 -2
  93. package/dist/collection/components/envelopes/verdocs-contact-picker/verdocs-contact-picker.css +9 -1
  94. package/dist/collection/components/envelopes/verdocs-contact-picker/verdocs-contact-picker.js +30 -8
  95. package/dist/collection/components/envelopes/verdocs-envelope-document-page/verdocs-envelope-document-page.js +1 -1
  96. package/dist/collection/components/envelopes/verdocs-envelopes-list/verdocs-envelopes-list.js +6 -6
  97. package/dist/collection/components/envelopes/verdocs-status-indicator/verdocs-status-indicator.js +2 -2
  98. package/dist/collection/components/fields/verdocs-field-attachment/verdocs-field-attachment.css +7 -3
  99. package/dist/collection/components/fields/verdocs-field-attachment/verdocs-field-attachment.js +118 -43
  100. package/dist/collection/components/fields/verdocs-field-checkbox/verdocs-field-checkbox.css +2 -1
  101. package/dist/collection/components/fields/verdocs-field-checkbox/verdocs-field-checkbox.js +22 -27
  102. package/dist/collection/components/fields/verdocs-field-date/verdocs-field-date.css +76 -33
  103. package/dist/collection/components/fields/verdocs-field-date/verdocs-field-date.js +21 -29
  104. package/dist/collection/components/fields/verdocs-field-dropdown/verdocs-field-dropdown.css +1 -1
  105. package/dist/collection/components/fields/verdocs-field-dropdown/verdocs-field-dropdown.js +20 -28
  106. package/dist/collection/components/fields/verdocs-field-initial/verdocs-field-initial.css +1 -1
  107. package/dist/collection/components/fields/verdocs-field-initial/verdocs-field-initial.js +26 -28
  108. package/dist/collection/components/fields/verdocs-field-payment/verdocs-field-payment.css +1 -1
  109. package/dist/collection/components/fields/verdocs-field-radio-button-group/verdocs-field-radio-button.css +1 -1
  110. package/dist/collection/components/fields/verdocs-field-radio-button-group/verdocs-field-radio-button.js +22 -29
  111. package/dist/collection/components/fields/verdocs-field-signature/verdocs-field-signature.css +1 -1
  112. package/dist/collection/components/fields/verdocs-field-signature/verdocs-field-signature.js +27 -30
  113. package/dist/collection/components/fields/verdocs-field-textarea/verdocs-field-textarea.css +1 -1
  114. package/dist/collection/components/fields/verdocs-field-textarea/verdocs-field-textarea.js +21 -27
  115. package/dist/collection/components/fields/verdocs-field-textbox/verdocs-field-textbox.css +1 -1
  116. package/dist/collection/components/fields/verdocs-field-textbox/verdocs-field-textbox.js +19 -31
  117. package/dist/collection/components/fields/verdocs-field-timestamp/verdocs-field-timestamp.css +1 -1
  118. package/dist/collection/components/fields/verdocs-field-timestamp/verdocs-field-timestamp.js +21 -31
  119. package/dist/collection/components/settings/verdocs-settings-api-keys/verdocs-settings-api-keys.js +5 -5
  120. package/dist/collection/components/settings/verdocs-settings-members/verdocs-settings-members.js +5 -11
  121. package/dist/collection/components/settings/verdocs-settings-organization/verdocs-settings-organization.js +0 -8
  122. package/dist/collection/components/templates/verdocs-template-build-tabs/verdocs-template-build-tabs.css +37 -2
  123. package/dist/collection/components/templates/verdocs-template-build-tabs/verdocs-template-build-tabs.js +50 -25
  124. package/dist/collection/components/templates/verdocs-template-card/verdocs-template-card.js +1 -1
  125. package/dist/collection/components/templates/verdocs-template-document-page/verdocs-template-document-page.js +1 -1
  126. package/dist/collection/components/templates/verdocs-template-role-properties/verdocs-template-role-properties.js +7 -7
  127. package/dist/collection/components/templates/verdocs-template-roles/verdocs-template-roles.js +1 -0
  128. package/dist/collection/components/templates/verdocs-template-sender/verdocs-template-sender.js +1 -1
  129. package/dist/collection/components/templates/verdocs-template-star/verdocs-template-star.js +1 -1
  130. package/dist/collection/components/templates/verdocs-template-tags/verdocs-template-tags.js +1 -1
  131. package/dist/collection/components/templates/verdocs-templates-list/verdocs-templates-list.js +7 -7
  132. package/dist/collection/utils/EnvelopeStore.js +10 -0
  133. package/dist/collection/utils/TemplateFieldStore.js +2 -10
  134. package/dist/collection/utils/TemplateRoleStore.js +0 -5
  135. package/dist/collection/utils/TemplateStore.js +18 -3
  136. package/dist/collection/utils/utils.js +5 -12
  137. package/dist/components/EnvelopeStore.js +11 -1
  138. package/dist/components/TemplateFieldStore.js +4 -8
  139. package/dist/components/TemplateRoleStore.js +1 -6
  140. package/dist/components/TemplateStore.js +20 -5
  141. package/dist/components/Types.js +1 -1
  142. package/dist/components/index.d.ts +12 -0
  143. package/dist/components/index.js +169 -0
  144. package/dist/components/index2.js +2 -193
  145. package/dist/components/index4.js +193 -2
  146. package/dist/components/utils.js +8 -15
  147. package/dist/components/verdocs-activity-box.js +0 -1
  148. package/dist/components/verdocs-auth.js +2 -3
  149. package/dist/components/verdocs-build.js +35 -25
  150. package/dist/components/verdocs-button-panel.js +1 -95
  151. package/dist/components/verdocs-button-panel2.js +96 -0
  152. package/dist/components/verdocs-button2.js +1 -2
  153. package/dist/components/verdocs-checkbox2.js +1 -2
  154. package/dist/components/verdocs-component-error2.js +1 -2
  155. package/dist/components/verdocs-contact-picker2.js +45 -12
  156. package/dist/components/verdocs-dialog2.js +1 -2
  157. package/dist/components/verdocs-dropdown2.js +1 -2
  158. package/dist/components/verdocs-envelope-document-page2.js +1 -2
  159. package/dist/components/verdocs-envelope-recipient-link2.js +0 -1
  160. package/dist/components/verdocs-envelope-recipient-summary2.js +0 -1
  161. package/dist/components/verdocs-envelope-sidebar.js +2 -3
  162. package/dist/components/verdocs-envelopes-list.js +6 -7
  163. package/dist/components/verdocs-field-attachment2.js +91 -40
  164. package/dist/components/verdocs-field-checkbox2.js +25 -31
  165. package/dist/components/verdocs-field-date2.js +25 -34
  166. package/dist/components/verdocs-field-dropdown2.js +22 -30
  167. package/dist/components/verdocs-field-initial2.js +22 -30
  168. package/dist/components/verdocs-field-payment.js +1 -2
  169. package/dist/components/verdocs-field-radio-button2.js +25 -33
  170. package/dist/components/verdocs-field-signature2.js +23 -32
  171. package/dist/components/verdocs-field-textarea2.js +21 -29
  172. package/dist/components/verdocs-field-textbox2.js +21 -34
  173. package/dist/components/verdocs-field-timestamp2.js +24 -36
  174. package/dist/components/verdocs-file-chooser2.js +1 -2
  175. package/dist/components/verdocs-help-icon2.js +2 -3
  176. package/dist/components/verdocs-initial-dialog2.js +9 -8
  177. package/dist/components/verdocs-kba-dialog.js +5 -6
  178. package/dist/components/verdocs-loader2.js +1 -2
  179. package/dist/components/verdocs-ok-dialog2.js +2 -3
  180. package/dist/components/verdocs-organization-card.js +26 -8
  181. package/dist/components/verdocs-pagination2.js +1 -2
  182. package/dist/components/verdocs-portal2.js +2 -3
  183. package/dist/components/verdocs-preview2.js +37 -20
  184. package/dist/components/verdocs-progress-bar2.js +3 -3
  185. package/dist/components/verdocs-quick-filter2.js +2 -3
  186. package/dist/components/verdocs-quick-functions2.js +1 -2
  187. package/dist/components/verdocs-radio-button2.js +1 -2
  188. package/dist/components/verdocs-search-box2.js +1 -2
  189. package/dist/components/verdocs-search-tabs.js +1 -2
  190. package/dist/components/verdocs-search.js +1 -2
  191. package/dist/components/verdocs-select-input2.js +1 -2
  192. package/dist/components/verdocs-send2.js +95 -37
  193. package/dist/components/verdocs-settings-api-keys2.js +5 -6
  194. package/dist/components/verdocs-settings-members2.js +6 -13
  195. package/dist/components/verdocs-settings-organization2.js +0 -9
  196. package/dist/components/verdocs-settings-profile2.js +0 -1
  197. package/dist/components/verdocs-settings.js +8 -10
  198. package/dist/components/verdocs-sign.js +2 -3
  199. package/dist/components/verdocs-signature-dialog2.js +6 -8
  200. package/dist/components/verdocs-spinner2.js +1 -2
  201. package/dist/components/verdocs-status-indicator2.js +11 -4
  202. package/dist/components/verdocs-table2.js +3 -6
  203. package/dist/components/verdocs-tabs2.js +2 -3
  204. package/dist/components/verdocs-template-attachments2.js +0 -1
  205. package/dist/components/verdocs-template-build-tabs2.js +57 -28
  206. package/dist/components/verdocs-template-card.js +1 -2
  207. package/dist/components/verdocs-template-create2.js +0 -1
  208. package/dist/components/verdocs-template-document-page2.js +2 -3
  209. package/dist/components/verdocs-template-field-properties2.js +0 -1
  210. package/dist/components/verdocs-template-fields2.js +1 -2
  211. package/dist/components/verdocs-template-name2.js +0 -1
  212. package/dist/components/verdocs-template-reminders2.js +0 -1
  213. package/dist/components/verdocs-template-role-properties2.js +7 -8
  214. package/dist/components/verdocs-template-roles2.js +1 -1
  215. package/dist/components/verdocs-template-sender2.js +1 -2
  216. package/dist/components/verdocs-template-star2.js +1 -2
  217. package/dist/components/verdocs-template-tags.js +1 -2
  218. package/dist/components/verdocs-template-visibility2.js +0 -1
  219. package/dist/components/verdocs-templates-list.js +8 -9
  220. package/dist/components/verdocs-text-input2.js +2 -3
  221. package/dist/components/verdocs-toggle-button2.js +1 -2
  222. package/dist/components/verdocs-toggle.js +1 -2
  223. package/dist/components/verdocs-toolbar-icon2.js +1 -2
  224. package/dist/components/verdocs-upload-dialog2.js +1 -2
  225. package/dist/components/verdocs-view2.js +0 -1
  226. package/dist/esm/{EnvelopeStore-fefba6fd.js → EnvelopeStore-9df042b5.js} +10 -0
  227. package/dist/esm/{TemplateFieldStore-d7516adf.js → TemplateFieldStore-32329b5a.js} +2 -6
  228. package/dist/esm/{TemplateRoleStore-ddc3b96f.js → TemplateRoleStore-0a4f98cb.js} +0 -5
  229. package/dist/esm/{TemplateStore-df5484bb.js → TemplateStore-78ad24d7.js} +20 -5
  230. package/dist/esm/index-b89cf6a4.js +20 -20
  231. package/dist/esm/{interact.min-b055a9b6.js → interact.min-4fac3f2b.js} +1 -1
  232. package/dist/esm/loader.js +1 -1
  233. package/dist/esm/{utils-61c1093b.js → utils-d1c95309.js} +6 -13
  234. package/dist/esm/verdocs-auth.entry.js +2 -2
  235. package/dist/esm/verdocs-build.entry.js +29 -24
  236. package/dist/esm/verdocs-button-panel.entry.js +2 -2
  237. package/dist/esm/verdocs-button_3.entry.js +5 -5
  238. package/dist/esm/{verdocs-checkbox_5.entry.js → verdocs-checkbox_3.entry.js} +6 -92
  239. package/dist/esm/verdocs-component-error.entry.js +17 -0
  240. package/dist/esm/verdocs-contact-picker_2.entry.js +30 -11
  241. package/dist/esm/verdocs-dialog_2.entry.js +4 -6
  242. package/dist/esm/verdocs-dropdown.entry.js +1 -1
  243. package/dist/esm/verdocs-envelope-document-page.entry.js +2 -2
  244. package/dist/esm/verdocs-envelope-recipient-link_2.entry.js +1 -1
  245. package/dist/esm/verdocs-envelope-sidebar.entry.js +2 -19267
  246. package/dist/esm/verdocs-envelopes-list.entry.js +7 -7
  247. package/dist/esm/{verdocs-field-attachment_14.entry.js → verdocs-field-attachment_13.entry.js} +205 -379
  248. package/dist/esm/verdocs-field-payment.entry.js +3 -3
  249. package/dist/esm/verdocs-file-chooser_2.entry.js +4 -3
  250. package/dist/esm/verdocs-kba-dialog.entry.js +5 -5
  251. package/dist/esm/verdocs-loader.entry.js +1 -1
  252. package/dist/esm/verdocs-ok-dialog.entry.js +2 -2
  253. package/dist/esm/verdocs-organization-card_2.entry.js +19369 -0
  254. package/dist/esm/verdocs-pagination_2.entry.js +3 -3
  255. package/dist/esm/verdocs-preview_10.entry.js +156 -79
  256. package/dist/esm/verdocs-quick-functions_2.entry.js +2 -2
  257. package/dist/esm/verdocs-radio-button_3.entry.js +12 -12
  258. package/dist/esm/verdocs-search-tabs.entry.js +1 -1
  259. package/dist/esm/verdocs-search.entry.js +1 -1
  260. package/dist/esm/verdocs-settings-api-keys_4.entry.js +11 -24
  261. package/dist/esm/verdocs-settings.entry.js +1 -2
  262. package/dist/esm/verdocs-sign.entry.js +2 -2
  263. package/dist/esm/verdocs-spinner.entry.js +1 -1
  264. package/dist/esm/verdocs-status-indicator.entry.js +11 -3
  265. package/dist/esm/verdocs-tabs.entry.js +2 -2
  266. package/dist/esm/verdocs-template-card.entry.js +1 -1
  267. package/dist/esm/verdocs-template-document-page_2.entry.js +205 -0
  268. package/dist/esm/verdocs-template-star.entry.js +1 -1
  269. package/dist/esm/verdocs-template-tags.entry.js +1 -1
  270. package/dist/esm/verdocs-templates-list.entry.js +7 -7
  271. package/dist/esm/verdocs-toggle.entry.js +1 -1
  272. package/dist/esm/verdocs-view.entry.js +1 -1
  273. package/dist/esm/verdocs-web-sdk.js +1 -1
  274. package/dist/esm-es5/{EnvelopeStore-fefba6fd.js → EnvelopeStore-9df042b5.js} +1 -1
  275. package/dist/esm-es5/TemplateFieldStore-32329b5a.js +1 -0
  276. package/dist/esm-es5/TemplateRoleStore-0a4f98cb.js +1 -0
  277. package/dist/esm-es5/TemplateStore-78ad24d7.js +1 -0
  278. package/dist/esm-es5/index-b89cf6a4.js +1 -1
  279. package/dist/esm-es5/{interact.min-b055a9b6.js → interact.min-4fac3f2b.js} +1 -1
  280. package/dist/esm-es5/loader.js +1 -1
  281. package/dist/esm-es5/{utils-61c1093b.js → utils-d1c95309.js} +1 -1
  282. package/dist/esm-es5/verdocs-auth.entry.js +1 -1
  283. package/dist/esm-es5/verdocs-build.entry.js +1 -1
  284. package/dist/esm-es5/verdocs-button-panel.entry.js +1 -1
  285. package/dist/esm-es5/verdocs-button_3.entry.js +1 -1
  286. package/dist/esm-es5/verdocs-checkbox_3.entry.js +1 -0
  287. package/dist/esm-es5/verdocs-component-error.entry.js +1 -0
  288. package/dist/esm-es5/verdocs-contact-picker_2.entry.js +1 -1
  289. package/dist/esm-es5/verdocs-dialog_2.entry.js +1 -1
  290. package/dist/esm-es5/verdocs-dropdown.entry.js +1 -1
  291. package/dist/esm-es5/verdocs-envelope-document-page.entry.js +1 -1
  292. package/dist/esm-es5/verdocs-envelope-recipient-link_2.entry.js +1 -1
  293. package/dist/esm-es5/verdocs-envelope-sidebar.entry.js +1 -1
  294. package/dist/esm-es5/verdocs-envelopes-list.entry.js +1 -1
  295. package/dist/esm-es5/verdocs-field-attachment_13.entry.js +1 -0
  296. package/dist/esm-es5/verdocs-field-payment.entry.js +1 -1
  297. package/dist/esm-es5/verdocs-file-chooser_2.entry.js +1 -1
  298. package/dist/esm-es5/verdocs-kba-dialog.entry.js +1 -1
  299. package/dist/esm-es5/verdocs-loader.entry.js +1 -1
  300. package/dist/esm-es5/verdocs-ok-dialog.entry.js +1 -1
  301. package/dist/esm-es5/verdocs-organization-card_2.entry.js +1 -0
  302. package/dist/esm-es5/verdocs-pagination_2.entry.js +1 -1
  303. package/dist/esm-es5/verdocs-preview_10.entry.js +1 -1
  304. package/dist/esm-es5/verdocs-quick-functions_2.entry.js +1 -1
  305. package/dist/esm-es5/verdocs-radio-button_3.entry.js +1 -1
  306. package/dist/esm-es5/verdocs-search-tabs.entry.js +1 -1
  307. package/dist/esm-es5/verdocs-search.entry.js +1 -1
  308. package/dist/esm-es5/verdocs-settings-api-keys_4.entry.js +1 -1
  309. package/dist/esm-es5/verdocs-settings.entry.js +1 -1
  310. package/dist/esm-es5/verdocs-sign.entry.js +1 -1
  311. package/dist/esm-es5/verdocs-spinner.entry.js +1 -1
  312. package/dist/esm-es5/verdocs-status-indicator.entry.js +1 -1
  313. package/dist/esm-es5/verdocs-tabs.entry.js +1 -1
  314. package/dist/esm-es5/verdocs-template-card.entry.js +1 -1
  315. package/dist/esm-es5/verdocs-template-document-page_2.entry.js +1 -0
  316. package/dist/esm-es5/verdocs-template-star.entry.js +1 -1
  317. package/dist/esm-es5/verdocs-template-tags.entry.js +1 -1
  318. package/dist/esm-es5/verdocs-templates-list.entry.js +1 -1
  319. package/dist/esm-es5/verdocs-toggle.entry.js +1 -1
  320. package/dist/esm-es5/verdocs-view.entry.js +1 -1
  321. package/dist/esm-es5/verdocs-web-sdk.js +1 -1
  322. package/{loader → dist/loader}/cdn.js +1 -1
  323. package/{loader → dist/loader}/index.cjs.js +1 -1
  324. package/{loader → dist/loader}/index.d.ts +1 -1
  325. package/dist/loader/index.es2017.js +2 -0
  326. package/{loader → dist/loader}/index.js +2 -2
  327. package/dist/types/components/controls/verdocs-button/verdocs-button.d.ts +7 -0
  328. package/dist/types/components/controls/verdocs-button-panel/verdocs-button-panel.d.ts +16 -0
  329. package/dist/types/components/controls/verdocs-checkbox/verdocs-checkbox.d.ts +1 -1
  330. package/dist/types/components/controls/verdocs-dropdown/verdocs-dropdown.d.ts +16 -0
  331. package/dist/types/components/controls/verdocs-file-chooser/verdocs-file-chooser.d.ts +8 -0
  332. package/dist/types/components/controls/verdocs-help-icon/verdocs-help-icon.d.ts +7 -0
  333. package/dist/types/components/controls/verdocs-loader/verdocs-loader.d.ts +7 -0
  334. package/dist/types/components/controls/verdocs-organization-card/verdocs-organization-card.d.ts +11 -1
  335. package/dist/types/components/controls/verdocs-pagination/verdocs-pagination.d.ts +12 -0
  336. package/dist/types/components/controls/verdocs-portal/verdocs-portal.d.ts +19 -0
  337. package/dist/types/components/controls/verdocs-progress-bar/verdocs-progress-bar.d.ts +7 -0
  338. package/dist/types/components/controls/verdocs-quick-filter/verdocs-quick-filter.d.ts +4 -0
  339. package/dist/types/components/controls/verdocs-radio-button/verdocs-radio-button.d.ts +1 -1
  340. package/dist/types/components/controls/verdocs-select-input/verdocs-select-input.d.ts +5 -1
  341. package/dist/types/components/controls/verdocs-spinner/verdocs-spinner.d.ts +4 -0
  342. package/dist/types/components/controls/verdocs-table/verdocs-table.d.ts +4 -0
  343. package/dist/types/components/controls/verdocs-tabs/verdocs-tabs.d.ts +4 -0
  344. package/dist/types/components/controls/verdocs-text-input/verdocs-text-input.d.ts +5 -1
  345. package/dist/types/components/controls/verdocs-toggle/verdocs-toggle.d.ts +5 -1
  346. package/dist/types/components/controls/verdocs-toggle-button/verdocs-toggle-button.d.ts +4 -0
  347. package/dist/types/components/controls/verdocs-toolbar-icon/verdocs-toolbar-icon.d.ts +4 -0
  348. package/dist/types/components/dialogs/verdocs-kba-dialog/verdocs-kba-dialog.d.ts +1 -3
  349. package/dist/types/components/embeds/verdocs-auth/verdocs-auth.d.ts +10 -22
  350. package/dist/types/components/embeds/verdocs-build/verdocs-build.d.ts +8 -4
  351. package/dist/types/components/embeds/verdocs-preview/verdocs-preview.d.ts +6 -0
  352. package/dist/types/components/embeds/verdocs-send/verdocs-send.d.ts +17 -7
  353. package/dist/types/components/embeds/verdocs-settings/verdocs-settings.d.ts +4 -0
  354. package/dist/types/components/envelopes/verdocs-contact-picker/verdocs-contact-picker.d.ts +3 -0
  355. package/dist/types/components/fields/verdocs-field-attachment/verdocs-field-attachment.d.ts +25 -10
  356. package/dist/types/components/fields/verdocs-field-date/verdocs-field-date.d.ts +3 -3
  357. package/dist/types/components/fields/verdocs-field-dropdown/verdocs-field-dropdown.d.ts +1 -2
  358. package/dist/types/components/fields/verdocs-field-initial/verdocs-field-initial.d.ts +7 -2
  359. package/dist/types/components/fields/verdocs-field-signature/verdocs-field-signature.d.ts +7 -2
  360. package/dist/types/components/fields/verdocs-field-textarea/verdocs-field-textarea.d.ts +2 -1
  361. package/dist/types/components/fields/verdocs-field-textbox/verdocs-field-textbox.d.ts +1 -1
  362. package/dist/types/components/fields/verdocs-field-timestamp/verdocs-field-timestamp.d.ts +2 -1
  363. package/dist/types/components/settings/verdocs-settings-organization/verdocs-settings-organization.d.ts +0 -1
  364. package/dist/types/components/templates/verdocs-template-build-tabs/verdocs-template-build-tabs.d.ts +5 -3
  365. package/dist/types/components.d.ts +715 -209
  366. package/dist/types/utils/TemplateFieldStore.d.ts +0 -1
  367. package/dist/verdocs-web-sdk/{p-b355111d.entry.js → p-000b8414.entry.js} +1 -1
  368. package/dist/verdocs-web-sdk/p-05c9b6c9.system.entry.js +1 -0
  369. package/dist/verdocs-web-sdk/p-0a0ac65f.entry.js +1 -0
  370. package/dist/verdocs-web-sdk/p-0d5fb952.system.js +1 -0
  371. package/dist/verdocs-web-sdk/{p-832bc1b5.entry.js → p-0ff14c4d.entry.js} +1 -1
  372. package/dist/verdocs-web-sdk/p-13450dcd.system.entry.js +1 -0
  373. package/dist/verdocs-web-sdk/{p-c1f7cfff.system.entry.js → p-16850eac.system.entry.js} +1 -1
  374. package/dist/verdocs-web-sdk/{p-b12f1302.entry.js → p-1dd1d686.entry.js} +1 -1
  375. package/dist/verdocs-web-sdk/{p-75f98b48.system.entry.js → p-1fec2d1e.system.entry.js} +1 -1
  376. package/dist/verdocs-web-sdk/{p-483cc30b.entry.js → p-203d8ff0.entry.js} +1 -1
  377. package/dist/verdocs-web-sdk/{p-c543852a.entry.js → p-225418c7.entry.js} +1 -1
  378. package/dist/verdocs-web-sdk/p-2b6566eb.entry.js +1 -0
  379. package/dist/verdocs-web-sdk/{p-8eed20fe.entry.js → p-3093ede7.entry.js} +1 -1
  380. package/dist/verdocs-web-sdk/{p-bd9f7023.system.entry.js → p-314321b8.system.entry.js} +1 -1
  381. package/dist/verdocs-web-sdk/p-316fc185.js +1 -0
  382. package/dist/verdocs-web-sdk/p-322fa613.system.js +1 -1
  383. package/dist/verdocs-web-sdk/p-3a8b2213.system.entry.js +1 -0
  384. package/dist/verdocs-web-sdk/p-4291db9f.entry.js +1 -0
  385. package/dist/verdocs-web-sdk/{p-84f477d1.entry.js → p-42ec5f5b.entry.js} +1 -1
  386. package/dist/verdocs-web-sdk/{p-7db995b0.system.entry.js → p-43962d76.system.entry.js} +1 -1
  387. package/dist/verdocs-web-sdk/p-4542fd4b.entry.js +1 -0
  388. package/dist/verdocs-web-sdk/p-45cf0ab5.entry.js +1 -0
  389. package/dist/verdocs-web-sdk/p-4df630c2.system.entry.js +1 -0
  390. package/dist/verdocs-web-sdk/{p-35859fe1.system.entry.js → p-5070ad92.system.entry.js} +1 -1
  391. package/dist/verdocs-web-sdk/p-515ee177.system.entry.js +1 -0
  392. package/dist/verdocs-web-sdk/{p-4cd628a3.system.entry.js → p-5309a156.system.entry.js} +1 -1
  393. package/dist/verdocs-web-sdk/p-540d9467.entry.js +1 -0
  394. package/dist/verdocs-web-sdk/{p-4424d71f.system.entry.js → p-597bd8aa.system.entry.js} +1 -1
  395. package/dist/verdocs-web-sdk/{p-bca3887c.system.entry.js → p-5be462d9.system.entry.js} +1 -1
  396. package/dist/verdocs-web-sdk/{p-6d1bdae8.system.js → p-5bec8b75.system.js} +1 -1
  397. package/dist/verdocs-web-sdk/{p-e92688db.entry.js → p-5df130eb.entry.js} +1 -1
  398. package/dist/verdocs-web-sdk/p-5e3e9c4a.system.js +1 -0
  399. package/dist/verdocs-web-sdk/{p-e504ebcd.entry.js → p-62728531.entry.js} +1 -1
  400. package/dist/verdocs-web-sdk/{p-35157a14.js → p-627f774b.js} +1 -1
  401. package/dist/verdocs-web-sdk/p-62af2ee6.system.entry.js +1 -0
  402. package/dist/verdocs-web-sdk/p-67c3b3d1.entry.js +1 -0
  403. package/dist/verdocs-web-sdk/{p-2cc1724f.entry.js → p-6c5aee88.entry.js} +1 -1
  404. package/dist/verdocs-web-sdk/{p-7b009ca9.entry.js → p-71eeeff4.entry.js} +1 -1
  405. package/dist/verdocs-web-sdk/p-72c7e548.entry.js +1 -0
  406. package/dist/verdocs-web-sdk/p-73042665.entry.js +1 -0
  407. package/dist/verdocs-web-sdk/p-748ed4ef.entry.js +1 -0
  408. package/dist/verdocs-web-sdk/{p-44acae9e.system.entry.js → p-76297fa0.system.entry.js} +1 -1
  409. package/dist/verdocs-web-sdk/p-7b222135.system.entry.js +1 -0
  410. package/dist/verdocs-web-sdk/{p-1e6cecc0.entry.js → p-7b8ae86c.entry.js} +1 -1
  411. package/dist/verdocs-web-sdk/p-7c3b1e47.entry.js +1 -0
  412. package/dist/verdocs-web-sdk/{p-854a3caa.entry.js → p-7e6fa885.entry.js} +1 -1
  413. package/dist/verdocs-web-sdk/{p-9a57eba9.entry.js → p-7ed27280.entry.js} +1 -1
  414. package/dist/verdocs-web-sdk/p-7fe48d2e.entry.js +1 -0
  415. package/dist/verdocs-web-sdk/{p-3d9d0c2e.system.entry.js → p-84781ec3.system.entry.js} +1 -1
  416. package/dist/verdocs-web-sdk/{p-235d82f0.system.entry.js → p-84caf3e1.system.entry.js} +1 -1
  417. package/dist/verdocs-web-sdk/{p-94c638b9.system.js → p-85519037.system.js} +1 -1
  418. package/dist/verdocs-web-sdk/p-900006b0.system.js +1 -0
  419. package/dist/verdocs-web-sdk/p-95e90092.system.entry.js +1 -0
  420. package/dist/verdocs-web-sdk/p-96352ec7.entry.js +1 -0
  421. package/dist/verdocs-web-sdk/p-971ab2d1.entry.js +1 -0
  422. package/dist/verdocs-web-sdk/{p-7602d431.entry.js → p-973a8142.entry.js} +1 -1
  423. package/dist/verdocs-web-sdk/{p-da7d343c.system.entry.js → p-98928410.system.entry.js} +1 -1
  424. package/dist/verdocs-web-sdk/{p-0f5dc1c5.system.entry.js → p-99510d53.system.entry.js} +1 -1
  425. package/dist/verdocs-web-sdk/p-9c05218b.entry.js +1 -0
  426. package/dist/verdocs-web-sdk/p-9ec464df.js +1 -0
  427. package/dist/verdocs-web-sdk/{p-e8e2bf33.entry.js → p-a5c6eac3.entry.js} +1 -1
  428. package/dist/verdocs-web-sdk/p-a908ebeb.system.entry.js +1 -0
  429. package/dist/verdocs-web-sdk/p-ac7d07de.system.entry.js +1 -0
  430. package/dist/verdocs-web-sdk/{p-846ee5dd.entry.js → p-ad2814b4.entry.js} +1 -1
  431. package/dist/verdocs-web-sdk/p-afbbdc2f.system.js +1 -0
  432. package/dist/verdocs-web-sdk/{p-503072b6.entry.js → p-b0df559c.entry.js} +1 -1
  433. package/dist/verdocs-web-sdk/p-b3eab86c.entry.js +1 -0
  434. package/dist/verdocs-web-sdk/p-b699eeef.system.entry.js +1 -0
  435. package/dist/verdocs-web-sdk/{p-4297282e.system.entry.js → p-ba675574.system.entry.js} +1 -1
  436. package/dist/verdocs-web-sdk/{p-3415ddee.system.entry.js → p-bb0ed696.system.entry.js} +1 -1
  437. package/dist/verdocs-web-sdk/p-bb1dc544.system.entry.js +1 -0
  438. package/dist/verdocs-web-sdk/{p-6d52b500.entry.js → p-bbae0a6c.entry.js} +1 -1
  439. package/dist/verdocs-web-sdk/p-bf4a9089.system.entry.js +1 -0
  440. package/dist/verdocs-web-sdk/{p-3999bace.system.entry.js → p-bf8e7b5a.system.entry.js} +1 -1
  441. package/dist/verdocs-web-sdk/p-c28c4e43.js +1 -0
  442. package/dist/verdocs-web-sdk/{p-fb3afee2.system.entry.js → p-c598ea74.system.entry.js} +1 -1
  443. package/dist/verdocs-web-sdk/{p-7b397f3a.js → p-cc32d84f.js} +1 -1
  444. package/dist/verdocs-web-sdk/p-ccdb7d88.system.entry.js +1 -0
  445. package/dist/verdocs-web-sdk/{p-c327f3e6.system.entry.js → p-cf06ba29.system.entry.js} +1 -1
  446. package/dist/verdocs-web-sdk/{p-ac9b5e3f.system.entry.js → p-d4331e4f.system.entry.js} +1 -1
  447. package/dist/verdocs-web-sdk/p-d61235cf.entry.js +1 -0
  448. package/dist/verdocs-web-sdk/{p-e26e9907.system.entry.js → p-e6992b79.system.entry.js} +1 -1
  449. package/dist/verdocs-web-sdk/p-e7b29b46.system.entry.js +1 -0
  450. package/dist/verdocs-web-sdk/p-eaf4de2f.entry.js +1 -0
  451. package/dist/verdocs-web-sdk/p-f05a3654.system.entry.js +1 -0
  452. package/dist/verdocs-web-sdk/{p-80d24da1.system.entry.js → p-f1d41587.system.entry.js} +1 -1
  453. package/dist/verdocs-web-sdk/p-f2f6c646.system.entry.js +1 -0
  454. package/dist/verdocs-web-sdk/{p-0017dee2.system.entry.js → p-f54b4cc0.system.entry.js} +1 -1
  455. package/dist/verdocs-web-sdk/p-f69d8d39.js +1 -0
  456. package/dist/verdocs-web-sdk/{p-3ae988e6.entry.js → p-f91f3248.entry.js} +1 -1
  457. package/dist/verdocs-web-sdk/p-f9ffe6b9.entry.js +1 -0
  458. package/dist/verdocs-web-sdk/verdocs-web-sdk.esm.js +1 -1
  459. package/package.json +7 -6
  460. package/dist/cjs/verdocs-floating-menu.cjs.entry.js +0 -107
  461. package/dist/cjs/verdocs-organization-card.cjs.entry.js +0 -24
  462. package/dist/cjs/verdocs-toolbar-icon.cjs.entry.js +0 -52
  463. package/dist/collection/components/controls/verdocs-floating-menu/verdocs-floating-menu.css +0 -102
  464. package/dist/collection/components/controls/verdocs-floating-menu/verdocs-floating-menu.js +0 -157
  465. package/dist/components/verdocs-floating-menu.d.ts +0 -11
  466. package/dist/components/verdocs-floating-menu.js +0 -129
  467. package/dist/custom-elements.json +0 -2134
  468. package/dist/docs.d.ts +0 -435
  469. package/dist/docs.json +0 -15188
  470. package/dist/esm/verdocs-floating-menu.entry.js +0 -103
  471. package/dist/esm/verdocs-organization-card.entry.js +0 -20
  472. package/dist/esm/verdocs-toolbar-icon.entry.js +0 -48
  473. package/dist/esm-es5/TemplateFieldStore-d7516adf.js +0 -1
  474. package/dist/esm-es5/TemplateRoleStore-ddc3b96f.js +0 -1
  475. package/dist/esm-es5/TemplateStore-df5484bb.js +0 -1
  476. package/dist/esm-es5/verdocs-checkbox_5.entry.js +0 -1
  477. package/dist/esm-es5/verdocs-field-attachment_14.entry.js +0 -1
  478. package/dist/esm-es5/verdocs-floating-menu.entry.js +0 -1
  479. package/dist/esm-es5/verdocs-organization-card.entry.js +0 -1
  480. package/dist/esm-es5/verdocs-toolbar-icon.entry.js +0 -1
  481. package/dist/types/components/controls/verdocs-floating-menu/verdocs-floating-menu.d.ts +0 -26
  482. package/dist/verdocs-web-sdk/p-0191eac7.system.entry.js +0 -1
  483. package/dist/verdocs-web-sdk/p-05cfdd58.js +0 -1
  484. package/dist/verdocs-web-sdk/p-0664e011.system.entry.js +0 -1
  485. package/dist/verdocs-web-sdk/p-0e44d592.system.entry.js +0 -1
  486. package/dist/verdocs-web-sdk/p-0e74b009.entry.js +0 -1
  487. package/dist/verdocs-web-sdk/p-0f12fb66.entry.js +0 -1
  488. package/dist/verdocs-web-sdk/p-1200552e.system.entry.js +0 -1
  489. package/dist/verdocs-web-sdk/p-14fe476a.entry.js +0 -1
  490. package/dist/verdocs-web-sdk/p-17801797.js +0 -1
  491. package/dist/verdocs-web-sdk/p-28d5af49.system.entry.js +0 -1
  492. package/dist/verdocs-web-sdk/p-294fd56c.entry.js +0 -1
  493. package/dist/verdocs-web-sdk/p-3102c8fb.entry.js +0 -1
  494. package/dist/verdocs-web-sdk/p-32e396c5.system.entry.js +0 -1
  495. package/dist/verdocs-web-sdk/p-36800dd4.js +0 -1
  496. package/dist/verdocs-web-sdk/p-4ae82766.entry.js +0 -1
  497. package/dist/verdocs-web-sdk/p-656ba4ba.system.entry.js +0 -1
  498. package/dist/verdocs-web-sdk/p-660a17c3.entry.js +0 -1
  499. package/dist/verdocs-web-sdk/p-6a82e278.system.js +0 -1
  500. package/dist/verdocs-web-sdk/p-721edea6.entry.js +0 -1
  501. package/dist/verdocs-web-sdk/p-727f9a9a.system.js +0 -1
  502. package/dist/verdocs-web-sdk/p-77fe89f5.system.entry.js +0 -1
  503. package/dist/verdocs-web-sdk/p-7a708333.system.entry.js +0 -1
  504. package/dist/verdocs-web-sdk/p-7aacdd81.entry.js +0 -1
  505. package/dist/verdocs-web-sdk/p-8164d8bf.system.entry.js +0 -1
  506. package/dist/verdocs-web-sdk/p-817b0210.entry.js +0 -1
  507. package/dist/verdocs-web-sdk/p-8bb229dd.system.entry.js +0 -1
  508. package/dist/verdocs-web-sdk/p-8e831c4b.system.entry.js +0 -1
  509. package/dist/verdocs-web-sdk/p-91483dea.system.entry.js +0 -1
  510. package/dist/verdocs-web-sdk/p-98f14855.system.js +0 -1
  511. package/dist/verdocs-web-sdk/p-9e86a14a.entry.js +0 -1
  512. package/dist/verdocs-web-sdk/p-a0857afa.entry.js +0 -1
  513. package/dist/verdocs-web-sdk/p-a0a08e62.system.entry.js +0 -1
  514. package/dist/verdocs-web-sdk/p-a1f6189b.system.js +0 -1
  515. package/dist/verdocs-web-sdk/p-a396eee6.entry.js +0 -1
  516. package/dist/verdocs-web-sdk/p-b661c95f.system.entry.js +0 -1
  517. package/dist/verdocs-web-sdk/p-ba19b1d8.system.entry.js +0 -1
  518. package/dist/verdocs-web-sdk/p-bf31565b.system.entry.js +0 -1
  519. package/dist/verdocs-web-sdk/p-c7d2e9c4.entry.js +0 -1
  520. package/dist/verdocs-web-sdk/p-c81bc939.entry.js +0 -1
  521. package/dist/verdocs-web-sdk/p-dee3aeec.entry.js +0 -1
  522. package/dist/verdocs-web-sdk/p-ed863acf.entry.js +0 -1
  523. package/dist/verdocs-web-sdk/p-eeece233.entry.js +0 -1
  524. package/dist/verdocs-web-sdk/p-f070e923.js +0 -1
  525. package/dist/verdocs-web-sdk/p-fa51066b.entry.js +0 -1
  526. package/loader/index.es2017.js +0 -2
  527. /package/{loader → dist/loader}/package.json +0 -0
@@ -12,7 +12,6 @@ import { TVerdocsBuildStep } from "./components/embeds/verdocs-build/verdocs-bui
12
12
  import { IContactSearchEvent, IContactSelectEvent, IEmailContact, IPhoneContact } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
13
13
  import { IMenuOption } from "./components/controls/verdocs-dropdown/verdocs-dropdown";
14
14
  import { IDocumentPageInfo, IPageLayer } from "./utils/Types";
15
- import { IOption } from "./components/controls/verdocs-floating-menu/verdocs-floating-menu";
16
15
  import { IFilterOption } from "./components/controls/verdocs-quick-filter/verdocs-quick-filter";
17
16
  import { ISearchEvent, TContentType } from "./components/elements/verdocs-search-box/verdocs-search-box";
18
17
  import { IContactSearchEvent as IContactSearchEvent1 } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
@@ -29,7 +28,6 @@ export { TVerdocsBuildStep } from "./components/embeds/verdocs-build/verdocs-bui
29
28
  export { IContactSearchEvent, IContactSelectEvent, IEmailContact, IPhoneContact } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
30
29
  export { IMenuOption } from "./components/controls/verdocs-dropdown/verdocs-dropdown";
31
30
  export { IDocumentPageInfo, IPageLayer } from "./utils/Types";
32
- export { IOption } from "./components/controls/verdocs-floating-menu/verdocs-floating-menu";
33
31
  export { IFilterOption } from "./components/controls/verdocs-quick-filter/verdocs-quick-filter";
34
32
  export { ISearchEvent, TContentType } from "./components/elements/verdocs-search-box/verdocs-search-box";
35
33
  export { IContactSearchEvent as IContactSearchEvent1 } from "./components/envelopes/verdocs-contact-picker/verdocs-contact-picker";
@@ -64,26 +62,15 @@ export namespace Components {
64
62
  "view"?: 'completed' | 'action' | 'waiting';
65
63
  }
66
64
  /**
67
- * Display an authentication dialog that allows the user to login or sign up. Callbacks are provided for events that
68
- * occur during the process (especially successful completion). If the user is already authenticated with a valid
69
- * session, this component will hide itself and fire the success callback immediately. It is up to the host application
70
- * to render the next appropriate view for the application.
71
- * To simplify some types of authentication flows, a visibility flag can force this component to never display. This
72
- * allows you to susbcribe to notifications from the
65
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
66
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
67
+ * host application to render the next appropriate view for the application.
68
+ * To simplify UI development, a visibility flag can force this component to never display. This
69
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
73
70
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
74
71
  * container to allow sufficient space for the required forms.
75
- * As noted below, the primary event is `authenticated`. This will always be fired at least once, immediately after
76
- * the widget is rendered and the user's status has been checked. It may be fired again as the user completes (or
77
- * cancels) authentication steps.
78
- * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
79
- * embed. This Element will reuse the same session produced by logging in via that Embed.
80
- * ```typescript
81
- * interface IAuthStatus {
82
- * // If true, the user is authenticated with a valid session
83
- * authenticated: boolean;
84
- * // Details for the user's session
85
- * session: IActiveSession | null;
86
- * }
72
+ * ```ts
73
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
87
74
  * ```
88
75
  */
89
76
  interface VerdocsAuth {
@@ -102,6 +89,9 @@ export namespace Components {
102
89
  }
103
90
  /**
104
91
  * Display a template building experience.
92
+ * ```ts
93
+ * <verdocs-build templateId={templateId} />
94
+ * ```
105
95
  */
106
96
  interface VerdocsBuild {
107
97
  /**
@@ -117,6 +107,12 @@ export namespace Components {
117
107
  */
118
108
  "templateId": string | null;
119
109
  }
110
+ /**
111
+ * A simple button, with consistent styling to other controls in the design system.
112
+ * ```ts
113
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
114
+ * ```
115
+ */
120
116
  interface VerdocsButton {
121
117
  /**
122
118
  * Whether the button should be disabled.
@@ -147,6 +143,21 @@ export namespace Components {
147
143
  */
148
144
  "variant": 'standard' | 'text' | 'outline';
149
145
  }
146
+ /**
147
+ * Display an icon button that triggers a drop-down panel that can display
148
+ * arbitrary child content, such as metadata, forms, or other controls.
149
+ * ```ts
150
+ * <verdocs-button-panel .icon=${icon}>
151
+ * <h6>Field Settings</h6>
152
+ * <form>
153
+ * <p>
154
+ * <label>Field Name</label>
155
+ * <input type="text" placeholder="Field Name..." />
156
+ * </p>
157
+ * </form>
158
+ * </verdocs-button-panel>
159
+ * ```
160
+ */
150
161
  interface VerdocsButtonPanel {
151
162
  "hidePanel": () => Promise<void>;
152
163
  /**
@@ -162,7 +173,7 @@ export namespace Components {
162
173
  * box for UI displays e.g. dialog boxes.
163
174
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
164
175
  * handler. Sample usage:
165
- * ```html
176
+ * ```ts
166
177
  * <verdocs-checkbox
167
178
  * value="on"
168
179
  * name="thingEnabled"
@@ -233,6 +244,21 @@ export namespace Components {
233
244
  */
234
245
  interface VerdocsDialog {
235
246
  }
247
+ /**
248
+ * Display a drop-down menu button. A menu of the specified options will be displayed when the button is pressed. The menu will be hidden
249
+ * when the button is pressed again, or an option is selected. Separators may be created by supplying an entry with an empty label.
250
+ * ```ts
251
+ * <verdocs-dropdown
252
+ * options={[
253
+ * {label: 'Option 1', disabled: true},
254
+ * {label: 'Option 2', id: '2'}
255
+ * {label: ''}
256
+ * {label: 'Option 3', id: '2'}
257
+ * ]}
258
+ * label="OK" onClick={() => (console.log('OK clicked'))}
259
+ * />
260
+ * ```
261
+ */
236
262
  interface VerdocsDropdown {
237
263
  /**
238
264
  * The menu options to display.
@@ -385,6 +411,10 @@ export namespace Components {
385
411
  * If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be changed, so it should typically only be enabled in the Builder.
386
412
  */
387
413
  "editable"?: boolean;
414
+ /**
415
+ * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used. This component self-manages its resize (width) behavior when in edit-template mode, and uses this endpoint to save changes.
416
+ */
417
+ "endpoint": VerdocsEndpoint;
388
418
  /**
389
419
  * The name of the field to display.
390
420
  */
@@ -509,8 +539,7 @@ export namespace Components {
509
539
  "yscale"?: number;
510
540
  }
511
541
  /**
512
- * Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as
513
- * input types like text and checkbox.
542
+ * Displays a dropdown field that allows the user to choose one of a list of options.
514
543
  */
515
544
  interface VerdocsFieldDropdown {
516
545
  /**
@@ -554,8 +583,12 @@ export namespace Components {
554
583
  "yscale"?: number;
555
584
  }
556
585
  /**
557
- * Displays an initial field. If an initial already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
558
- * button will be shown. Clicking the button will show a dialog to adopt an initial.
586
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
587
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
588
+ * show a dialog to adopt an initial.
589
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
590
+ * This requires operation against a live, valid envelope. If you are testing this component
591
+ * in Storybook, it will not be visible here.
559
592
  */
560
593
  interface VerdocsFieldInitial {
561
594
  /**
@@ -699,8 +732,12 @@ export namespace Components {
699
732
  "yscale"?: number;
700
733
  }
701
734
  /**
702
- * Displays a signature field. If a signature already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
703
- * button will be shown. Clicking the button will show a dialog to adopt a signature.
735
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
736
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
737
+ * show a dialog to adopt a signature.
738
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
739
+ * This requires operation against a live, valid envelope. If you are testing this component
740
+ * in Storybook, it will not be visible here.
704
741
  */
705
742
  interface VerdocsFieldSignature {
706
743
  /**
@@ -748,7 +785,8 @@ export namespace Components {
748
785
  "yscale"?: number;
749
786
  }
750
787
  /**
751
- * Display a multi-line text input field.
788
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
789
+ * as the BOTTOM-LEFT corner.
752
790
  */
753
791
  interface VerdocsFieldTextarea {
754
792
  /**
@@ -796,7 +834,7 @@ export namespace Components {
796
834
  "yscale"?: number;
797
835
  }
798
836
  /**
799
- * Display a text input field.
837
+ * Display a simple 1-line text input field.
800
838
  */
801
839
  interface VerdocsFieldTextbox {
802
840
  /**
@@ -844,7 +882,8 @@ export namespace Components {
844
882
  "yscale"?: number;
845
883
  }
846
884
  /**
847
- * Display a timestamp field.
885
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
886
+ * filled when the signer submits the document.
848
887
  */
849
888
  interface VerdocsFieldTimestamp {
850
889
  /**
@@ -887,18 +926,25 @@ export namespace Components {
887
926
  */
888
927
  "yscale"?: number;
889
928
  }
929
+ /**
930
+ * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
931
+ * provide the actual upload functionality.
932
+ * ```ts
933
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
934
+ * ```
935
+ */
890
936
  interface VerdocsFileChooser {
891
937
  /**
892
938
  * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
893
939
  */
894
940
  "endpoint": VerdocsEndpoint;
895
941
  }
896
- interface VerdocsFloatingMenu {
897
- /**
898
- * The role that this contact will be assigned to.
899
- */
900
- "options": IOption[];
901
- }
942
+ /**
943
+ * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
944
+ * ```ts
945
+ * <verdocs-help-icon text="Sample help text" />
946
+ * ```
947
+ */
902
948
  interface VerdocsHelpIcon {
903
949
  /**
904
950
  * Optional icon to display. If not supplied, a standard help icon will be shown.
@@ -920,9 +966,7 @@ export namespace Components {
920
966
  "initials": string;
921
967
  }
922
968
  /**
923
- * Display a text input field. This adds a partially-transparent overlay and screen-centered dialog
924
- * box with a message and optional header/title. An OK button is shown that will dismiss the message.
925
- * It can also be dismissed by clicking the background overlay.
969
+ * Prompt the user to confirm their identity with a series of questions.
926
970
  */
927
971
  interface VerdocsKbaDialog {
928
972
  /**
@@ -958,6 +1002,12 @@ export namespace Components {
958
1002
  */
959
1003
  "steps": number;
960
1004
  }
1005
+ /**
1006
+ * Animated loader placeholder. There are currently no configuration options for this control.
1007
+ * ```ts
1008
+ * <verdocs-loader />
1009
+ * ```
1010
+ */
961
1011
  interface VerdocsLoader {
962
1012
  }
963
1013
  /**
@@ -983,12 +1033,29 @@ export namespace Components {
983
1033
  */
984
1034
  "showCancel": boolean;
985
1035
  }
1036
+ /**
1037
+ * Display a small summary card describing an organization.
1038
+ * ```ts
1039
+ * <verdocs-organization-card organization={organization} />
1040
+ * ```
1041
+ */
986
1042
  interface VerdocsOrganizationCard {
987
1043
  /**
988
1044
  * The organization to display
989
1045
  */
990
1046
  "organization": IOrganization;
991
1047
  }
1048
+ /**
1049
+ * Display a simple pagination control with individual buttons to move through the data set.
1050
+ * ```ts
1051
+ * <verdocs-pagination
1052
+ * selectedPage={1}
1053
+ * itemCount={50}
1054
+ * perPage={10}
1055
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
1056
+ * />
1057
+ * ```
1058
+ */
992
1059
  interface VerdocsPagination {
993
1060
  /**
994
1061
  * The total number of items.
@@ -1003,6 +1070,24 @@ export namespace Components {
1003
1070
  */
1004
1071
  "selectedPage": number;
1005
1072
  }
1073
+ /**
1074
+ * Display a child component in a "portal", popping it out of the main DOM tree
1075
+ * to allow it to escape the bounds set by its parent.
1076
+ * @credit https://github.com/tomas-teston/stencil-portal for the basic
1077
+ * technique. This has been altered in a few ways to make it more friendly
1078
+ * to cases where there may be multiple portals on the page and provide more
1079
+ * alignment options for the child to be displayed.
1080
+ * ```ts
1081
+ * <div style="padding: 40px">
1082
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
1083
+ * Tooltip Anchor
1084
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
1085
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
1086
+ * </verdocs-portal>
1087
+ * </div>
1088
+ * </div>
1089
+ * ```
1090
+ */
1006
1091
  interface VerdocsPortal {
1007
1092
  /**
1008
1093
  * Horizontal alignment.
@@ -1021,6 +1106,9 @@ export namespace Components {
1021
1106
  * Display a template preview experience. This will display the template's attached
1022
1107
  * documents with signing fields overlaid on each page. Fields will be color-coded
1023
1108
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
1109
+ * ```ts
1110
+ * <verdocs-preview templateId={templateId} />
1111
+ * ```
1024
1112
  */
1025
1113
  interface VerdocsPreview {
1026
1114
  /**
@@ -1032,6 +1120,12 @@ export namespace Components {
1032
1120
  */
1033
1121
  "templateId": string | null;
1034
1122
  }
1123
+ /**
1124
+ * Display a simple progress bar in a style consistent with the design system.
1125
+ * ```ts
1126
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
1127
+ * ```
1128
+ */
1035
1129
  interface VerdocsProgressBar {
1036
1130
  /**
1037
1131
  * Optional label to display above the bar
@@ -1048,6 +1142,9 @@ export namespace Components {
1048
1142
  }
1049
1143
  /**
1050
1144
  * Display a drop-down menu of quick filter options.
1145
+ * ```ts
1146
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
1147
+ * ```
1051
1148
  */
1052
1149
  interface VerdocsQuickFilter {
1053
1150
  "label": string;
@@ -1075,7 +1172,7 @@ export namespace Components {
1075
1172
  * simple radio button for UI displays e.g. dialog boxes.
1076
1173
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
1077
1174
  * handler. Sample usage:
1078
- * ```html
1175
+ * ```ts
1079
1176
  * <verdocs-radio-button
1080
1177
  * value="val1"
1081
1178
  * name="someProperty"
@@ -1142,7 +1239,11 @@ export namespace Components {
1142
1239
  /**
1143
1240
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
1144
1241
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
1145
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
1242
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
1243
+ * ```ts
1244
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
1245
+ * @input ={() => {}} />
1246
+ * ```
1146
1247
  */
1147
1248
  interface VerdocsSelectInput {
1148
1249
  /**
@@ -1163,12 +1264,18 @@ export namespace Components {
1163
1264
  "value": string;
1164
1265
  }
1165
1266
  /**
1166
- * Display a form to collect recipient information for a new Envelope. If used anonymously, the specified `templateId` must be public.
1167
- * Because most applications have custom workflow requirements to trigger after sending an Envelope, this component does not actually
1168
- * perform that operation. Parent applications should listen for the `onSend` event, and can pass the contents of `event.detail`
1169
- * directly to the `createEnvelope()` call in JS-SDK.
1170
- * Host applications should ensure the template is "sendable" before displaying this component. To be sendable, a template must have
1171
- * at least one document attached, at least one participant defined, and at least one field assigned to every "signer" participant.
1267
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
1268
+ * that because most applications have custom workflow requirements to trigger after sending an
1269
+ * Envelope, this component does not actually perform that operation. Parent applications should
1270
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
1271
+ * `createEnvelope()` call in JS-SDK.
1272
+ * Host applications should ensure the template is "sendable" before displaying this component.
1273
+ * To be sendable, a template must have at least one document attached, at least one participant
1274
+ * defined, and at least one field assigned to every "signer" participant. This component will
1275
+ * hide itself if the template is not sendable.
1276
+ * ```ts
1277
+ * <verdocs-send templateId={templateId} />
1278
+ * ```
1172
1279
  */
1173
1280
  interface VerdocsSend {
1174
1281
  /**
@@ -1189,6 +1296,9 @@ export namespace Components {
1189
1296
  * Display a template preview experience. This will display the template's attached
1190
1297
  * documents with signing fields overlaid on each page. Fields will be color-coded
1191
1298
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
1299
+ * ```ts
1300
+ * <verdocs-settings />
1301
+ * ```
1192
1302
  */
1193
1303
  interface VerdocsSettings {
1194
1304
  /**
@@ -1277,6 +1387,9 @@ export namespace Components {
1277
1387
  }
1278
1388
  /**
1279
1389
  * Display a small loading spinner.
1390
+ * ```ts
1391
+ * <verdocs-spinner />
1392
+ * ```
1280
1393
  */
1281
1394
  interface VerdocsSpinner {
1282
1395
  "mode": 'light' | 'dark';
@@ -1310,6 +1423,9 @@ export namespace Components {
1310
1423
  /**
1311
1424
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
1312
1425
  * support creating interactive table layouts.
1426
+ * ```ts
1427
+ * <verdocs-table columns={[...columns]} data={[...data]} />
1428
+ * ```
1313
1429
  */
1314
1430
  interface VerdocsTable {
1315
1431
  /**
@@ -1324,6 +1440,9 @@ export namespace Components {
1324
1440
  /**
1325
1441
  * Display a simple row of selectable tabs. This is a controlled element.
1326
1442
  * The parent must adjust selectedTab as selection events are fired.
1443
+ * ```ts
1444
+ * <verdocs-tabs tabs={[...tabs]} />
1445
+ * ```
1327
1446
  */
1328
1447
  interface VerdocsTabs {
1329
1448
  /**
@@ -1627,7 +1746,10 @@ export namespace Components {
1627
1746
  /**
1628
1747
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
1629
1748
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
1630
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
1749
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
1750
+ * ```ts
1751
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
1752
+ * ```
1631
1753
  */
1632
1754
  interface VerdocsTextInput {
1633
1755
  /**
@@ -1672,7 +1794,10 @@ export namespace Components {
1672
1794
  "value": string;
1673
1795
  }
1674
1796
  /**
1675
- * Displays a label and a set of buttons, also allowing a default selection of a button
1797
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
1798
+ * ```ts
1799
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
1800
+ * ```
1676
1801
  */
1677
1802
  interface VerdocsToggle {
1678
1803
  /**
@@ -1686,6 +1811,9 @@ export namespace Components {
1686
1811
  }
1687
1812
  /**
1688
1813
  * Displays a single button that can be toggled on or off by clicking it.
1814
+ * ```ts
1815
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
1816
+ * ```
1689
1817
  */
1690
1818
  interface VerdocsToggleButton {
1691
1819
  "active": boolean;
@@ -1704,6 +1832,9 @@ export namespace Components {
1704
1832
  }
1705
1833
  /**
1706
1834
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
1835
+ * ```ts
1836
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
1837
+ * ```
1707
1838
  */
1708
1839
  interface VerdocsToolbarIcon {
1709
1840
  /**
@@ -1836,10 +1967,6 @@ export interface VerdocsFileChooserCustomEvent<T> extends CustomEvent<T> {
1836
1967
  detail: T;
1837
1968
  target: HTMLVerdocsFileChooserElement;
1838
1969
  }
1839
- export interface VerdocsFloatingMenuCustomEvent<T> extends CustomEvent<T> {
1840
- detail: T;
1841
- target: HTMLVerdocsFloatingMenuElement;
1842
- }
1843
1970
  export interface VerdocsInitialDialogCustomEvent<T> extends CustomEvent<T> {
1844
1971
  detail: T;
1845
1972
  target: HTMLVerdocsInitialDialogElement;
@@ -2014,26 +2141,15 @@ declare global {
2014
2141
  "sdkError": SDKError;
2015
2142
  }
2016
2143
  /**
2017
- * Display an authentication dialog that allows the user to login or sign up. Callbacks are provided for events that
2018
- * occur during the process (especially successful completion). If the user is already authenticated with a valid
2019
- * session, this component will hide itself and fire the success callback immediately. It is up to the host application
2020
- * to render the next appropriate view for the application.
2021
- * To simplify some types of authentication flows, a visibility flag can force this component to never display. This
2022
- * allows you to susbcribe to notifications from the
2144
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
2145
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
2146
+ * host application to render the next appropriate view for the application.
2147
+ * To simplify UI development, a visibility flag can force this component to never display. This
2148
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
2023
2149
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
2024
2150
  * container to allow sufficient space for the required forms.
2025
- * As noted below, the primary event is `authenticated`. This will always be fired at least once, immediately after
2026
- * the widget is rendered and the user's status has been checked. It may be fired again as the user completes (or
2027
- * cancels) authentication steps.
2028
- * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
2029
- * embed. This Element will reuse the same session produced by logging in via that Embed.
2030
- * ```typescript
2031
- * interface IAuthStatus {
2032
- * // If true, the user is authenticated with a valid session
2033
- * authenticated: boolean;
2034
- * // Details for the user's session
2035
- * session: IActiveSession | null;
2036
- * }
2151
+ * ```ts
2152
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
2037
2153
  * ```
2038
2154
  */
2039
2155
  interface HTMLVerdocsAuthElement extends Components.VerdocsAuth, HTMLStencilElement {
@@ -2060,6 +2176,9 @@ declare global {
2060
2176
  }
2061
2177
  /**
2062
2178
  * Display a template building experience.
2179
+ * ```ts
2180
+ * <verdocs-build templateId={templateId} />
2181
+ * ```
2063
2182
  */
2064
2183
  interface HTMLVerdocsBuildElement extends Components.VerdocsBuild, HTMLStencilElement {
2065
2184
  addEventListener<K extends keyof HTMLVerdocsBuildElementEventMap>(type: K, listener: (this: HTMLVerdocsBuildElement, ev: VerdocsBuildCustomEvent<HTMLVerdocsBuildElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2075,12 +2194,33 @@ declare global {
2075
2194
  prototype: HTMLVerdocsBuildElement;
2076
2195
  new (): HTMLVerdocsBuildElement;
2077
2196
  };
2197
+ /**
2198
+ * A simple button, with consistent styling to other controls in the design system.
2199
+ * ```ts
2200
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
2201
+ * ```
2202
+ */
2078
2203
  interface HTMLVerdocsButtonElement extends Components.VerdocsButton, HTMLStencilElement {
2079
2204
  }
2080
2205
  var HTMLVerdocsButtonElement: {
2081
2206
  prototype: HTMLVerdocsButtonElement;
2082
2207
  new (): HTMLVerdocsButtonElement;
2083
2208
  };
2209
+ /**
2210
+ * Display an icon button that triggers a drop-down panel that can display
2211
+ * arbitrary child content, such as metadata, forms, or other controls.
2212
+ * ```ts
2213
+ * <verdocs-button-panel .icon=${icon}>
2214
+ * <h6>Field Settings</h6>
2215
+ * <form>
2216
+ * <p>
2217
+ * <label>Field Name</label>
2218
+ * <input type="text" placeholder="Field Name..." />
2219
+ * </p>
2220
+ * </form>
2221
+ * </verdocs-button-panel>
2222
+ * ```
2223
+ */
2084
2224
  interface HTMLVerdocsButtonPanelElement extends Components.VerdocsButtonPanel, HTMLStencilElement {
2085
2225
  }
2086
2226
  var HTMLVerdocsButtonPanelElement: {
@@ -2093,7 +2233,7 @@ declare global {
2093
2233
  * box for UI displays e.g. dialog boxes.
2094
2234
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
2095
2235
  * handler. Sample usage:
2096
- * ```html
2236
+ * ```ts
2097
2237
  * <verdocs-checkbox
2098
2238
  * value="on"
2099
2239
  * name="thingEnabled"
@@ -2167,6 +2307,21 @@ declare global {
2167
2307
  interface HTMLVerdocsDropdownElementEventMap {
2168
2308
  "optionSelected": IMenuOption;
2169
2309
  }
2310
+ /**
2311
+ * Display a drop-down menu button. A menu of the specified options will be displayed when the button is pressed. The menu will be hidden
2312
+ * when the button is pressed again, or an option is selected. Separators may be created by supplying an entry with an empty label.
2313
+ * ```ts
2314
+ * <verdocs-dropdown
2315
+ * options={[
2316
+ * {label: 'Option 1', disabled: true},
2317
+ * {label: 'Option 2', id: '2'}
2318
+ * {label: ''}
2319
+ * {label: 'Option 3', id: '2'}
2320
+ * ]}
2321
+ * label="OK" onClick={() => (console.log('OK clicked'))}
2322
+ * />
2323
+ * ```
2324
+ */
2170
2325
  interface HTMLVerdocsDropdownElement extends Components.VerdocsDropdown, HTMLStencilElement {
2171
2326
  addEventListener<K extends keyof HTMLVerdocsDropdownElementEventMap>(type: K, listener: (this: HTMLVerdocsDropdownElement, ev: VerdocsDropdownCustomEvent<HTMLVerdocsDropdownElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
2172
2327
  addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2301,7 +2456,7 @@ declare global {
2301
2456
  interface HTMLVerdocsFieldAttachmentElementEventMap {
2302
2457
  "settingsChanged": {fieldName: string; settings: ITemplateFieldSetting; field: ITemplateField};
2303
2458
  "deleted": {fieldName: string};
2304
- "attached": {data: string; lastModified: number; name: string; size: number; type: string};
2459
+ "attached": ISelectedFile;
2305
2460
  }
2306
2461
  /**
2307
2462
  * Displays an attachment field.
@@ -2369,8 +2524,7 @@ declare global {
2369
2524
  "deleted": {fieldName: string};
2370
2525
  }
2371
2526
  /**
2372
- * Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as
2373
- * input types like text and checkbox.
2527
+ * Displays a dropdown field that allows the user to choose one of a list of options.
2374
2528
  */
2375
2529
  interface HTMLVerdocsFieldDropdownElement extends Components.VerdocsFieldDropdown, HTMLStencilElement {
2376
2530
  addEventListener<K extends keyof HTMLVerdocsFieldDropdownElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldDropdownElement, ev: VerdocsFieldDropdownCustomEvent<HTMLVerdocsFieldDropdownElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2395,8 +2549,12 @@ declare global {
2395
2549
  "deleted": {fieldName: string};
2396
2550
  }
2397
2551
  /**
2398
- * Displays an initial field. If an initial already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
2399
- * button will be shown. Clicking the button will show a dialog to adopt an initial.
2552
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
2553
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
2554
+ * show a dialog to adopt an initial.
2555
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
2556
+ * This requires operation against a live, valid envelope. If you are testing this component
2557
+ * in Storybook, it will not be visible here.
2400
2558
  */
2401
2559
  interface HTMLVerdocsFieldInitialElement extends Components.VerdocsFieldInitial, HTMLStencilElement {
2402
2560
  addEventListener<K extends keyof HTMLVerdocsFieldInitialElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldInitialElement, ev: VerdocsFieldInitialCustomEvent<HTMLVerdocsFieldInitialElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2464,8 +2622,12 @@ declare global {
2464
2622
  "deleted": {fieldName: string};
2465
2623
  }
2466
2624
  /**
2467
- * Displays a signature field. If a signature already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
2468
- * button will be shown. Clicking the button will show a dialog to adopt a signature.
2625
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
2626
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
2627
+ * show a dialog to adopt a signature.
2628
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
2629
+ * This requires operation against a live, valid envelope. If you are testing this component
2630
+ * in Storybook, it will not be visible here.
2469
2631
  */
2470
2632
  interface HTMLVerdocsFieldSignatureElement extends Components.VerdocsFieldSignature, HTMLStencilElement {
2471
2633
  addEventListener<K extends keyof HTMLVerdocsFieldSignatureElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldSignatureElement, ev: VerdocsFieldSignatureCustomEvent<HTMLVerdocsFieldSignatureElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2486,7 +2648,8 @@ declare global {
2486
2648
  "deleted": {fieldName: string};
2487
2649
  }
2488
2650
  /**
2489
- * Display a multi-line text input field.
2651
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
2652
+ * as the BOTTOM-LEFT corner.
2490
2653
  */
2491
2654
  interface HTMLVerdocsFieldTextareaElement extends Components.VerdocsFieldTextarea, HTMLStencilElement {
2492
2655
  addEventListener<K extends keyof HTMLVerdocsFieldTextareaElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldTextareaElement, ev: VerdocsFieldTextareaCustomEvent<HTMLVerdocsFieldTextareaElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2507,7 +2670,7 @@ declare global {
2507
2670
  "deleted": {fieldName: string};
2508
2671
  }
2509
2672
  /**
2510
- * Display a text input field.
2673
+ * Display a simple 1-line text input field.
2511
2674
  */
2512
2675
  interface HTMLVerdocsFieldTextboxElement extends Components.VerdocsFieldTextbox, HTMLStencilElement {
2513
2676
  addEventListener<K extends keyof HTMLVerdocsFieldTextboxElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldTextboxElement, ev: VerdocsFieldTextboxCustomEvent<HTMLVerdocsFieldTextboxElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2528,7 +2691,8 @@ declare global {
2528
2691
  "deleted": {fieldName: string};
2529
2692
  }
2530
2693
  /**
2531
- * Display a timestamp field.
2694
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
2695
+ * filled when the signer submits the document.
2532
2696
  */
2533
2697
  interface HTMLVerdocsFieldTimestampElement extends Components.VerdocsFieldTimestamp, HTMLStencilElement {
2534
2698
  addEventListener<K extends keyof HTMLVerdocsFieldTimestampElementEventMap>(type: K, listener: (this: HTMLVerdocsFieldTimestampElement, ev: VerdocsFieldTimestampCustomEvent<HTMLVerdocsFieldTimestampElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2547,6 +2711,13 @@ declare global {
2547
2711
  interface HTMLVerdocsFileChooserElementEventMap {
2548
2712
  "fileSelected": {file: File | null};
2549
2713
  }
2714
+ /**
2715
+ * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
2716
+ * provide the actual upload functionality.
2717
+ * ```ts
2718
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
2719
+ * ```
2720
+ */
2550
2721
  interface HTMLVerdocsFileChooserElement extends Components.VerdocsFileChooser, HTMLStencilElement {
2551
2722
  addEventListener<K extends keyof HTMLVerdocsFileChooserElementEventMap>(type: K, listener: (this: HTMLVerdocsFileChooserElement, ev: VerdocsFileChooserCustomEvent<HTMLVerdocsFileChooserElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
2552
2723
  addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2561,23 +2732,12 @@ declare global {
2561
2732
  prototype: HTMLVerdocsFileChooserElement;
2562
2733
  new (): HTMLVerdocsFileChooserElement;
2563
2734
  };
2564
- interface HTMLVerdocsFloatingMenuElementEventMap {
2565
- "optionSelected": IOption;
2566
- }
2567
- interface HTMLVerdocsFloatingMenuElement extends Components.VerdocsFloatingMenu, HTMLStencilElement {
2568
- addEventListener<K extends keyof HTMLVerdocsFloatingMenuElementEventMap>(type: K, listener: (this: HTMLVerdocsFloatingMenuElement, ev: VerdocsFloatingMenuCustomEvent<HTMLVerdocsFloatingMenuElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
2569
- addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
2570
- addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
2571
- addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
2572
- removeEventListener<K extends keyof HTMLVerdocsFloatingMenuElementEventMap>(type: K, listener: (this: HTMLVerdocsFloatingMenuElement, ev: VerdocsFloatingMenuCustomEvent<HTMLVerdocsFloatingMenuElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
2573
- removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
2574
- removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
2575
- removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
2576
- }
2577
- var HTMLVerdocsFloatingMenuElement: {
2578
- prototype: HTMLVerdocsFloatingMenuElement;
2579
- new (): HTMLVerdocsFloatingMenuElement;
2580
- };
2735
+ /**
2736
+ * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
2737
+ * ```ts
2738
+ * <verdocs-help-icon text="Sample help text" />
2739
+ * ```
2740
+ */
2581
2741
  interface HTMLVerdocsHelpIconElement extends Components.VerdocsHelpIcon, HTMLStencilElement {
2582
2742
  }
2583
2743
  var HTMLVerdocsHelpIconElement: {
@@ -2611,9 +2771,7 @@ declare global {
2611
2771
  "next": string;
2612
2772
  }
2613
2773
  /**
2614
- * Display a text input field. This adds a partially-transparent overlay and screen-centered dialog
2615
- * box with a message and optional header/title. An OK button is shown that will dismiss the message.
2616
- * It can also be dismissed by clicking the background overlay.
2774
+ * Prompt the user to confirm their identity with a series of questions.
2617
2775
  */
2618
2776
  interface HTMLVerdocsKbaDialogElement extends Components.VerdocsKbaDialog, HTMLStencilElement {
2619
2777
  addEventListener<K extends keyof HTMLVerdocsKbaDialogElementEventMap>(type: K, listener: (this: HTMLVerdocsKbaDialogElement, ev: VerdocsKbaDialogCustomEvent<HTMLVerdocsKbaDialogElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2629,6 +2787,12 @@ declare global {
2629
2787
  prototype: HTMLVerdocsKbaDialogElement;
2630
2788
  new (): HTMLVerdocsKbaDialogElement;
2631
2789
  };
2790
+ /**
2791
+ * Animated loader placeholder. There are currently no configuration options for this control.
2792
+ * ```ts
2793
+ * <verdocs-loader />
2794
+ * ```
2795
+ */
2632
2796
  interface HTMLVerdocsLoaderElement extends Components.VerdocsLoader, HTMLStencilElement {
2633
2797
  }
2634
2798
  var HTMLVerdocsLoaderElement: {
@@ -2658,6 +2822,12 @@ declare global {
2658
2822
  prototype: HTMLVerdocsOkDialogElement;
2659
2823
  new (): HTMLVerdocsOkDialogElement;
2660
2824
  };
2825
+ /**
2826
+ * Display a small summary card describing an organization.
2827
+ * ```ts
2828
+ * <verdocs-organization-card organization={organization} />
2829
+ * ```
2830
+ */
2661
2831
  interface HTMLVerdocsOrganizationCardElement extends Components.VerdocsOrganizationCard, HTMLStencilElement {
2662
2832
  }
2663
2833
  var HTMLVerdocsOrganizationCardElement: {
@@ -2667,6 +2837,17 @@ declare global {
2667
2837
  interface HTMLVerdocsPaginationElementEventMap {
2668
2838
  "selectPage": {selectedPage: number};
2669
2839
  }
2840
+ /**
2841
+ * Display a simple pagination control with individual buttons to move through the data set.
2842
+ * ```ts
2843
+ * <verdocs-pagination
2844
+ * selectedPage={1}
2845
+ * itemCount={50}
2846
+ * perPage={10}
2847
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
2848
+ * />
2849
+ * ```
2850
+ */
2670
2851
  interface HTMLVerdocsPaginationElement extends Components.VerdocsPagination, HTMLStencilElement {
2671
2852
  addEventListener<K extends keyof HTMLVerdocsPaginationElementEventMap>(type: K, listener: (this: HTMLVerdocsPaginationElement, ev: VerdocsPaginationCustomEvent<HTMLVerdocsPaginationElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
2672
2853
  addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2684,6 +2865,24 @@ declare global {
2684
2865
  interface HTMLVerdocsPortalElementEventMap {
2685
2866
  "clickAway": void;
2686
2867
  }
2868
+ /**
2869
+ * Display a child component in a "portal", popping it out of the main DOM tree
2870
+ * to allow it to escape the bounds set by its parent.
2871
+ * @credit https://github.com/tomas-teston/stencil-portal for the basic
2872
+ * technique. This has been altered in a few ways to make it more friendly
2873
+ * to cases where there may be multiple portals on the page and provide more
2874
+ * alignment options for the child to be displayed.
2875
+ * ```ts
2876
+ * <div style="padding: 40px">
2877
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
2878
+ * Tooltip Anchor
2879
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
2880
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
2881
+ * </verdocs-portal>
2882
+ * </div>
2883
+ * </div>
2884
+ * ```
2885
+ */
2687
2886
  interface HTMLVerdocsPortalElement extends Components.VerdocsPortal, HTMLStencilElement {
2688
2887
  addEventListener<K extends keyof HTMLVerdocsPortalElementEventMap>(type: K, listener: (this: HTMLVerdocsPortalElement, ev: VerdocsPortalCustomEvent<HTMLVerdocsPortalElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
2689
2888
  addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2705,6 +2904,9 @@ declare global {
2705
2904
  * Display a template preview experience. This will display the template's attached
2706
2905
  * documents with signing fields overlaid on each page. Fields will be color-coded
2707
2906
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
2907
+ * ```ts
2908
+ * <verdocs-preview templateId={templateId} />
2909
+ * ```
2708
2910
  */
2709
2911
  interface HTMLVerdocsPreviewElement extends Components.VerdocsPreview, HTMLStencilElement {
2710
2912
  addEventListener<K extends keyof HTMLVerdocsPreviewElementEventMap>(type: K, listener: (this: HTMLVerdocsPreviewElement, ev: VerdocsPreviewCustomEvent<HTMLVerdocsPreviewElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2720,6 +2922,12 @@ declare global {
2720
2922
  prototype: HTMLVerdocsPreviewElement;
2721
2923
  new (): HTMLVerdocsPreviewElement;
2722
2924
  };
2925
+ /**
2926
+ * Display a simple progress bar in a style consistent with the design system.
2927
+ * ```ts
2928
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
2929
+ * ```
2930
+ */
2723
2931
  interface HTMLVerdocsProgressBarElement extends Components.VerdocsProgressBar, HTMLStencilElement {
2724
2932
  }
2725
2933
  var HTMLVerdocsProgressBarElement: {
@@ -2731,6 +2939,9 @@ declare global {
2731
2939
  }
2732
2940
  /**
2733
2941
  * Display a drop-down menu of quick filter options.
2942
+ * ```ts
2943
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
2944
+ * ```
2734
2945
  */
2735
2946
  interface HTMLVerdocsQuickFilterElement extends Components.VerdocsQuickFilter, HTMLStencilElement {
2736
2947
  addEventListener<K extends keyof HTMLVerdocsQuickFilterElementEventMap>(type: K, listener: (this: HTMLVerdocsQuickFilterElement, ev: VerdocsQuickFilterCustomEvent<HTMLVerdocsQuickFilterElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2775,7 +2986,7 @@ declare global {
2775
2986
  * simple radio button for UI displays e.g. dialog boxes.
2776
2987
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
2777
2988
  * handler. Sample usage:
2778
- * ```html
2989
+ * ```ts
2779
2990
  * <verdocs-radio-button
2780
2991
  * value="val1"
2781
2992
  * name="someProperty"
@@ -2830,7 +3041,11 @@ declare global {
2830
3041
  /**
2831
3042
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
2832
3043
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
2833
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
3044
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
3045
+ * ```ts
3046
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
3047
+ * @input ={() => {}} />
3048
+ * ```
2834
3049
  */
2835
3050
  interface HTMLVerdocsSelectInputElement extends Components.VerdocsSelectInput, HTMLStencilElement {
2836
3051
  }
@@ -2846,12 +3061,18 @@ declare global {
2846
3061
  "searchContacts": IContactSearchEvent1;
2847
3062
  }
2848
3063
  /**
2849
- * Display a form to collect recipient information for a new Envelope. If used anonymously, the specified `templateId` must be public.
2850
- * Because most applications have custom workflow requirements to trigger after sending an Envelope, this component does not actually
2851
- * perform that operation. Parent applications should listen for the `onSend` event, and can pass the contents of `event.detail`
2852
- * directly to the `createEnvelope()` call in JS-SDK.
2853
- * Host applications should ensure the template is "sendable" before displaying this component. To be sendable, a template must have
2854
- * at least one document attached, at least one participant defined, and at least one field assigned to every "signer" participant.
3064
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
3065
+ * that because most applications have custom workflow requirements to trigger after sending an
3066
+ * Envelope, this component does not actually perform that operation. Parent applications should
3067
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
3068
+ * `createEnvelope()` call in JS-SDK.
3069
+ * Host applications should ensure the template is "sendable" before displaying this component.
3070
+ * To be sendable, a template must have at least one document attached, at least one participant
3071
+ * defined, and at least one field assigned to every "signer" participant. This component will
3072
+ * hide itself if the template is not sendable.
3073
+ * ```ts
3074
+ * <verdocs-send templateId={templateId} />
3075
+ * ```
2855
3076
  */
2856
3077
  interface HTMLVerdocsSendElement extends Components.VerdocsSend, HTMLStencilElement {
2857
3078
  addEventListener<K extends keyof HTMLVerdocsSendElementEventMap>(type: K, listener: (this: HTMLVerdocsSendElement, ev: VerdocsSendCustomEvent<HTMLVerdocsSendElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2874,6 +3095,9 @@ declare global {
2874
3095
  * Display a template preview experience. This will display the template's attached
2875
3096
  * documents with signing fields overlaid on each page. Fields will be color-coded
2876
3097
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
3098
+ * ```ts
3099
+ * <verdocs-settings />
3100
+ * ```
2877
3101
  */
2878
3102
  interface HTMLVerdocsSettingsElement extends Components.VerdocsSettings, HTMLStencilElement {
2879
3103
  addEventListener<K extends keyof HTMLVerdocsSettingsElementEventMap>(type: K, listener: (this: HTMLVerdocsSettingsElement, ev: VerdocsSettingsCustomEvent<HTMLVerdocsSettingsElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3035,6 +3259,9 @@ declare global {
3035
3259
  };
3036
3260
  /**
3037
3261
  * Display a small loading spinner.
3262
+ * ```ts
3263
+ * <verdocs-spinner />
3264
+ * ```
3038
3265
  */
3039
3266
  interface HTMLVerdocsSpinnerElement extends Components.VerdocsSpinner, HTMLStencilElement {
3040
3267
  }
@@ -3062,6 +3289,9 @@ declare global {
3062
3289
  /**
3063
3290
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
3064
3291
  * support creating interactive table layouts.
3292
+ * ```ts
3293
+ * <verdocs-table columns={[...columns]} data={[...data]} />
3294
+ * ```
3065
3295
  */
3066
3296
  interface HTMLVerdocsTableElement extends Components.VerdocsTable, HTMLStencilElement {
3067
3297
  addEventListener<K extends keyof HTMLVerdocsTableElementEventMap>(type: K, listener: (this: HTMLVerdocsTableElement, ev: VerdocsTableCustomEvent<HTMLVerdocsTableElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3083,6 +3313,9 @@ declare global {
3083
3313
  /**
3084
3314
  * Display a simple row of selectable tabs. This is a controlled element.
3085
3315
  * The parent must adjust selectedTab as selection events are fired.
3316
+ * ```ts
3317
+ * <verdocs-tabs tabs={[...tabs]} />
3318
+ * ```
3086
3319
  */
3087
3320
  interface HTMLVerdocsTabsElement extends Components.VerdocsTabs, HTMLStencilElement {
3088
3321
  addEventListener<K extends keyof HTMLVerdocsTabsElementEventMap>(type: K, listener: (this: HTMLVerdocsTabsElement, ev: VerdocsTabsCustomEvent<HTMLVerdocsTabsElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3438,7 +3671,10 @@ declare global {
3438
3671
  /**
3439
3672
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
3440
3673
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
3441
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
3674
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
3675
+ * ```ts
3676
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
3677
+ * ```
3442
3678
  */
3443
3679
  interface HTMLVerdocsTextInputElement extends Components.VerdocsTextInput, HTMLStencilElement {
3444
3680
  }
@@ -3447,7 +3683,10 @@ declare global {
3447
3683
  new (): HTMLVerdocsTextInputElement;
3448
3684
  };
3449
3685
  /**
3450
- * Displays a label and a set of buttons, also allowing a default selection of a button
3686
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
3687
+ * ```ts
3688
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
3689
+ * ```
3451
3690
  */
3452
3691
  interface HTMLVerdocsToggleElement extends Components.VerdocsToggle, HTMLStencilElement {
3453
3692
  }
@@ -3460,6 +3699,9 @@ declare global {
3460
3699
  }
3461
3700
  /**
3462
3701
  * Displays a single button that can be toggled on or off by clicking it.
3702
+ * ```ts
3703
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
3704
+ * ```
3463
3705
  */
3464
3706
  interface HTMLVerdocsToggleButtonElement extends Components.VerdocsToggleButton, HTMLStencilElement {
3465
3707
  addEventListener<K extends keyof HTMLVerdocsToggleButtonElementEventMap>(type: K, listener: (this: HTMLVerdocsToggleButtonElement, ev: VerdocsToggleButtonCustomEvent<HTMLVerdocsToggleButtonElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3477,6 +3719,9 @@ declare global {
3477
3719
  };
3478
3720
  /**
3479
3721
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
3722
+ * ```ts
3723
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
3724
+ * ```
3480
3725
  */
3481
3726
  interface HTMLVerdocsToolbarIconElement extends Components.VerdocsToolbarIcon, HTMLStencilElement {
3482
3727
  }
@@ -3559,7 +3804,6 @@ declare global {
3559
3804
  "verdocs-field-textbox": HTMLVerdocsFieldTextboxElement;
3560
3805
  "verdocs-field-timestamp": HTMLVerdocsFieldTimestampElement;
3561
3806
  "verdocs-file-chooser": HTMLVerdocsFileChooserElement;
3562
- "verdocs-floating-menu": HTMLVerdocsFloatingMenuElement;
3563
3807
  "verdocs-help-icon": HTMLVerdocsHelpIconElement;
3564
3808
  "verdocs-initial-dialog": HTMLVerdocsInitialDialogElement;
3565
3809
  "verdocs-kba-dialog": HTMLVerdocsKbaDialogElement;
@@ -3650,26 +3894,15 @@ declare namespace LocalJSX {
3650
3894
  "view"?: 'completed' | 'action' | 'waiting';
3651
3895
  }
3652
3896
  /**
3653
- * Display an authentication dialog that allows the user to login or sign up. Callbacks are provided for events that
3654
- * occur during the process (especially successful completion). If the user is already authenticated with a valid
3655
- * session, this component will hide itself and fire the success callback immediately. It is up to the host application
3656
- * to render the next appropriate view for the application.
3657
- * To simplify some types of authentication flows, a visibility flag can force this component to never display. This
3658
- * allows you to susbcribe to notifications from the
3897
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
3898
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
3899
+ * host application to render the next appropriate view for the application.
3900
+ * To simplify UI development, a visibility flag can force this component to never display. This
3901
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
3659
3902
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
3660
3903
  * container to allow sufficient space for the required forms.
3661
- * As noted below, the primary event is `authenticated`. This will always be fired at least once, immediately after
3662
- * the widget is rendered and the user's status has been checked. It may be fired again as the user completes (or
3663
- * cancels) authentication steps.
3664
- * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
3665
- * embed. This Element will reuse the same session produced by logging in via that Embed.
3666
- * ```typescript
3667
- * interface IAuthStatus {
3668
- * // If true, the user is authenticated with a valid session
3669
- * authenticated: boolean;
3670
- * // Details for the user's session
3671
- * session: IActiveSession | null;
3672
- * }
3904
+ * ```ts
3905
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
3673
3906
  * ```
3674
3907
  */
3675
3908
  interface VerdocsAuth {
@@ -3682,7 +3915,7 @@ declare namespace LocalJSX {
3682
3915
  */
3683
3916
  "logo"?: string;
3684
3917
  /**
3685
- * Event fired when session authentication process has completed. Check the event contents for completion status.
3918
+ * Event fired when session authentication process has completed. Check the event contents for completion status. This event will always be called at least once, when the component is first rendered.
3686
3919
  */
3687
3920
  "onAuthenticated"?: (event: VerdocsAuthCustomEvent<IAuthStatus>) => void;
3688
3921
  /**
@@ -3696,6 +3929,9 @@ declare namespace LocalJSX {
3696
3929
  }
3697
3930
  /**
3698
3931
  * Display a template building experience.
3932
+ * ```ts
3933
+ * <verdocs-build templateId={templateId} />
3934
+ * ```
3699
3935
  */
3700
3936
  interface VerdocsBuild {
3701
3937
  /**
@@ -3735,6 +3971,12 @@ declare namespace LocalJSX {
3735
3971
  */
3736
3972
  "templateId"?: string | null;
3737
3973
  }
3974
+ /**
3975
+ * A simple button, with consistent styling to other controls in the design system.
3976
+ * ```ts
3977
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
3978
+ * ```
3979
+ */
3738
3980
  interface VerdocsButton {
3739
3981
  /**
3740
3982
  * Whether the button should be disabled.
@@ -3765,6 +4007,21 @@ declare namespace LocalJSX {
3765
4007
  */
3766
4008
  "variant"?: 'standard' | 'text' | 'outline';
3767
4009
  }
4010
+ /**
4011
+ * Display an icon button that triggers a drop-down panel that can display
4012
+ * arbitrary child content, such as metadata, forms, or other controls.
4013
+ * ```ts
4014
+ * <verdocs-button-panel .icon=${icon}>
4015
+ * <h6>Field Settings</h6>
4016
+ * <form>
4017
+ * <p>
4018
+ * <label>Field Name</label>
4019
+ * <input type="text" placeholder="Field Name..." />
4020
+ * </p>
4021
+ * </form>
4022
+ * </verdocs-button-panel>
4023
+ * ```
4024
+ */
3768
4025
  interface VerdocsButtonPanel {
3769
4026
  /**
3770
4027
  * SVG icon to display
@@ -3777,7 +4034,7 @@ declare namespace LocalJSX {
3777
4034
  * box for UI displays e.g. dialog boxes.
3778
4035
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
3779
4036
  * handler. Sample usage:
3780
- * ```html
4037
+ * ```ts
3781
4038
  * <verdocs-checkbox
3782
4039
  * value="on"
3783
4040
  * name="thingEnabled"
@@ -3864,6 +4121,21 @@ declare namespace LocalJSX {
3864
4121
  */
3865
4122
  "onExit"?: (event: VerdocsDialogCustomEvent<any>) => void;
3866
4123
  }
4124
+ /**
4125
+ * Display a drop-down menu button. A menu of the specified options will be displayed when the button is pressed. The menu will be hidden
4126
+ * when the button is pressed again, or an option is selected. Separators may be created by supplying an entry with an empty label.
4127
+ * ```ts
4128
+ * <verdocs-dropdown
4129
+ * options={[
4130
+ * {label: 'Option 1', disabled: true},
4131
+ * {label: 'Option 2', id: '2'}
4132
+ * {label: ''}
4133
+ * {label: 'Option 3', id: '2'}
4134
+ * ]}
4135
+ * label="OK" onClick={() => (console.log('OK clicked'))}
4136
+ * />
4137
+ * ```
4138
+ */
3867
4139
  interface VerdocsDropdown {
3868
4140
  /**
3869
4141
  * 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.
@@ -4092,6 +4364,10 @@ declare namespace LocalJSX {
4092
4364
  * If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be changed, so it should typically only be enabled in the Builder.
4093
4365
  */
4094
4366
  "editable"?: boolean;
4367
+ /**
4368
+ * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used. This component self-manages its resize (width) behavior when in edit-template mode, and uses this endpoint to save changes.
4369
+ */
4370
+ "endpoint"?: VerdocsEndpoint;
4095
4371
  /**
4096
4372
  * The name of the field to display.
4097
4373
  */
@@ -4103,7 +4379,7 @@ declare namespace LocalJSX {
4103
4379
  /**
4104
4380
  * Event fired when the field is deleted.
4105
4381
  */
4106
- "onAttached"?: (event: VerdocsFieldAttachmentCustomEvent<{data: string; lastModified: number; name: string; size: number; type: string}>) => void;
4382
+ "onAttached"?: (event: VerdocsFieldAttachmentCustomEvent<ISelectedFile>) => void;
4107
4383
  /**
4108
4384
  * Event fired when the field is deleted.
4109
4385
  */
@@ -4240,8 +4516,7 @@ declare namespace LocalJSX {
4240
4516
  "yscale"?: number;
4241
4517
  }
4242
4518
  /**
4243
- * Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as
4244
- * input types like text and checkbox.
4519
+ * Displays a dropdown field that allows the user to choose one of a list of options.
4245
4520
  */
4246
4521
  interface VerdocsFieldDropdown {
4247
4522
  /**
@@ -4294,8 +4569,12 @@ declare namespace LocalJSX {
4294
4569
  "yscale"?: number;
4295
4570
  }
4296
4571
  /**
4297
- * Displays an initial field. If an initial already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
4298
- * button will be shown. Clicking the button will show a dialog to adopt an initial.
4572
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
4573
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
4574
+ * show a dialog to adopt an initial.
4575
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
4576
+ * This requires operation against a live, valid envelope. If you are testing this component
4577
+ * in Storybook, it will not be visible here.
4299
4578
  */
4300
4579
  interface VerdocsFieldInitial {
4301
4580
  /**
@@ -4471,8 +4750,12 @@ declare namespace LocalJSX {
4471
4750
  "yscale"?: number;
4472
4751
  }
4473
4752
  /**
4474
- * Displays a signature field. If a signature already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
4475
- * button will be shown. Clicking the button will show a dialog to adopt a signature.
4753
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
4754
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
4755
+ * show a dialog to adopt a signature.
4756
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
4757
+ * This requires operation against a live, valid envelope. If you are testing this component
4758
+ * in Storybook, it will not be visible here.
4476
4759
  */
4477
4760
  interface VerdocsFieldSignature {
4478
4761
  /**
@@ -4533,7 +4816,8 @@ declare namespace LocalJSX {
4533
4816
  "yscale"?: number;
4534
4817
  }
4535
4818
  /**
4536
- * Display a multi-line text input field.
4819
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
4820
+ * as the BOTTOM-LEFT corner.
4537
4821
  */
4538
4822
  interface VerdocsFieldTextarea {
4539
4823
  /**
@@ -4586,7 +4870,7 @@ declare namespace LocalJSX {
4586
4870
  "yscale"?: number;
4587
4871
  }
4588
4872
  /**
4589
- * Display a text input field.
4873
+ * Display a simple 1-line text input field.
4590
4874
  */
4591
4875
  interface VerdocsFieldTextbox {
4592
4876
  /**
@@ -4639,7 +4923,8 @@ declare namespace LocalJSX {
4639
4923
  "yscale"?: number;
4640
4924
  }
4641
4925
  /**
4642
- * Display a timestamp field.
4926
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
4927
+ * filled when the signer submits the document.
4643
4928
  */
4644
4929
  interface VerdocsFieldTimestamp {
4645
4930
  /**
@@ -4687,6 +4972,13 @@ declare namespace LocalJSX {
4687
4972
  */
4688
4973
  "yscale"?: number;
4689
4974
  }
4975
+ /**
4976
+ * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
4977
+ * provide the actual upload functionality.
4978
+ * ```ts
4979
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
4980
+ * ```
4981
+ */
4690
4982
  interface VerdocsFileChooser {
4691
4983
  /**
4692
4984
  * The endpoint to use to communicate with Verdocs. If not set, the default endpoint will be used.
@@ -4697,16 +4989,12 @@ declare namespace LocalJSX {
4697
4989
  */
4698
4990
  "onFileSelected"?: (event: VerdocsFileChooserCustomEvent<{file: File | null}>) => void;
4699
4991
  }
4700
- interface VerdocsFloatingMenu {
4701
- /**
4702
- * 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.
4703
- */
4704
- "onOptionSelected"?: (event: VerdocsFloatingMenuCustomEvent<IOption>) => void;
4705
- /**
4706
- * The role that this contact will be assigned to.
4707
- */
4708
- "options"?: IOption[];
4709
- }
4992
+ /**
4993
+ * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
4994
+ * ```ts
4995
+ * <verdocs-help-icon text="Sample help text" />
4996
+ * ```
4997
+ */
4710
4998
  interface VerdocsHelpIcon {
4711
4999
  /**
4712
5000
  * Optional icon to display. If not supplied, a standard help icon will be shown.
@@ -4736,9 +5024,7 @@ declare namespace LocalJSX {
4736
5024
  "onNext"?: (event: VerdocsInitialDialogCustomEvent<string>) => void;
4737
5025
  }
4738
5026
  /**
4739
- * Display a text input field. This adds a partially-transparent overlay and screen-centered dialog
4740
- * box with a message and optional header/title. An OK button is shown that will dismiss the message.
4741
- * It can also be dismissed by clicking the background overlay.
5027
+ * Prompt the user to confirm their identity with a series of questions.
4742
5028
  */
4743
5029
  interface VerdocsKbaDialog {
4744
5030
  /**
@@ -4782,6 +5068,12 @@ declare namespace LocalJSX {
4782
5068
  */
4783
5069
  "steps"?: number;
4784
5070
  }
5071
+ /**
5072
+ * Animated loader placeholder. There are currently no configuration options for this control.
5073
+ * ```ts
5074
+ * <verdocs-loader />
5075
+ * ```
5076
+ */
4785
5077
  interface VerdocsLoader {
4786
5078
  }
4787
5079
  /**
@@ -4815,12 +5107,29 @@ declare namespace LocalJSX {
4815
5107
  */
4816
5108
  "showCancel"?: boolean;
4817
5109
  }
5110
+ /**
5111
+ * Display a small summary card describing an organization.
5112
+ * ```ts
5113
+ * <verdocs-organization-card organization={organization} />
5114
+ * ```
5115
+ */
4818
5116
  interface VerdocsOrganizationCard {
4819
5117
  /**
4820
5118
  * The organization to display
4821
5119
  */
4822
5120
  "organization"?: IOrganization;
4823
5121
  }
5122
+ /**
5123
+ * Display a simple pagination control with individual buttons to move through the data set.
5124
+ * ```ts
5125
+ * <verdocs-pagination
5126
+ * selectedPage={1}
5127
+ * itemCount={50}
5128
+ * perPage={10}
5129
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
5130
+ * />
5131
+ * ```
5132
+ */
4824
5133
  interface VerdocsPagination {
4825
5134
  /**
4826
5135
  * The total number of items.
@@ -4839,6 +5148,24 @@ declare namespace LocalJSX {
4839
5148
  */
4840
5149
  "selectedPage"?: number;
4841
5150
  }
5151
+ /**
5152
+ * Display a child component in a "portal", popping it out of the main DOM tree
5153
+ * to allow it to escape the bounds set by its parent.
5154
+ * @credit https://github.com/tomas-teston/stencil-portal for the basic
5155
+ * technique. This has been altered in a few ways to make it more friendly
5156
+ * to cases where there may be multiple portals on the page and provide more
5157
+ * alignment options for the child to be displayed.
5158
+ * ```ts
5159
+ * <div style="padding: 40px">
5160
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
5161
+ * Tooltip Anchor
5162
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
5163
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
5164
+ * </verdocs-portal>
5165
+ * </div>
5166
+ * </div>
5167
+ * ```
5168
+ */
4842
5169
  interface VerdocsPortal {
4843
5170
  /**
4844
5171
  * Horizontal alignment.
@@ -4858,6 +5185,9 @@ declare namespace LocalJSX {
4858
5185
  * Display a template preview experience. This will display the template's attached
4859
5186
  * documents with signing fields overlaid on each page. Fields will be color-coded
4860
5187
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
5188
+ * ```ts
5189
+ * <verdocs-preview templateId={templateId} />
5190
+ * ```
4861
5191
  */
4862
5192
  interface VerdocsPreview {
4863
5193
  /**
@@ -4873,6 +5203,12 @@ declare namespace LocalJSX {
4873
5203
  */
4874
5204
  "templateId"?: string | null;
4875
5205
  }
5206
+ /**
5207
+ * Display a simple progress bar in a style consistent with the design system.
5208
+ * ```ts
5209
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
5210
+ * ```
5211
+ */
4876
5212
  interface VerdocsProgressBar {
4877
5213
  /**
4878
5214
  * Optional label to display above the bar
@@ -4889,6 +5225,9 @@ declare namespace LocalJSX {
4889
5225
  }
4890
5226
  /**
4891
5227
  * Display a drop-down menu of quick filter options.
5228
+ * ```ts
5229
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
5230
+ * ```
4892
5231
  */
4893
5232
  interface VerdocsQuickFilter {
4894
5233
  "label"?: string;
@@ -4928,7 +5267,7 @@ declare namespace LocalJSX {
4928
5267
  * simple radio button for UI displays e.g. dialog boxes.
4929
5268
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
4930
5269
  * handler. Sample usage:
4931
- * ```html
5270
+ * ```ts
4932
5271
  * <verdocs-radio-button
4933
5272
  * value="val1"
4934
5273
  * name="someProperty"
@@ -5006,7 +5345,11 @@ declare namespace LocalJSX {
5006
5345
  /**
5007
5346
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
5008
5347
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
5009
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
5348
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
5349
+ * ```ts
5350
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
5351
+ * @input ={() => {}} />
5352
+ * ```
5010
5353
  */
5011
5354
  interface VerdocsSelectInput {
5012
5355
  /**
@@ -5027,12 +5370,18 @@ declare namespace LocalJSX {
5027
5370
  "value"?: string;
5028
5371
  }
5029
5372
  /**
5030
- * Display a form to collect recipient information for a new Envelope. If used anonymously, the specified `templateId` must be public.
5031
- * Because most applications have custom workflow requirements to trigger after sending an Envelope, this component does not actually
5032
- * perform that operation. Parent applications should listen for the `onSend` event, and can pass the contents of `event.detail`
5033
- * directly to the `createEnvelope()` call in JS-SDK.
5034
- * Host applications should ensure the template is "sendable" before displaying this component. To be sendable, a template must have
5035
- * at least one document attached, at least one participant defined, and at least one field assigned to every "signer" participant.
5373
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
5374
+ * that because most applications have custom workflow requirements to trigger after sending an
5375
+ * Envelope, this component does not actually perform that operation. Parent applications should
5376
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
5377
+ * `createEnvelope()` call in JS-SDK.
5378
+ * Host applications should ensure the template is "sendable" before displaying this component.
5379
+ * To be sendable, a template must have at least one document attached, at least one participant
5380
+ * defined, and at least one field assigned to every "signer" participant. This component will
5381
+ * hide itself if the template is not sendable.
5382
+ * ```ts
5383
+ * <verdocs-send templateId={templateId} />
5384
+ * ```
5036
5385
  */
5037
5386
  interface VerdocsSend {
5038
5387
  /**
@@ -5072,6 +5421,9 @@ declare namespace LocalJSX {
5072
5421
  * Display a template preview experience. This will display the template's attached
5073
5422
  * documents with signing fields overlaid on each page. Fields will be color-coded
5074
5423
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
5424
+ * ```ts
5425
+ * <verdocs-settings />
5426
+ * ```
5075
5427
  */
5076
5428
  interface VerdocsSettings {
5077
5429
  /**
@@ -5232,6 +5584,9 @@ declare namespace LocalJSX {
5232
5584
  }
5233
5585
  /**
5234
5586
  * Display a small loading spinner.
5587
+ * ```ts
5588
+ * <verdocs-spinner />
5589
+ * ```
5235
5590
  */
5236
5591
  interface VerdocsSpinner {
5237
5592
  "mode"?: 'light' | 'dark';
@@ -5265,6 +5620,9 @@ declare namespace LocalJSX {
5265
5620
  /**
5266
5621
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
5267
5622
  * support creating interactive table layouts.
5623
+ * ```ts
5624
+ * <verdocs-table columns={[...columns]} data={[...data]} />
5625
+ * ```
5268
5626
  */
5269
5627
  interface VerdocsTable {
5270
5628
  /**
@@ -5287,6 +5645,9 @@ declare namespace LocalJSX {
5287
5645
  /**
5288
5646
  * Display a simple row of selectable tabs. This is a controlled element.
5289
5647
  * The parent must adjust selectedTab as selection events are fired.
5648
+ * ```ts
5649
+ * <verdocs-tabs tabs={[...tabs]} />
5650
+ * ```
5290
5651
  */
5291
5652
  interface VerdocsTabs {
5292
5653
  /**
@@ -5783,7 +6144,10 @@ declare namespace LocalJSX {
5783
6144
  /**
5784
6145
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
5785
6146
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
5786
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
6147
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
6148
+ * ```ts
6149
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
6150
+ * ```
5787
6151
  */
5788
6152
  interface VerdocsTextInput {
5789
6153
  /**
@@ -5828,7 +6192,10 @@ declare namespace LocalJSX {
5828
6192
  "value"?: string;
5829
6193
  }
5830
6194
  /**
5831
- * Displays a label and a set of buttons, also allowing a default selection of a button
6195
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
6196
+ * ```ts
6197
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
6198
+ * ```
5832
6199
  */
5833
6200
  interface VerdocsToggle {
5834
6201
  /**
@@ -5842,6 +6209,9 @@ declare namespace LocalJSX {
5842
6209
  }
5843
6210
  /**
5844
6211
  * Displays a single button that can be toggled on or off by clicking it.
6212
+ * ```ts
6213
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
6214
+ * ```
5845
6215
  */
5846
6216
  interface VerdocsToggleButton {
5847
6217
  "active"?: boolean;
@@ -5864,6 +6234,9 @@ declare namespace LocalJSX {
5864
6234
  }
5865
6235
  /**
5866
6236
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
6237
+ * ```ts
6238
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
6239
+ * ```
5867
6240
  */
5868
6241
  interface VerdocsToolbarIcon {
5869
6242
  /**
@@ -5959,7 +6332,6 @@ declare namespace LocalJSX {
5959
6332
  "verdocs-field-textbox": VerdocsFieldTextbox;
5960
6333
  "verdocs-field-timestamp": VerdocsFieldTimestamp;
5961
6334
  "verdocs-file-chooser": VerdocsFileChooser;
5962
- "verdocs-floating-menu": VerdocsFloatingMenu;
5963
6335
  "verdocs-help-icon": VerdocsHelpIcon;
5964
6336
  "verdocs-initial-dialog": VerdocsInitialDialog;
5965
6337
  "verdocs-kba-dialog": VerdocsKbaDialog;
@@ -6024,34 +6396,47 @@ declare module "@stencil/core" {
6024
6396
  */
6025
6397
  "verdocs-activity-box": LocalJSX.VerdocsActivityBox & JSXBase.HTMLAttributes<HTMLVerdocsActivityBoxElement>;
6026
6398
  /**
6027
- * Display an authentication dialog that allows the user to login or sign up. Callbacks are provided for events that
6028
- * occur during the process (especially successful completion). If the user is already authenticated with a valid
6029
- * session, this component will hide itself and fire the success callback immediately. It is up to the host application
6030
- * to render the next appropriate view for the application.
6031
- * To simplify some types of authentication flows, a visibility flag can force this component to never display. This
6032
- * allows you to susbcribe to notifications from the
6399
+ * Display an authentication dialog that allows the user to login or sign up. If the user is already authenticated
6400
+ * with a valid session, this component will hide itself and fire the success callback immediately. It is up to the
6401
+ * host application to render the next appropriate view for the application.
6402
+ * To simplify UI development, a visibility flag can force this component to never display. This
6403
+ * allows you to susbcribe to notifications from client apps without calling the lower-level JS SDK.
6033
6404
  * This embed is responsive / mobile-friendly, but the calling application should provide at least a 300px wide
6034
6405
  * container to allow sufficient space for the required forms.
6035
- * As noted below, the primary event is `authenticated`. This will always be fired at least once, immediately after
6036
- * the widget is rendered and the user's status has been checked. It may be fired again as the user completes (or
6037
- * cancels) authentication steps.
6038
- * Authentication is required to demonstrate this Element. You may do this in Storybook by using the Auth
6039
- * embed. This Element will reuse the same session produced by logging in via that Embed.
6040
- * ```typescript
6041
- * interface IAuthStatus {
6042
- * // If true, the user is authenticated with a valid session
6043
- * authenticated: boolean;
6044
- * // Details for the user's session
6045
- * session: IActiveSession | null;
6046
- * }
6406
+ * ```ts
6407
+ * <verdocs-auth onAuthenticated={e => console.log('Authentication state:', e.detail)} />
6047
6408
  * ```
6048
6409
  */
6049
6410
  "verdocs-auth": LocalJSX.VerdocsAuth & JSXBase.HTMLAttributes<HTMLVerdocsAuthElement>;
6050
6411
  /**
6051
6412
  * Display a template building experience.
6413
+ * ```ts
6414
+ * <verdocs-build templateId={templateId} />
6415
+ * ```
6052
6416
  */
6053
6417
  "verdocs-build": LocalJSX.VerdocsBuild & JSXBase.HTMLAttributes<HTMLVerdocsBuildElement>;
6418
+ /**
6419
+ * A simple button, with consistent styling to other controls in the design system.
6420
+ * ```ts
6421
+ * <verdocs-button label="Click Me" size="normal" variant="standard" />
6422
+ * ```
6423
+ */
6054
6424
  "verdocs-button": LocalJSX.VerdocsButton & JSXBase.HTMLAttributes<HTMLVerdocsButtonElement>;
6425
+ /**
6426
+ * Display an icon button that triggers a drop-down panel that can display
6427
+ * arbitrary child content, such as metadata, forms, or other controls.
6428
+ * ```ts
6429
+ * <verdocs-button-panel .icon=${icon}>
6430
+ * <h6>Field Settings</h6>
6431
+ * <form>
6432
+ * <p>
6433
+ * <label>Field Name</label>
6434
+ * <input type="text" placeholder="Field Name..." />
6435
+ * </p>
6436
+ * </form>
6437
+ * </verdocs-button-panel>
6438
+ * ```
6439
+ */
6055
6440
  "verdocs-button-panel": LocalJSX.VerdocsButtonPanel & JSXBase.HTMLAttributes<HTMLVerdocsButtonPanelElement>;
6056
6441
  /**
6057
6442
  * Displays a check box. Note that this is different from the `verdocs-field-checkbox` component, which is designed
@@ -6059,7 +6444,7 @@ declare module "@stencil/core" {
6059
6444
  * box for UI displays e.g. dialog boxes.
6060
6445
  * This control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`
6061
6446
  * handler. Sample usage:
6062
- * ```html
6447
+ * ```ts
6063
6448
  * <verdocs-checkbox
6064
6449
  * value="on"
6065
6450
  * name="thingEnabled"
@@ -6086,6 +6471,21 @@ declare module "@stencil/core" {
6086
6471
  * Display a simple dialog where the contents are provided via slots.
6087
6472
  */
6088
6473
  "verdocs-dialog": LocalJSX.VerdocsDialog & JSXBase.HTMLAttributes<HTMLVerdocsDialogElement>;
6474
+ /**
6475
+ * Display a drop-down menu button. A menu of the specified options will be displayed when the button is pressed. The menu will be hidden
6476
+ * when the button is pressed again, or an option is selected. Separators may be created by supplying an entry with an empty label.
6477
+ * ```ts
6478
+ * <verdocs-dropdown
6479
+ * options={[
6480
+ * {label: 'Option 1', disabled: true},
6481
+ * {label: 'Option 2', id: '2'}
6482
+ * {label: ''}
6483
+ * {label: 'Option 3', id: '2'}
6484
+ * ]}
6485
+ * label="OK" onClick={() => (console.log('OK clicked'))}
6486
+ * />
6487
+ * ```
6488
+ */
6089
6489
  "verdocs-dropdown": LocalJSX.VerdocsDropdown & JSXBase.HTMLAttributes<HTMLVerdocsDropdownElement>;
6090
6490
  /**
6091
6491
  * Represents one document page. This is primarily a layout container used to coordinate positions of
@@ -6124,13 +6524,16 @@ declare module "@stencil/core" {
6124
6524
  */
6125
6525
  "verdocs-field-date": LocalJSX.VerdocsFieldDate & JSXBase.HTMLAttributes<HTMLVerdocsFieldDateElement>;
6126
6526
  /**
6127
- * Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as
6128
- * input types like text and checkbox.
6527
+ * Displays a dropdown field that allows the user to choose one of a list of options.
6129
6528
  */
6130
6529
  "verdocs-field-dropdown": LocalJSX.VerdocsFieldDropdown & JSXBase.HTMLAttributes<HTMLVerdocsFieldDropdownElement>;
6131
6530
  /**
6132
- * Displays an initial field. If an initial already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
6133
- * button will be shown. Clicking the button will show a dialog to adopt an initial.
6531
+ * Displays an initial field. If an initial already exists, it will be displayed and the field
6532
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
6533
+ * show a dialog to adopt an initial.
6534
+ * NOTE: When initial fields are completed they will be filled with an initial "stamp".
6535
+ * This requires operation against a live, valid envelope. If you are testing this component
6536
+ * in Storybook, it will not be visible here.
6134
6537
  */
6135
6538
  "verdocs-field-initial": LocalJSX.VerdocsFieldInitial & JSXBase.HTMLAttributes<HTMLVerdocsFieldInitialElement>;
6136
6539
  /**
@@ -6143,24 +6546,42 @@ declare module "@stencil/core" {
6143
6546
  */
6144
6547
  "verdocs-field-radio-button": LocalJSX.VerdocsFieldRadioButton & JSXBase.HTMLAttributes<HTMLVerdocsFieldRadioButtonElement>;
6145
6548
  /**
6146
- * Displays a signature field. If a signature already exists, it will be displayed and the field will be disabled. Otherwise, a placeholder
6147
- * button will be shown. Clicking the button will show a dialog to adopt a signature.
6549
+ * Displays a signature field. If a signature already exists, it will be displayed and the field
6550
+ * will be disabled. Otherwise, a placeholder button will be shown. Clicking the button will
6551
+ * show a dialog to adopt a signature.
6552
+ * NOTE: When signature fields are completed they will be filled with a signature "stamp".
6553
+ * This requires operation against a live, valid envelope. If you are testing this component
6554
+ * in Storybook, it will not be visible here.
6148
6555
  */
6149
6556
  "verdocs-field-signature": LocalJSX.VerdocsFieldSignature & JSXBase.HTMLAttributes<HTMLVerdocsFieldSignatureElement>;
6150
6557
  /**
6151
- * Display a multi-line text input field.
6558
+ * Display a multi-line text input field. Reminder: the "position" of the field is specified
6559
+ * as the BOTTOM-LEFT corner.
6152
6560
  */
6153
6561
  "verdocs-field-textarea": LocalJSX.VerdocsFieldTextarea & JSXBase.HTMLAttributes<HTMLVerdocsFieldTextareaElement>;
6154
6562
  /**
6155
- * Display a text input field.
6563
+ * Display a simple 1-line text input field.
6156
6564
  */
6157
6565
  "verdocs-field-textbox": LocalJSX.VerdocsFieldTextbox & JSXBase.HTMLAttributes<HTMLVerdocsFieldTextboxElement>;
6158
6566
  /**
6159
- * Display a timestamp field.
6567
+ * Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically
6568
+ * filled when the signer submits the document.
6160
6569
  */
6161
6570
  "verdocs-field-timestamp": LocalJSX.VerdocsFieldTimestamp & JSXBase.HTMLAttributes<HTMLVerdocsFieldTimestampElement>;
6571
+ /**
6572
+ * Displays a file picker to upload an attachment. This component is just the picker - the host application or component should
6573
+ * provide the actual upload functionality.
6574
+ * ```ts
6575
+ * <verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />
6576
+ * ```
6577
+ */
6162
6578
  "verdocs-file-chooser": LocalJSX.VerdocsFileChooser & JSXBase.HTMLAttributes<HTMLVerdocsFileChooserElement>;
6163
- "verdocs-floating-menu": LocalJSX.VerdocsFloatingMenu & JSXBase.HTMLAttributes<HTMLVerdocsFloatingMenuElement>;
6579
+ /**
6580
+ * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
6581
+ * ```ts
6582
+ * <verdocs-help-icon text="Sample help text" />
6583
+ * ```
6584
+ */
6164
6585
  "verdocs-help-icon": LocalJSX.VerdocsHelpIcon & JSXBase.HTMLAttributes<HTMLVerdocsHelpIconElement>;
6165
6586
  /**
6166
6587
  * Display a dialog that allows the user to specify an initials image, either by using a signature-font-generated image
@@ -6168,11 +6589,15 @@ declare module "@stencil/core" {
6168
6589
  */
6169
6590
  "verdocs-initial-dialog": LocalJSX.VerdocsInitialDialog & JSXBase.HTMLAttributes<HTMLVerdocsInitialDialogElement>;
6170
6591
  /**
6171
- * Display a text input field. This adds a partially-transparent overlay and screen-centered dialog
6172
- * box with a message and optional header/title. An OK button is shown that will dismiss the message.
6173
- * It can also be dismissed by clicking the background overlay.
6592
+ * Prompt the user to confirm their identity with a series of questions.
6174
6593
  */
6175
6594
  "verdocs-kba-dialog": LocalJSX.VerdocsKbaDialog & JSXBase.HTMLAttributes<HTMLVerdocsKbaDialogElement>;
6595
+ /**
6596
+ * Animated loader placeholder. There are currently no configuration options for this control.
6597
+ * ```ts
6598
+ * <verdocs-loader />
6599
+ * ```
6600
+ */
6176
6601
  "verdocs-loader": LocalJSX.VerdocsLoader & JSXBase.HTMLAttributes<HTMLVerdocsLoaderElement>;
6177
6602
  /**
6178
6603
  * Display a simple text dialog box with an Ok button. This adds a partially-transparent overlay and screen-centered dialog
@@ -6180,18 +6605,65 @@ declare module "@stencil/core" {
6180
6605
  * It can also be dismissed by clicking the background overlay.
6181
6606
  */
6182
6607
  "verdocs-ok-dialog": LocalJSX.VerdocsOkDialog & JSXBase.HTMLAttributes<HTMLVerdocsOkDialogElement>;
6608
+ /**
6609
+ * Display a small summary card describing an organization.
6610
+ * ```ts
6611
+ * <verdocs-organization-card organization={organization} />
6612
+ * ```
6613
+ */
6183
6614
  "verdocs-organization-card": LocalJSX.VerdocsOrganizationCard & JSXBase.HTMLAttributes<HTMLVerdocsOrganizationCardElement>;
6615
+ /**
6616
+ * Display a simple pagination control with individual buttons to move through the data set.
6617
+ * ```ts
6618
+ * <verdocs-pagination
6619
+ * selectedPage={1}
6620
+ * itemCount={50}
6621
+ * perPage={10}
6622
+ * onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}
6623
+ * />
6624
+ * ```
6625
+ */
6184
6626
  "verdocs-pagination": LocalJSX.VerdocsPagination & JSXBase.HTMLAttributes<HTMLVerdocsPaginationElement>;
6627
+ /**
6628
+ * Display a child component in a "portal", popping it out of the main DOM tree
6629
+ * to allow it to escape the bounds set by its parent.
6630
+ * @credit https://github.com/tomas-teston/stencil-portal for the basic
6631
+ * technique. This has been altered in a few ways to make it more friendly
6632
+ * to cases where there may be multiple portals on the page and provide more
6633
+ * alignment options for the child to be displayed.
6634
+ * ```ts
6635
+ * <div style="padding: 40px">
6636
+ * <div id="sample-tooltip" style="border: 1px solid green; padding: 3px 10px;">
6637
+ * Tooltip Anchor
6638
+ * <verdocs-portal anchor="sample-tooltip" .align=${align} .voffset=${voffset}>
6639
+ * <div style="border: 1px solid red; padding: 3px 10px;">Tooltip</div>
6640
+ * </verdocs-portal>
6641
+ * </div>
6642
+ * </div>
6643
+ * ```
6644
+ */
6185
6645
  "verdocs-portal": LocalJSX.VerdocsPortal & JSXBase.HTMLAttributes<HTMLVerdocsPortalElement>;
6186
6646
  /**
6187
6647
  * Display a template preview experience. This will display the template's attached
6188
6648
  * documents with signing fields overlaid on each page. Fields will be color-coded
6189
6649
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
6650
+ * ```ts
6651
+ * <verdocs-preview templateId={templateId} />
6652
+ * ```
6190
6653
  */
6191
6654
  "verdocs-preview": LocalJSX.VerdocsPreview & JSXBase.HTMLAttributes<HTMLVerdocsPreviewElement>;
6655
+ /**
6656
+ * Display a simple progress bar in a style consistent with the design system.
6657
+ * ```ts
6658
+ * <verdocs-progress-bar label="Uploading..." showPercent={true} percent={54} />
6659
+ * ```
6660
+ */
6192
6661
  "verdocs-progress-bar": LocalJSX.VerdocsProgressBar & JSXBase.HTMLAttributes<HTMLVerdocsProgressBarElement>;
6193
6662
  /**
6194
6663
  * Display a drop-down menu of quick filter options.
6664
+ * ```ts
6665
+ * <verdocs-quick-filter options={[...options]} value={1} label="Filter" placeholder="All" />
6666
+ * ```
6195
6667
  */
6196
6668
  "verdocs-quick-filter": LocalJSX.VerdocsQuickFilter & JSXBase.HTMLAttributes<HTMLVerdocsQuickFilterElement>;
6197
6669
  /**
@@ -6206,7 +6678,7 @@ declare module "@stencil/core" {
6206
6678
  * simple radio button for UI displays e.g. dialog boxes.
6207
6679
  * This control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`
6208
6680
  * handler. Sample usage:
6209
- * ```html
6681
+ * ```ts
6210
6682
  * <verdocs-radio-button
6211
6683
  * value="val1"
6212
6684
  * name="someProperty"
@@ -6228,22 +6700,35 @@ declare module "@stencil/core" {
6228
6700
  /**
6229
6701
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
6230
6702
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
6231
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
6703
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
6704
+ * ```ts
6705
+ * <verdocs-select-input label="Select:" label="Select" options={[...options]}
6706
+ * @input ={() => {}} />
6707
+ * ```
6232
6708
  */
6233
6709
  "verdocs-select-input": LocalJSX.VerdocsSelectInput & JSXBase.HTMLAttributes<HTMLVerdocsSelectInputElement>;
6234
6710
  /**
6235
- * Display a form to collect recipient information for a new Envelope. If used anonymously, the specified `templateId` must be public.
6236
- * Because most applications have custom workflow requirements to trigger after sending an Envelope, this component does not actually
6237
- * perform that operation. Parent applications should listen for the `onSend` event, and can pass the contents of `event.detail`
6238
- * directly to the `createEnvelope()` call in JS-SDK.
6239
- * Host applications should ensure the template is "sendable" before displaying this component. To be sendable, a template must have
6240
- * at least one document attached, at least one participant defined, and at least one field assigned to every "signer" participant.
6711
+ * Display a form to send a template to one or more recipients in an envelope for signing. Note
6712
+ * that because most applications have custom workflow requirements to trigger after sending an
6713
+ * Envelope, this component does not actually perform that operation. Parent applications should
6714
+ * listen for the `onSend` event, and can pass the contents of `event.detail` directly to the
6715
+ * `createEnvelope()` call in JS-SDK.
6716
+ * Host applications should ensure the template is "sendable" before displaying this component.
6717
+ * To be sendable, a template must have at least one document attached, at least one participant
6718
+ * defined, and at least one field assigned to every "signer" participant. This component will
6719
+ * hide itself if the template is not sendable.
6720
+ * ```ts
6721
+ * <verdocs-send templateId={templateId} />
6722
+ * ```
6241
6723
  */
6242
6724
  "verdocs-send": LocalJSX.VerdocsSend & JSXBase.HTMLAttributes<HTMLVerdocsSendElement>;
6243
6725
  /**
6244
6726
  * Display a template preview experience. This will display the template's attached
6245
6727
  * documents with signing fields overlaid on each page. Fields will be color-coded
6246
6728
  * by recipient, and will be read-only (cannot be filled, moved, or altered).
6729
+ * ```ts
6730
+ * <verdocs-settings />
6731
+ * ```
6247
6732
  */
6248
6733
  "verdocs-settings": LocalJSX.VerdocsSettings & JSXBase.HTMLAttributes<HTMLVerdocsSettingsElement>;
6249
6734
  /**
@@ -6285,6 +6770,9 @@ declare module "@stencil/core" {
6285
6770
  "verdocs-signature-dialog": LocalJSX.VerdocsSignatureDialog & JSXBase.HTMLAttributes<HTMLVerdocsSignatureDialogElement>;
6286
6771
  /**
6287
6772
  * Display a small loading spinner.
6773
+ * ```ts
6774
+ * <verdocs-spinner />
6775
+ * ```
6288
6776
  */
6289
6777
  "verdocs-spinner": LocalJSX.VerdocsSpinner & JSXBase.HTMLAttributes<HTMLVerdocsSpinnerElement>;
6290
6778
  /**
@@ -6298,11 +6786,17 @@ declare module "@stencil/core" {
6298
6786
  /**
6299
6787
  * Display a simple table of data. Columns and data cells may have custom renderers defined to
6300
6788
  * support creating interactive table layouts.
6789
+ * ```ts
6790
+ * <verdocs-table columns={[...columns]} data={[...data]} />
6791
+ * ```
6301
6792
  */
6302
6793
  "verdocs-table": LocalJSX.VerdocsTable & JSXBase.HTMLAttributes<HTMLVerdocsTableElement>;
6303
6794
  /**
6304
6795
  * Display a simple row of selectable tabs. This is a controlled element.
6305
6796
  * The parent must adjust selectedTab as selection events are fired.
6797
+ * ```ts
6798
+ * <verdocs-tabs tabs={[...tabs]} />
6799
+ * ```
6306
6800
  */
6307
6801
  "verdocs-tabs": LocalJSX.VerdocsTabs & JSXBase.HTMLAttributes<HTMLVerdocsTabsElement>;
6308
6802
  /**
@@ -6377,19 +6871,31 @@ declare module "@stencil/core" {
6377
6871
  /**
6378
6872
  * Display a text input field. This is just a standard HTML input field with minimal markup to fit the
6379
6873
  * visual styles of the other components. Note that events "bubble" from the input field to the container,
6380
- * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emmit.
6874
+ * so you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.
6875
+ * ```ts
6876
+ * <verdocs-text-input type="text" label="Name" placeholder="Enter your name..." value="" />
6877
+ * ```
6381
6878
  */
6382
6879
  "verdocs-text-input": LocalJSX.VerdocsTextInput & JSXBase.HTMLAttributes<HTMLVerdocsTextInputElement>;
6383
6880
  /**
6384
- * Displays a label and a set of buttons, also allowing a default selection of a button
6881
+ * Displays a label and a set of buttons, also allowing a default selection of a button.
6882
+ * ```ts
6883
+ * <verdocs-toggle options={[...options]} theme="light"></verdocs-toggle>
6884
+ * ```
6385
6885
  */
6386
6886
  "verdocs-toggle": LocalJSX.VerdocsToggle & JSXBase.HTMLAttributes<HTMLVerdocsToggleElement>;
6387
6887
  /**
6388
6888
  * Displays a single button that can be toggled on or off by clicking it.
6889
+ * ```ts
6890
+ * <verdocs-toggle-button icon={MessageIcon} size="normal" active={true} />
6891
+ * ```
6389
6892
  */
6390
6893
  "verdocs-toggle-button": LocalJSX.VerdocsToggleButton & JSXBase.HTMLAttributes<HTMLVerdocsToggleButtonElement>;
6391
6894
  /**
6392
6895
  * Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.
6896
+ * ```ts
6897
+ * <verdocs-toolbar-icon text="Sample tooltip text" icon={CalendarIcon} />
6898
+ * ```
6393
6899
  */
6394
6900
  "verdocs-toolbar-icon": LocalJSX.VerdocsToolbarIcon & JSXBase.HTMLAttributes<HTMLVerdocsToolbarIconElement>;
6395
6901
  /**