@verdocs/web-sdk 5.0.27 → 5.0.29

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,2156 @@
1
+ {
2
+ "version": 1.1,
3
+ "tags": [
4
+ {
5
+ "name": "verdocs-auth",
6
+ "description": {
7
+ "kind": "markdown",
8
+ "value": "Display an authentication dialog that allows the user to login or sign up. If the user is\nalready authenticated with a valid session, this component will hide itself and fire the\nsuccess callback immediately. It is up to the host application to render the next appropriate\nview for the application.\n\nTo simplify UI development, a visibility flag can force this component to never display. This\nallows you to subscribe to notifications from client apps without calling the lower-level JS SDK.\n\nThis embed is responsive / mobile-friendly, but the calling application should provide at\nleast a 300px wide container to allow sufficient space for the required forms.\n\n```ts\ninterface IAuthStatus {\n authenticated: boolean;\n session: TSession;\n profile: IProfile | null;\n}\n\n<verdocs-auth\n onAuthenticated={({ detail }: { detail: IAuthStatus }) => console.log('Authentication state:', detail) }\n onSdkError={({ detail }) => { console.log('SDK error', detail) }\n />\n```"
9
+ },
10
+ "attributes": [
11
+ {
12
+ "name": "display-mode",
13
+ "description": "The display mode to start in.",
14
+ "values": [
15
+ {
16
+ "name": "forgot"
17
+ },
18
+ {
19
+ "name": "login"
20
+ },
21
+ {
22
+ "name": "reset"
23
+ },
24
+ {
25
+ "name": "signup"
26
+ },
27
+ {
28
+ "name": "verify"
29
+ }
30
+ ]
31
+ },
32
+ {
33
+ "name": "logo",
34
+ "description": "By default, a Verdocs logo will be displayed above the login/signup forms. This may be used to\noverride its source. (Alternatively, you may simply hide it via CSS overrides.) Logos should be\nin SVG format for best results."
35
+ },
36
+ {
37
+ "name": "visible",
38
+ "description": "Normally, if the user has a valid session, this embed will be invisible, otherwise it will display\nlogin / signup forms. If this is set to false, this embed will be invisible in both cases. Apps may\nuse this to verify if a user has a valid session without needing a separate call to Verdocs JS SDK."
39
+ }
40
+ ]
41
+ },
42
+ {
43
+ "name": "verdocs-build",
44
+ "description": {
45
+ "kind": "markdown",
46
+ "value": "Display a template building experience. Several event callbacks provide status updates to the\nparent application to support interface updates.\n\n```ts\n<verdocs-build templateId={templateId} step=\"preview\" onSend={(detail) => {\n console.log('Sent envelope from template', detail);\n}} />\n```"
47
+ },
48
+ "attributes": [
49
+ {
50
+ "name": "step",
51
+ "description": "The step in the creation process to display.",
52
+ "values": [
53
+ {
54
+ "name": "attachments"
55
+ },
56
+ {
57
+ "name": "fields"
58
+ },
59
+ {
60
+ "name": "preview"
61
+ },
62
+ {
63
+ "name": "roles"
64
+ },
65
+ {
66
+ "name": "settings"
67
+ }
68
+ ]
69
+ },
70
+ {
71
+ "name": "template-id",
72
+ "description": "The ID of the template to create the document from. Unlike most other components, this is an optional parameter here.\nIf the template ID is known, `step` may also be specified to force displaying a specific step in the creation process.\nIf it is not specified, `step` will be ignored and the create step will be shown."
73
+ }
74
+ ]
75
+ },
76
+ {
77
+ "name": "verdocs-button",
78
+ "description": {
79
+ "kind": "markdown",
80
+ "value": "A simple button, with consistent styling to other controls in the design system.\n\n```ts\n<verdocs-button label=\"Click Me\" size=\"normal\" variant=\"standard\" />\n```"
81
+ },
82
+ "attributes": [
83
+ {
84
+ "name": "disabled",
85
+ "description": "Whether the button should be disabled."
86
+ },
87
+ {
88
+ "name": "end-icon",
89
+ "description": "If desired, a suffix icon for the button."
90
+ },
91
+ {
92
+ "name": "label",
93
+ "description": "The label for the button."
94
+ },
95
+ {
96
+ "name": "size",
97
+ "description": "The size (height) of the button.",
98
+ "values": [
99
+ {
100
+ "name": "large"
101
+ },
102
+ {
103
+ "name": "medium"
104
+ },
105
+ {
106
+ "name": "normal"
107
+ },
108
+ {
109
+ "name": "small"
110
+ },
111
+ {
112
+ "name": "xsmall"
113
+ }
114
+ ]
115
+ },
116
+ {
117
+ "name": "start-icon",
118
+ "description": "If desired, a prefix icon for the button."
119
+ },
120
+ {
121
+ "name": "type",
122
+ "description": "The type of the button.",
123
+ "values": [
124
+ {
125
+ "name": "button"
126
+ },
127
+ {
128
+ "name": "reset"
129
+ },
130
+ {
131
+ "name": "submit"
132
+ }
133
+ ]
134
+ },
135
+ {
136
+ "name": "variant",
137
+ "description": "The display variant of the button.",
138
+ "values": [
139
+ {
140
+ "name": "outline"
141
+ },
142
+ {
143
+ "name": "standard"
144
+ },
145
+ {
146
+ "name": "text"
147
+ }
148
+ ]
149
+ }
150
+ ]
151
+ },
152
+ {
153
+ "name": "verdocs-button-panel",
154
+ "description": {
155
+ "kind": "markdown",
156
+ "value": "Display an icon button that triggers a drop-down panel that can display\narbitrary child content, such as metadata, forms, or other controls.\n\n```ts\n <verdocs-button-panel .icon=${icon}>\n <h6>Field Settings</h6>\n <form>\n <p>\n <label>Field Name</label>\n <input type=\"text\" placeholder=\"Field Name...\" />\n </p>\n </form>\n </verdocs-button-panel>\n```"
157
+ },
158
+ "attributes": [
159
+ {
160
+ "name": "icon",
161
+ "description": "SVG icon to display"
162
+ }
163
+ ]
164
+ },
165
+ {
166
+ "name": "verdocs-checkbox",
167
+ "description": {
168
+ "kind": "markdown",
169
+ "value": "Displays a check box. Note that this is different from the `verdocs-field-checkbox` component, which is designed\nto be used in signing experiences and contains settings that connect to template fields. This is just a simple check\nbox for UI displays e.g. dialog boxes.\n\nThis control encapsulates a standard HTML checkbox. To subscribe to change events, connect an `onChange`\nhandler. Sample usage:\n\n```ts\n<verdocs-checkbox\n value=\"on\"\n name=\"thingEnabled\"\n checked={this.thingEnabled}\n onInput={(e: any) => (this.thingEnabled = e.target.checked)}\n/>\n```"
170
+ },
171
+ "attributes": [
172
+ {
173
+ "name": "checked",
174
+ "description": "Whether the radio button is currently selected."
175
+ },
176
+ {
177
+ "name": "disabled",
178
+ "description": "If set, the button will still be displayed but not selectable."
179
+ },
180
+ {
181
+ "name": "label",
182
+ "description": "Label to display. Leave blank for no label. The label will be displayed to the right of the checkbox, but may be\nrepositioned with CSS."
183
+ },
184
+ {
185
+ "name": "name",
186
+ "description": "HTML form field name for the input."
187
+ },
188
+ {
189
+ "name": "theme",
190
+ "description": "Style of checkbox to render. Use 'dark' when rendering on a dark background.",
191
+ "values": [
192
+ {
193
+ "name": "dark"
194
+ },
195
+ {
196
+ "name": "light"
197
+ }
198
+ ]
199
+ },
200
+ {
201
+ "name": "value",
202
+ "description": "Value to track with the input. Value is not used internally by this component but is sometimes useful to set\nbecause it can be retrieved in event handlers via e.target.value. This can be used to identify which\ncheckbox was clicked in a checkbox group."
203
+ }
204
+ ]
205
+ },
206
+ {
207
+ "name": "verdocs-component-error",
208
+ "description": {
209
+ "kind": "markdown",
210
+ "value": "Render a simple error message."
211
+ },
212
+ "attributes": [
213
+ {
214
+ "name": "message",
215
+ "description": "The message to display."
216
+ }
217
+ ]
218
+ },
219
+ {
220
+ "name": "verdocs-contact-picker",
221
+ "description": {
222
+ "kind": "markdown",
223
+ "value": "Display a contact picker suitable for filling out Recipient objects when sending Envelopes.\n\nThis picker can also be integrated with a backend to provide contact list / suggestion / address-book style behavior. As the\nuser interacts with the component, the text entered in the name fields is sent back to the parent via the `searchContacts` event.\nThe parent can use that text as a query string to call a backend to obtain appropriate contacts to show. This list may also be\nhard-coded ahead of time to provide the user with smart suggestions on initial display, such as \"Recently Used\" contacts, or\nto always display the user's own contact record.\n\n```ts\n<verdocs-contact-picker\n templateRole={role}\n contactSuggestions={[]}\n onNext={e => console.log('Contact completed', e.detail)}\n />\n```"
224
+ },
225
+ "attributes": []
226
+ },
227
+ {
228
+ "name": "verdocs-dialog",
229
+ "description": {
230
+ "kind": "markdown",
231
+ "value": "Display a simple dialog where the contents are provided via slots."
232
+ },
233
+ "attributes": []
234
+ },
235
+ {
236
+ "name": "verdocs-dropdown",
237
+ "description": {
238
+ "kind": "markdown",
239
+ "value": "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\nwhen the button is pressed again, or an option is selected. Separators may be created by supplying an entry with an empty label.\n\n```ts\n<verdocs-dropdown\n options={[\n {label: 'Option 1', disabled: true},\n {label: 'Option 2', id: '2'}\n {label: ''}\n {label: 'Option 3', id: '2'}\n ]}\n label=\"OK\" onClick={() => (console.log('OK clicked'))}\n/>\n```"
240
+ },
241
+ "attributes": []
242
+ },
243
+ {
244
+ "name": "verdocs-envelope-document-page",
245
+ "description": {
246
+ "kind": "markdown",
247
+ "value": "Represents one document page. This is primarily a layout container used to coordinate positions of\npage-related layers such as the page itself, signature fields, etc. It is not intended to be used\non its own as an individual component."
248
+ },
249
+ "attributes": [
250
+ {
251
+ "name": "document-id",
252
+ "description": "The ID of the document to display."
253
+ },
254
+ {
255
+ "name": "envelope-id",
256
+ "description": "The ID of the envelope the document is for."
257
+ },
258
+ {
259
+ "name": "page-number",
260
+ "description": "The page number being rendered. (Reminder: page numbers are 1-based.)"
261
+ },
262
+ {
263
+ "name": "type",
264
+ "description": "",
265
+ "values": [
266
+ {
267
+ "name": "certificate"
268
+ },
269
+ {
270
+ "name": "filled"
271
+ },
272
+ {
273
+ "name": "original"
274
+ }
275
+ ]
276
+ },
277
+ {
278
+ "name": "virtual-height",
279
+ "description": "The \"virtual\" height of the page canvas. Defaults to 792 which at 72dpi is 11\" tall. This is used to compute\nthe aspect ratio of the final rendered element when scaling up/down."
280
+ },
281
+ {
282
+ "name": "virtual-width",
283
+ "description": "The \"virtual\" width of the page canvas. Defaults to 612 which at 72dpi is 8.5\" wide. This is used to compute\nthe aspect ratio of the final rendered element when scaling up/down."
284
+ }
285
+ ]
286
+ },
287
+ {
288
+ "name": "verdocs-envelope-recipient-link",
289
+ "description": {
290
+ "kind": "markdown",
291
+ "value": "Displays a single recipient from an envelope, with the opportunity to copy an in-person\nsigning link for that recipient to use."
292
+ },
293
+ "attributes": [
294
+ {
295
+ "name": "envelope-id",
296
+ "description": "The envelope ID to edit."
297
+ },
298
+ {
299
+ "name": "role-name",
300
+ "description": "The role to load."
301
+ }
302
+ ]
303
+ },
304
+ {
305
+ "name": "verdocs-envelope-recipient-summary",
306
+ "description": {
307
+ "kind": "markdown",
308
+ "value": "Displays a list of recipients with options to get in-person signing links for each one."
309
+ },
310
+ "attributes": [
311
+ {
312
+ "name": "can-done",
313
+ "description": "Enable or disable the Done button."
314
+ },
315
+ {
316
+ "name": "can-send-another",
317
+ "description": "Enable or disable the Send Another button."
318
+ },
319
+ {
320
+ "name": "can-view",
321
+ "description": "Enable or disable the View button."
322
+ },
323
+ {
324
+ "name": "envelope-id",
325
+ "description": "The envelope ID to edit."
326
+ }
327
+ ]
328
+ },
329
+ {
330
+ "name": "verdocs-envelope-sidebar",
331
+ "description": {
332
+ "kind": "markdown",
333
+ "value": "Displays a file upload mechanism suitable for the first step of creating a template.\nThis is typically the first step in a template creation workflow."
334
+ },
335
+ "attributes": [
336
+ {
337
+ "name": "envelope-id",
338
+ "description": "The envelope ID to render. Set ONE OF templateId or envelopeId. If both are set, envelopeId will be ignored."
339
+ }
340
+ ]
341
+ },
342
+ {
343
+ "name": "verdocs-envelopes-list",
344
+ "description": {
345
+ "kind": "markdown",
346
+ "value": "Displays a list of envelopes matching specified conditions."
347
+ },
348
+ "attributes": [
349
+ {
350
+ "name": "match",
351
+ "description": "If set, filter envelopes by the specified string."
352
+ },
353
+ {
354
+ "name": "rows-per-page",
355
+ "description": "The number of rows to display per page."
356
+ },
357
+ {
358
+ "name": "selected-page",
359
+ "description": "The initial page number to select. Pagination is internally controlled but may be overriden by the\nhost applicaiton."
360
+ },
361
+ {
362
+ "name": "show-pagination",
363
+ "description": "Whether or not pagination should be enabled."
364
+ },
365
+ {
366
+ "name": "sort",
367
+ "description": "The sort field to use",
368
+ "values": [
369
+ {
370
+ "name": "canceled_at"
371
+ },
372
+ {
373
+ "name": "created_at"
374
+ },
375
+ {
376
+ "name": "name"
377
+ },
378
+ {
379
+ "name": "status"
380
+ },
381
+ {
382
+ "name": "updated_at"
383
+ }
384
+ ]
385
+ },
386
+ {
387
+ "name": "status",
388
+ "description": "The status value to filter by",
389
+ "values": [
390
+ {
391
+ "name": "all"
392
+ },
393
+ {
394
+ "name": "canceled"
395
+ },
396
+ {
397
+ "name": "complete"
398
+ },
399
+ {
400
+ "name": "declined"
401
+ },
402
+ {
403
+ "name": "in progress"
404
+ },
405
+ {
406
+ "name": "pending"
407
+ }
408
+ ]
409
+ },
410
+ {
411
+ "name": "view",
412
+ "description": "The filtered view to display. \"completed\" will show envelopes that have been submitted. \"action\" will\nshow envelopes where the user is a recipient and the envelope is not completed. \"waiting\" will show\nonly envelopes where the user is the sender and the envelope is not completed.",
413
+ "values": [
414
+ {
415
+ "name": "action"
416
+ },
417
+ {
418
+ "name": "all"
419
+ },
420
+ {
421
+ "name": "completed"
422
+ },
423
+ {
424
+ "name": "inbox"
425
+ },
426
+ {
427
+ "name": "sent"
428
+ },
429
+ {
430
+ "name": "waiting"
431
+ }
432
+ ]
433
+ }
434
+ ]
435
+ },
436
+ {
437
+ "name": "verdocs-field-attachment",
438
+ "description": {
439
+ "kind": "markdown",
440
+ "value": "Displays an attachment field."
441
+ },
442
+ "attributes": [
443
+ {
444
+ "name": "disabled",
445
+ "description": "If set, overrides the field's settings object. Primarily used to support \"preview\" modes where all fields are disabled."
446
+ },
447
+ {
448
+ "name": "done",
449
+ "description": "If set, the field is considered \"done\" and is drawn in a display-final-value state."
450
+ },
451
+ {
452
+ "name": "editable",
453
+ "description": "If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be\nchanged, so it should typically only be enabled in the Builder."
454
+ },
455
+ {
456
+ "name": "fieldname",
457
+ "description": "The name of the field to display."
458
+ },
459
+ {
460
+ "name": "moveable",
461
+ "description": "If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields."
462
+ },
463
+ {
464
+ "name": "pagenumber",
465
+ "description": "The page the field is on"
466
+ },
467
+ {
468
+ "name": "source",
469
+ "description": "Fields may be attached to templates or envelopes, but only template fields may be edited.",
470
+ "values": [
471
+ {
472
+ "name": "envelope"
473
+ },
474
+ {
475
+ "name": "template"
476
+ }
477
+ ]
478
+ },
479
+ {
480
+ "name": "sourceid",
481
+ "description": "The source template or envelope ID the field is found in."
482
+ },
483
+ {
484
+ "name": "xscale",
485
+ "description": "If set, the field will be be scaled horizontally by this factor."
486
+ },
487
+ {
488
+ "name": "yscale",
489
+ "description": "If set, the field will be be scaled vertically by this factor."
490
+ }
491
+ ]
492
+ },
493
+ {
494
+ "name": "verdocs-field-checkbox",
495
+ "description": {
496
+ "kind": "markdown",
497
+ "value": "Displays a checkbox."
498
+ },
499
+ "attributes": [
500
+ {
501
+ "name": "disabled",
502
+ "description": "If set, overrides the field's settings object. Primarily used to support \"preview\" modes where all fields are disabled."
503
+ },
504
+ {
505
+ "name": "done",
506
+ "description": "If set, the field is considered \"done\" and is drawn in a display-final-value state."
507
+ },
508
+ {
509
+ "name": "editable",
510
+ "description": "If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be\nchanged, so it should typically only be enabled in the Builder."
511
+ },
512
+ {
513
+ "name": "fieldname",
514
+ "description": "The name of the field to display."
515
+ },
516
+ {
517
+ "name": "moveable",
518
+ "description": "If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields."
519
+ },
520
+ {
521
+ "name": "pagenumber",
522
+ "description": "The page the field is on"
523
+ },
524
+ {
525
+ "name": "source",
526
+ "description": "Fields may be attached to templates or envelopes, but only template fields may be edited.",
527
+ "values": [
528
+ {
529
+ "name": "envelope"
530
+ },
531
+ {
532
+ "name": "template"
533
+ }
534
+ ]
535
+ },
536
+ {
537
+ "name": "sourceid",
538
+ "description": "The source template or envelope ID the field is found in."
539
+ },
540
+ {
541
+ "name": "xscale",
542
+ "description": "If set, the field will be be scaled horizontally by this factor."
543
+ },
544
+ {
545
+ "name": "yscale",
546
+ "description": "If set, the field will be be scaled vertically by this factor."
547
+ }
548
+ ]
549
+ },
550
+ {
551
+ "name": "verdocs-field-date",
552
+ "description": {
553
+ "kind": "markdown",
554
+ "value": "Displays a date field. When tapped or clicked, the input element will display a date picker component."
555
+ },
556
+ "attributes": [
557
+ {
558
+ "name": "disabled",
559
+ "description": "If set, overrides the field's settings object. Primarily used to support \"preview\" modes where all fields are disabled."
560
+ },
561
+ {
562
+ "name": "done",
563
+ "description": "If set, the field is considered \"done\" and is drawn in a display-final-value state."
564
+ },
565
+ {
566
+ "name": "editable",
567
+ "description": "If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be\nchanged, so it should typically only be enabled in the Builder."
568
+ },
569
+ {
570
+ "name": "fieldname",
571
+ "description": "The name of the field to display."
572
+ },
573
+ {
574
+ "name": "moveable",
575
+ "description": "If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields."
576
+ },
577
+ {
578
+ "name": "pagenumber",
579
+ "description": "The page the field is on"
580
+ },
581
+ {
582
+ "name": "source",
583
+ "description": "Fields may be attached to templates or envelopes, but only template fields may be edited.",
584
+ "values": [
585
+ {
586
+ "name": "envelope"
587
+ },
588
+ {
589
+ "name": "template"
590
+ }
591
+ ]
592
+ },
593
+ {
594
+ "name": "sourceid",
595
+ "description": "The source template or envelope ID the field is found in."
596
+ },
597
+ {
598
+ "name": "xscale",
599
+ "description": "If set, the field will be be scaled horizontally by this factor."
600
+ },
601
+ {
602
+ "name": "yscale",
603
+ "description": "If set, the field will be be scaled vertically by this factor."
604
+ }
605
+ ]
606
+ },
607
+ {
608
+ "name": "verdocs-field-dropdown",
609
+ "description": {
610
+ "kind": "markdown",
611
+ "value": "Displays a dropdown field that allows the user to choose one of a list of options."
612
+ },
613
+ "attributes": [
614
+ {
615
+ "name": "disabled",
616
+ "description": "If set, overrides the field's settings object. Primarily used to support \"preview\" modes where all fields are disabled."
617
+ },
618
+ {
619
+ "name": "done",
620
+ "description": "If set, the field is considered \"done\" and is drawn in a display-final-value state."
621
+ },
622
+ {
623
+ "name": "editable",
624
+ "description": "If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be\nchanged, so it should typically only be enabled in the Builder."
625
+ },
626
+ {
627
+ "name": "fieldname",
628
+ "description": "The name of the field to display."
629
+ },
630
+ {
631
+ "name": "moveable",
632
+ "description": "If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields."
633
+ },
634
+ {
635
+ "name": "pagenumber",
636
+ "description": "The page the field is on"
637
+ },
638
+ {
639
+ "name": "source",
640
+ "description": "Fields may be attached to templates or envelopes, but only template fields may be edited.",
641
+ "values": [
642
+ {
643
+ "name": "envelope"
644
+ },
645
+ {
646
+ "name": "template"
647
+ }
648
+ ]
649
+ },
650
+ {
651
+ "name": "sourceid",
652
+ "description": "The source template or envelope ID the field is found in."
653
+ },
654
+ {
655
+ "name": "xscale",
656
+ "description": "If set, the field will be be scaled horizontally by this factor."
657
+ },
658
+ {
659
+ "name": "yscale",
660
+ "description": "If set, the field will be be scaled vertically by this factor."
661
+ }
662
+ ]
663
+ },
664
+ {
665
+ "name": "verdocs-field-initial",
666
+ "description": {
667
+ "kind": "markdown",
668
+ "value": "Displays an initial field. If an initial already exists, it will be displayed and the field\nwill be disabled. Otherwise, a placeholder button will be shown. Clicking the button will\nshow a dialog to adopt an initial.\n\nNOTE: When initial fields are completed they will be filled with an initial \"stamp\".\nThis requires operation against a live, valid envelope. If you are testing this component\nin Storybook, it will not be visible here."
669
+ },
670
+ "attributes": [
671
+ {
672
+ "name": "disabled",
673
+ "description": "If set, overrides the field's settings object. Primarily used to support \"preview\" modes where all fields are disabled."
674
+ },
675
+ {
676
+ "name": "done",
677
+ "description": "If set, the field is considered \"done\" and is drawn in a display-final-value state."
678
+ },
679
+ {
680
+ "name": "editable",
681
+ "description": "If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be\nchanged, so it should typically only be enabled in the Builder."
682
+ },
683
+ {
684
+ "name": "fieldname",
685
+ "description": "The name of the field to display."
686
+ },
687
+ {
688
+ "name": "initials",
689
+ "description": "The document or template field to display."
690
+ },
691
+ {
692
+ "name": "moveable",
693
+ "description": "If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields."
694
+ },
695
+ {
696
+ "name": "pagenumber",
697
+ "description": "The page the field is on"
698
+ },
699
+ {
700
+ "name": "source",
701
+ "description": "Fields may be attached to templates or envelopes, but only template fields may be edited.",
702
+ "values": [
703
+ {
704
+ "name": "envelope"
705
+ },
706
+ {
707
+ "name": "template"
708
+ }
709
+ ]
710
+ },
711
+ {
712
+ "name": "sourceid",
713
+ "description": "The source template or envelope ID the field is found in."
714
+ },
715
+ {
716
+ "name": "xscale",
717
+ "description": "If set, the field will be be scaled horizontally by this factor."
718
+ },
719
+ {
720
+ "name": "yscale",
721
+ "description": "If set, the field will be be scaled vertically by this factor."
722
+ }
723
+ ]
724
+ },
725
+ {
726
+ "name": "verdocs-field-payment",
727
+ "description": {
728
+ "kind": "markdown",
729
+ "value": "Displays a signature field. Various field types are supported, including traditional Signature and Initials types as well as\ninput types like text and checkbox."
730
+ },
731
+ "attributes": [
732
+ {
733
+ "name": "current-initial",
734
+ "description": ""
735
+ },
736
+ {
737
+ "name": "current-initial-id",
738
+ "description": ""
739
+ },
740
+ {
741
+ "name": "current-signature",
742
+ "description": ""
743
+ },
744
+ {
745
+ "name": "current-signature-id",
746
+ "description": ""
747
+ },
748
+ {
749
+ "name": "disabled",
750
+ "description": "If set, overrides the field's settings object. Primarily used to support \"preview\" modes where all fields are disabled."
751
+ },
752
+ {
753
+ "name": "done",
754
+ "description": "If set, the field is considered \"done\" and is drawn in a display-final-value state."
755
+ },
756
+ {
757
+ "name": "editable",
758
+ "description": "If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be\nchanged, so it should typically only be enabled in the Builder."
759
+ },
760
+ {
761
+ "name": "field-id",
762
+ "description": ""
763
+ },
764
+ {
765
+ "name": "fieldname",
766
+ "description": "The name of the field to display."
767
+ },
768
+ {
769
+ "name": "moveable",
770
+ "description": "If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields."
771
+ },
772
+ {
773
+ "name": "page-num",
774
+ "description": ""
775
+ },
776
+ {
777
+ "name": "pagenumber",
778
+ "description": "The page the field is on"
779
+ },
780
+ {
781
+ "name": "recipients",
782
+ "description": ""
783
+ },
784
+ {
785
+ "name": "role-name",
786
+ "description": ""
787
+ },
788
+ {
789
+ "name": "roleindex",
790
+ "description": "If set, the field will be colored using this index value to select the background color."
791
+ },
792
+ {
793
+ "name": "selected-role-name",
794
+ "description": ""
795
+ },
796
+ {
797
+ "name": "signed",
798
+ "description": ""
799
+ },
800
+ {
801
+ "name": "source",
802
+ "description": "Fields may be attached to templates or envelopes, but only template fields may be edited.",
803
+ "values": [
804
+ {
805
+ "name": "envelope"
806
+ },
807
+ {
808
+ "name": "template"
809
+ }
810
+ ]
811
+ },
812
+ {
813
+ "name": "sourceid",
814
+ "description": "The source template or envelope ID the field is found in."
815
+ },
816
+ {
817
+ "name": "xscale",
818
+ "description": "If set, the field will be be scaled horizontally by this factor."
819
+ },
820
+ {
821
+ "name": "yscale",
822
+ "description": "If set, the field will be be scaled vertically by this factor."
823
+ }
824
+ ]
825
+ },
826
+ {
827
+ "name": "verdocs-field-radio",
828
+ "description": {
829
+ "kind": "markdown",
830
+ "value": "Displays a radio button."
831
+ },
832
+ "attributes": [
833
+ {
834
+ "name": "disabled",
835
+ "description": "If set, overrides the field's settings object. Primarily used in Storybook mode."
836
+ },
837
+ {
838
+ "name": "done",
839
+ "description": "If set, the field is considered \"done\" and is drawn in a display-final-value state."
840
+ },
841
+ {
842
+ "name": "editable",
843
+ "description": "If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be\nchanged, so it should typically only be enabled in the Builder."
844
+ },
845
+ {
846
+ "name": "fieldname",
847
+ "description": "The name of the field to display."
848
+ },
849
+ {
850
+ "name": "moveable",
851
+ "description": "If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields."
852
+ },
853
+ {
854
+ "name": "pagenumber",
855
+ "description": "The page the field is on"
856
+ },
857
+ {
858
+ "name": "required",
859
+ "description": "If set, overrides the field's required object. Primarily used in Storybook mode."
860
+ },
861
+ {
862
+ "name": "source",
863
+ "description": "Fields may be attached to templates or envelopes, but only template fields may be edited.",
864
+ "values": [
865
+ {
866
+ "name": "envelope"
867
+ },
868
+ {
869
+ "name": "template"
870
+ }
871
+ ]
872
+ },
873
+ {
874
+ "name": "sourceid",
875
+ "description": "The source template or envelope ID the field is found in."
876
+ },
877
+ {
878
+ "name": "xscale",
879
+ "description": "If set, the field will be be scaled horizontally by this factor."
880
+ },
881
+ {
882
+ "name": "yscale",
883
+ "description": "If set, the field will be be scaled vertically by this factor."
884
+ }
885
+ ]
886
+ },
887
+ {
888
+ "name": "verdocs-field-signature",
889
+ "description": {
890
+ "kind": "markdown",
891
+ "value": "Displays a signature field. If a signature already exists, it will be displayed and the field\nwill be disabled. Otherwise, a placeholder button will be shown. Clicking the button will\nshow a dialog to adopt a signature.\n\nNOTE: When signature fields are completed they will be filled with a signature \"stamp\".\nThis requires operation against a live, valid envelope. If you are testing this component\nin Storybook, it will not be visible here."
892
+ },
893
+ "attributes": [
894
+ {
895
+ "name": "disabled",
896
+ "description": "If set, overrides the field's settings object. Primarily used to support \"preview\" modes where all fields are disabled."
897
+ },
898
+ {
899
+ "name": "done",
900
+ "description": "If set, the field is considered \"done\" and is drawn in a display-final-value state."
901
+ },
902
+ {
903
+ "name": "editable",
904
+ "description": "If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be\nchanged, so it should typically only be enabled in the Builder."
905
+ },
906
+ {
907
+ "name": "fieldname",
908
+ "description": "The name of the field to display."
909
+ },
910
+ {
911
+ "name": "moveable",
912
+ "description": "If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields."
913
+ },
914
+ {
915
+ "name": "name",
916
+ "description": "If set, the signature creation dialog will be initialized with this text."
917
+ },
918
+ {
919
+ "name": "pagenumber",
920
+ "description": "The page the field is on"
921
+ },
922
+ {
923
+ "name": "source",
924
+ "description": "Fields may be attached to templates or envelopes, but only template fields may be edited.",
925
+ "values": [
926
+ {
927
+ "name": "envelope"
928
+ },
929
+ {
930
+ "name": "template"
931
+ }
932
+ ]
933
+ },
934
+ {
935
+ "name": "sourceid",
936
+ "description": "The source template or envelope ID the field is found in."
937
+ },
938
+ {
939
+ "name": "xscale",
940
+ "description": "If set, the field will be be scaled horizontally by this factor."
941
+ },
942
+ {
943
+ "name": "yscale",
944
+ "description": "If set, the field will be be scaled vertically by this factor."
945
+ }
946
+ ]
947
+ },
948
+ {
949
+ "name": "verdocs-field-textarea",
950
+ "description": {
951
+ "kind": "markdown",
952
+ "value": "Display a multi-line text input field. Reminder: the \"position\" of the field is specified\nas the BOTTOM-LEFT corner."
953
+ },
954
+ "attributes": [
955
+ {
956
+ "name": "disabled",
957
+ "description": "If set, overrides the field's settings object. Primarily used to support \"preview\" modes where all fields are disabled."
958
+ },
959
+ {
960
+ "name": "done",
961
+ "description": "If set, the field is considered \"done\" and is drawn in a display-final-value state."
962
+ },
963
+ {
964
+ "name": "editable",
965
+ "description": "If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be\nchanged, so it should typically only be enabled in the Builder."
966
+ },
967
+ {
968
+ "name": "fieldname",
969
+ "description": "The name of the field to display."
970
+ },
971
+ {
972
+ "name": "moveable",
973
+ "description": "If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields."
974
+ },
975
+ {
976
+ "name": "pagenumber",
977
+ "description": "The page the field is on"
978
+ },
979
+ {
980
+ "name": "source",
981
+ "description": "Fields may be attached to templates or envelopes, but only template fields may be edited.",
982
+ "values": [
983
+ {
984
+ "name": "envelope"
985
+ },
986
+ {
987
+ "name": "template"
988
+ }
989
+ ]
990
+ },
991
+ {
992
+ "name": "sourceid",
993
+ "description": "The source template or envelope ID the field is found in."
994
+ },
995
+ {
996
+ "name": "xscale",
997
+ "description": "If set, the field will be be scaled horizontally by this factor."
998
+ },
999
+ {
1000
+ "name": "yscale",
1001
+ "description": "If set, the field will be be scaled vertically by this factor."
1002
+ }
1003
+ ]
1004
+ },
1005
+ {
1006
+ "name": "verdocs-field-textbox",
1007
+ "description": {
1008
+ "kind": "markdown",
1009
+ "value": "Display a simple 1-line text input field."
1010
+ },
1011
+ "attributes": [
1012
+ {
1013
+ "name": "disabled",
1014
+ "description": "If set, overrides the field's settings object. Primarily used to support \"preview\" modes where all fields are disabled."
1015
+ },
1016
+ {
1017
+ "name": "done",
1018
+ "description": "If set, the field is considered \"done\" and is drawn in a display-final-value state."
1019
+ },
1020
+ {
1021
+ "name": "editable",
1022
+ "description": "If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be\nchanged, so it should typically only be enabled in the Builder."
1023
+ },
1024
+ {
1025
+ "name": "fieldname",
1026
+ "description": "The name of the field to display."
1027
+ },
1028
+ {
1029
+ "name": "moveable",
1030
+ "description": "If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields."
1031
+ },
1032
+ {
1033
+ "name": "multiline",
1034
+ "description": "If set, overrides the field's settings object. Primarily used to support \"preview\" modes where all fields are disabled."
1035
+ },
1036
+ {
1037
+ "name": "pagenumber",
1038
+ "description": "The page the field is on"
1039
+ },
1040
+ {
1041
+ "name": "source",
1042
+ "description": "Fields may be attached to templates or envelopes, but only template fields may be edited.",
1043
+ "values": [
1044
+ {
1045
+ "name": "envelope"
1046
+ },
1047
+ {
1048
+ "name": "template"
1049
+ }
1050
+ ]
1051
+ },
1052
+ {
1053
+ "name": "sourceid",
1054
+ "description": "The source template or envelope ID the field is found in."
1055
+ },
1056
+ {
1057
+ "name": "xscale",
1058
+ "description": "If set, the field will be be scaled horizontally by this factor."
1059
+ },
1060
+ {
1061
+ "name": "yscale",
1062
+ "description": "If set, the field will be be scaled vertically by this factor."
1063
+ }
1064
+ ]
1065
+ },
1066
+ {
1067
+ "name": "verdocs-field-timestamp",
1068
+ "description": {
1069
+ "kind": "markdown",
1070
+ "value": "Display a timestamp. Timestamps are not editable by signers. Instead, they are automatically\nfilled when the signer submits the document."
1071
+ },
1072
+ "attributes": [
1073
+ {
1074
+ "name": "disabled",
1075
+ "description": "If set, overrides the field's settings object. Primarily used to support \"preview\" modes where all fields are disabled."
1076
+ },
1077
+ {
1078
+ "name": "done",
1079
+ "description": "If set, the field is considered \"done\" and is drawn in a display-final-value state."
1080
+ },
1081
+ {
1082
+ "name": "editable",
1083
+ "description": "If set, a settings icon will be displayed on hover. The settings shown allow the field's recipient and other settings to be\nchanged, so it should typically only be enabled in the Builder."
1084
+ },
1085
+ {
1086
+ "name": "fieldname",
1087
+ "description": "The name of the field to display."
1088
+ },
1089
+ {
1090
+ "name": "moveable",
1091
+ "description": "If set, the field may be dragged to a new location. This should only be enabled in the Builder, or for self-placed fields."
1092
+ },
1093
+ {
1094
+ "name": "pagenumber",
1095
+ "description": "The page the field is on"
1096
+ },
1097
+ {
1098
+ "name": "source",
1099
+ "description": "Fields may be attached to templates or envelopes, but only template fields may be edited.",
1100
+ "values": [
1101
+ {
1102
+ "name": "envelope"
1103
+ },
1104
+ {
1105
+ "name": "template"
1106
+ }
1107
+ ]
1108
+ },
1109
+ {
1110
+ "name": "sourceid",
1111
+ "description": "The source template or envelope ID the field is found in."
1112
+ },
1113
+ {
1114
+ "name": "xscale",
1115
+ "description": "If set, the field will be be scaled horizontally by this factor."
1116
+ },
1117
+ {
1118
+ "name": "yscale",
1119
+ "description": "If set, the field will be be scaled vertically by this factor."
1120
+ }
1121
+ ]
1122
+ },
1123
+ {
1124
+ "name": "verdocs-file-chooser",
1125
+ "description": {
1126
+ "kind": "markdown",
1127
+ "value": "Displays a file picker to upload an attachment. This component is just the picker - the host application or component should\nprovide the actual upload functionality.\n\n```ts\n<verdocs-file-chooser onFileSelected={(e) => console.log('File Selected', e.detail)} />\n```"
1128
+ },
1129
+ "attributes": []
1130
+ },
1131
+ {
1132
+ "name": "verdocs-help-icon",
1133
+ "description": {
1134
+ "kind": "markdown",
1135
+ "value": "Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.\n\n```ts\n<verdocs-help-icon text=\"Sample help text\" />\n```"
1136
+ },
1137
+ "attributes": [
1138
+ {
1139
+ "name": "icon",
1140
+ "description": "Optional icon to display. If not supplied, a standard help icon will be shown."
1141
+ },
1142
+ {
1143
+ "name": "text",
1144
+ "description": "Help text to display on hover/focus"
1145
+ }
1146
+ ]
1147
+ },
1148
+ {
1149
+ "name": "verdocs-initial-dialog",
1150
+ "description": {
1151
+ "kind": "markdown",
1152
+ "value": "Display a dialog that allows the user to specify an initials image, either by using a signature-font-generated image\nbased on their full name, or by hand-drawing their initials with a mouse or tablet."
1153
+ },
1154
+ "attributes": [
1155
+ {
1156
+ "name": "initials",
1157
+ "description": "Initial signature text"
1158
+ }
1159
+ ]
1160
+ },
1161
+ {
1162
+ "name": "verdocs-kba-dialog",
1163
+ "description": {
1164
+ "kind": "markdown",
1165
+ "value": "Prompt the user to confirm their identity with a PIN or a series of questions."
1166
+ },
1167
+ "attributes": [
1168
+ {
1169
+ "name": "helptext",
1170
+ "description": "If set, a help/instructions box will be displayed with this text"
1171
+ },
1172
+ {
1173
+ "name": "helptitle",
1174
+ "description": "If set, a help/instructions box will be displayed with this title"
1175
+ },
1176
+ {
1177
+ "name": "label",
1178
+ "description": "For text input challenges, the label to display next to the input field."
1179
+ },
1180
+ {
1181
+ "name": "mode",
1182
+ "description": "The type of dialog to display. Three modes are supported.",
1183
+ "values": [
1184
+ {
1185
+ "name": "choice"
1186
+ },
1187
+ {
1188
+ "name": "identity"
1189
+ },
1190
+ {
1191
+ "name": "text"
1192
+ }
1193
+ ]
1194
+ },
1195
+ {
1196
+ "name": "placeholder",
1197
+ "description": "For text input challenges, the placeholder to display inside the input field."
1198
+ },
1199
+ {
1200
+ "name": "step",
1201
+ "description": "Which step this confirmation is for, in a multi-step process. Ignored if `steps` is < 2."
1202
+ },
1203
+ {
1204
+ "name": "steps",
1205
+ "description": "How many steps exist in a multi-step process. Set to 1 for a single-step process (hides the indicator)."
1206
+ }
1207
+ ]
1208
+ },
1209
+ {
1210
+ "name": "verdocs-loader",
1211
+ "description": {
1212
+ "kind": "markdown",
1213
+ "value": "Animated loader placeholder. There are currently no configuration options for this control.\n\n```ts\n<verdocs-loader />\n```"
1214
+ },
1215
+ "attributes": []
1216
+ },
1217
+ {
1218
+ "name": "verdocs-menu-panel",
1219
+ "description": {
1220
+ "kind": "markdown",
1221
+ "value": "Display a menu panel in a left or right sidebar. The panel will animate (slide)\nas it appears, and an background will be shown over the rest of the page. If\nthe background overlay is present, it can be clicked to dismiss the panel.\n\n```ts\n<verdocs-menu-panel>\n <div style=\"padding: 20px;\">Menu Panel</div>\n</verdocs-menu-panel>\n```"
1222
+ },
1223
+ "attributes": [
1224
+ {
1225
+ "name": "overlay",
1226
+ "description": "Whether to show an overlay over the rest of the page."
1227
+ },
1228
+ {
1229
+ "name": "side",
1230
+ "description": "Which side of the screen to place the panel.",
1231
+ "values": [
1232
+ {
1233
+ "name": "left"
1234
+ },
1235
+ {
1236
+ "name": "right"
1237
+ }
1238
+ ]
1239
+ },
1240
+ {
1241
+ "name": "width",
1242
+ "description": "The width of the panel."
1243
+ }
1244
+ ]
1245
+ },
1246
+ {
1247
+ "name": "verdocs-ok-dialog",
1248
+ "description": {
1249
+ "kind": "markdown",
1250
+ "value": "Display a simple text dialog box with an Ok button. This adds a partially-transparent overlay and screen-centered dialog\nbox with a message and optional header/title. An OK button is shown that will dismiss the message.\nIt can also be dismissed by clicking the background overlay."
1251
+ },
1252
+ "attributes": [
1253
+ {
1254
+ "name": "button-label",
1255
+ "description": "Override the \"OK\" button's label"
1256
+ },
1257
+ {
1258
+ "name": "heading",
1259
+ "description": "The title of the dialog. \"title\" is a reserved word, so we use heading."
1260
+ },
1261
+ {
1262
+ "name": "message",
1263
+ "description": "The message content to display."
1264
+ },
1265
+ {
1266
+ "name": "show-cancel",
1267
+ "description": "If set, a cancel button will also be displayed. Note that the dialog is always cancelable by clicking the background\noverlay to dismiss it."
1268
+ }
1269
+ ]
1270
+ },
1271
+ {
1272
+ "name": "verdocs-organization-card",
1273
+ "description": {
1274
+ "kind": "markdown",
1275
+ "value": "Display a small summary card describing an organization.\n\n```ts\n<verdocs-organization-card organization={organization} />\n```"
1276
+ },
1277
+ "attributes": []
1278
+ },
1279
+ {
1280
+ "name": "verdocs-pagination",
1281
+ "description": {
1282
+ "kind": "markdown",
1283
+ "value": "Display a simple pagination control with individual buttons to move through the data set.\n\n```ts\n<verdocs-pagination\n selectedPage={1}\n itemCount={50}\n perPage={10}\n onSelectPage={(e) => {setSelectedpage(e.detail.selectedPage)}}\n/>\n```"
1284
+ },
1285
+ "attributes": [
1286
+ {
1287
+ "name": "item-count",
1288
+ "description": "The total number of items."
1289
+ },
1290
+ {
1291
+ "name": "per-page",
1292
+ "description": "The number of displayed per page."
1293
+ },
1294
+ {
1295
+ "name": "selected-page",
1296
+ "description": "The currently selected page."
1297
+ }
1298
+ ]
1299
+ },
1300
+ {
1301
+ "name": "verdocs-portal",
1302
+ "description": {
1303
+ "kind": "markdown",
1304
+ "value": "Display a child component in a \"portal\", popping it out of the main DOM tree\nto allow it to escape the bounds set by its parent."
1305
+ },
1306
+ "attributes": [
1307
+ {
1308
+ "name": "anchor",
1309
+ "description": "Unique ID of the parent element to anchor to."
1310
+ },
1311
+ {
1312
+ "name": "voffset",
1313
+ "description": "Vertical offset from the parent."
1314
+ }
1315
+ ]
1316
+ },
1317
+ {
1318
+ "name": "verdocs-preview",
1319
+ "description": {
1320
+ "kind": "markdown",
1321
+ "value": "Display a template preview experience. This will display the template's attached\ndocuments with signing fields overlaid on each page. Fields will be color-coded\nby recipient, and will be read-only (cannot be filled, moved, or altered).\n\n```ts\n<verdocs-preview\n templateId={templateId}\n onSdkError={({ detail }) => { console.log('SDK error', detail) }\n />\n```"
1322
+ },
1323
+ "attributes": [
1324
+ {
1325
+ "name": "template-id",
1326
+ "description": "The ID of the template to create the document from."
1327
+ }
1328
+ ]
1329
+ },
1330
+ {
1331
+ "name": "verdocs-progress-bar",
1332
+ "description": {
1333
+ "kind": "markdown",
1334
+ "value": "Display a simple progress bar in a style consistent with the design system.\n\n```ts\n<verdocs-progress-bar label=\"Uploading...\" showPercent={true} percent={54} />\n```"
1335
+ },
1336
+ "attributes": [
1337
+ {
1338
+ "name": "label",
1339
+ "description": "Optional label to display above the bar"
1340
+ },
1341
+ {
1342
+ "name": "percent",
1343
+ "description": "The current progress value (0-100)"
1344
+ },
1345
+ {
1346
+ "name": "show-percent",
1347
+ "description": "If true, the progress percentage will be displayed above the bar."
1348
+ }
1349
+ ]
1350
+ },
1351
+ {
1352
+ "name": "verdocs-quick-filter",
1353
+ "description": {
1354
+ "kind": "markdown",
1355
+ "value": "Display a drop-down menu of quick filter options.\n\n```ts\n<verdocs-quick-filter options={[...options]} value={1} label=\"Filter\" placeholder=\"All\" />\n```"
1356
+ },
1357
+ "attributes": [
1358
+ {
1359
+ "name": "label",
1360
+ "description": ""
1361
+ },
1362
+ {
1363
+ "name": "placeholder",
1364
+ "description": ""
1365
+ },
1366
+ {
1367
+ "name": "value",
1368
+ "description": ""
1369
+ }
1370
+ ]
1371
+ },
1372
+ {
1373
+ "name": "verdocs-quick-functions",
1374
+ "description": {
1375
+ "kind": "markdown",
1376
+ "value": "Display quick-function buttons for creating templates and documents.\n\nAuthentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\nembed. This Element will reuse the same session produced by logging in via that Embed."
1377
+ },
1378
+ "attributes": []
1379
+ },
1380
+ {
1381
+ "name": "verdocs-radio-button",
1382
+ "description": {
1383
+ "kind": "markdown",
1384
+ "value": "Displays a radio button. Note that this is different from the `verdocs-field-radio-button` component, which is\ndesigned to be used in signing experiences and contains settings that connect to template fields. This is just a\nsimple radio button for UI displays e.g. dialog boxes.\n\nThis control encapsulates a standard HTML radio button. To subscribe to change events, connect an `onChange`\nhandler. Sample usage:\n\n```ts\n<verdocs-radio-button\n value=\"val1\"\n name=\"someProperty\"\n checked={this.someProperty === 'val1'}\n onInput={(e: any) => { this.someProperty = 'val1' }}\n disabled={false}\n/>\n```"
1385
+ },
1386
+ "attributes": [
1387
+ {
1388
+ "name": "checked",
1389
+ "description": "Whether the radio button is currently selected."
1390
+ },
1391
+ {
1392
+ "name": "disabled",
1393
+ "description": "If set, the button will still be displayed but not selectable."
1394
+ },
1395
+ {
1396
+ "name": "name",
1397
+ "description": "HTML form field name for the input."
1398
+ },
1399
+ {
1400
+ "name": "value",
1401
+ "description": "Value to track with the input."
1402
+ }
1403
+ ]
1404
+ },
1405
+ {
1406
+ "name": "verdocs-search-box",
1407
+ "description": {
1408
+ "kind": "markdown",
1409
+ "value": "Displays a customizable input box for search queries.\n\nAuthentication is required to demonstrate this Element. You may do this in Storybook by using the Auth\nembed. This Element will reuse the same session produced by logging in via that Embed."
1410
+ },
1411
+ "attributes": [
1412
+ {
1413
+ "name": "grabs-focus",
1414
+ "description": "If set, the input field will attempt to \"grab\" focus after being rendered."
1415
+ },
1416
+ {
1417
+ "name": "placeholder",
1418
+ "description": "The placeholder to display in the input field."
1419
+ },
1420
+ {
1421
+ "name": "query",
1422
+ "description": "The text search string entered by the user."
1423
+ },
1424
+ {
1425
+ "name": "type",
1426
+ "description": "If set to a value other than 'all', a removeable filter indicator will be displayed.",
1427
+ "values": [
1428
+ {
1429
+ "name": "all"
1430
+ },
1431
+ {
1432
+ "name": "document"
1433
+ },
1434
+ {
1435
+ "name": "organization"
1436
+ },
1437
+ {
1438
+ "name": "template"
1439
+ }
1440
+ ]
1441
+ }
1442
+ ]
1443
+ },
1444
+ {
1445
+ "name": "verdocs-search-tabs",
1446
+ "description": {
1447
+ "kind": "markdown",
1448
+ "value": ""
1449
+ },
1450
+ "attributes": []
1451
+ },
1452
+ {
1453
+ "name": "verdocs-select-input",
1454
+ "description": {
1455
+ "kind": "markdown",
1456
+ "value": "Display a text input field. This is just a standard HTML input field with minimal markup to fit the\nvisual styles of the other components. Note that events \"bubble\" from the input field to the container,\nso you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.\n\n```ts\n<verdocs-select-input label=\"Select:\" label=\"Select\" options={[...options]}"
1457
+ },
1458
+ "attributes": [
1459
+ {
1460
+ "name": "disabled",
1461
+ "description": "Should the field be disabled?"
1462
+ },
1463
+ {
1464
+ "name": "label",
1465
+ "description": "The label for the field."
1466
+ },
1467
+ {
1468
+ "name": "value",
1469
+ "description": "The initial value for the input field."
1470
+ }
1471
+ ]
1472
+ },
1473
+ {
1474
+ "name": "verdocs-send",
1475
+ "description": {
1476
+ "kind": "markdown",
1477
+ "value": "Display a form to send a template to one or more recipients in an envelope for signing.\nHost applications should ensure the template is \"sendable\" before displaying this component.\nTo be sendable, a template must have at least one document attached, at least one participant\ndefined, and at least one field assigned to every \"signer\" participant. This component will\nhide itself if the template is not sendable.\n\n```ts\n<verdocs-send\n templateId={templateId}\n onBeforeSend={({ detail })) => { console.log('Sending... Show a spinner...', detail) }\n onSend={({ detail }) => { console.log('Sent! Hide the spinner...', detail) }\n onExit={(e) => { console.log('Send cancelled.', detail) }\n onSdkError={({ detail }) => { console.log('SDK error', detail) }\n />\n```"
1478
+ },
1479
+ "attributes": [
1480
+ {
1481
+ "name": "environment",
1482
+ "description": "The environment the control is being called from, e.g. 'web'. This has an impact on how certain\noperations such as email communications are handled to ensure users receive the correct URLs for\ntheir invitations. Setting this to unknown values may produce unexpected/incorrect behaviors.\nIf environment is not known, do this set this property."
1483
+ },
1484
+ {
1485
+ "name": "template-id",
1486
+ "description": "The ID of the template to create the document from."
1487
+ }
1488
+ ]
1489
+ },
1490
+ {
1491
+ "name": "verdocs-sign",
1492
+ "description": {
1493
+ "kind": "markdown",
1494
+ "value": "Display an envelope signing experience. This will display the envelope's attached\ndocuments with signing fields overlaid on each page.\n\nThe component will attempt to initiate a signing session and load the specified\nenvelope. If successful, the recipient's fields will be enabled and the user will\nbe able to sign the envelope's attached documents. If not, an `sdkError` will be\nthrown and the component will be blank/empty. To provide the best user experience,\napplications should capture and handle this error to provide the user with\ninstructions/options for next steps based on the application's design and workflow.\n\nUnlike other components, this will always create its own endpoint to manage the\nsession session. This endpoint will be included in event callbacks for the\nconvenience of host applications that may wish to make server calls using the\nsigner's credentials once signing is complete (e.g. to obtain copies of\nthe signed attachments.)"
1495
+ },
1496
+ "attributes": [
1497
+ {
1498
+ "name": "envelope-id",
1499
+ "description": "The ID of the envelope to sign."
1500
+ },
1501
+ {
1502
+ "name": "header-target-id",
1503
+ "description": "If set, (recommended), the host application should create a <DIV> element with a unique ID. When this\ncomponent renders, the header will be removed from its default location and placed in the target element.\nThis allows the parent application to more easily control its placement and scroll effects (e.g. \"fixed\").\n\nThe movement of the header to the target container is not dynamic - it is performed only on the initial\nrender. Host applications should not conditionally render this container. If the header's visibility must\nbe externally controlled, use CSS display options to hide/show it instead."
1504
+ },
1505
+ {
1506
+ "name": "invite-code",
1507
+ "description": "The invite code for the signer."
1508
+ },
1509
+ {
1510
+ "name": "role-id",
1511
+ "description": "The ID of the role that will be signing e.g. 'Recipient 1'"
1512
+ }
1513
+ ]
1514
+ },
1515
+ {
1516
+ "name": "verdocs-signature-dialog",
1517
+ "description": {
1518
+ "kind": "markdown",
1519
+ "value": "Display a dialog that allows the user to specify a signature image, either by using a signature-font-generated image\nbased on their full name, or by hand-drawing their signature with a mouse or tablet."
1520
+ },
1521
+ "attributes": [
1522
+ {
1523
+ "name": "name",
1524
+ "description": "Initial signature text"
1525
+ }
1526
+ ]
1527
+ },
1528
+ {
1529
+ "name": "verdocs-spinner",
1530
+ "description": {
1531
+ "kind": "markdown",
1532
+ "value": "Display a small loading spinner.\n\n```ts\n<verdocs-spinner />\n```"
1533
+ },
1534
+ "attributes": [
1535
+ {
1536
+ "name": "mode",
1537
+ "description": "",
1538
+ "values": [
1539
+ {
1540
+ "name": "dark"
1541
+ },
1542
+ {
1543
+ "name": "light"
1544
+ }
1545
+ ]
1546
+ },
1547
+ {
1548
+ "name": "size",
1549
+ "description": ""
1550
+ }
1551
+ ]
1552
+ },
1553
+ {
1554
+ "name": "verdocs-status-indicator",
1555
+ "description": {
1556
+ "kind": "markdown",
1557
+ "value": "Displays an icon and message describing a document's completion status. For convenience, the status may be passed in either\ndirectly as a status field or the whole document object may be passed in.\n\nIf the document is provided, the status flag will indicate the document's overall status. This also makes the component clickable\nto display a popup panel with per-recipient status data.\n\nIf the status is provided as a string it can be either a `TRecipientStatus` or `TDocumentStatus` value."
1558
+ },
1559
+ "attributes": [
1560
+ {
1561
+ "name": "size",
1562
+ "description": "The size (height) of the indicator. The small variant is suitable for use in densely populated components such as table rows.",
1563
+ "values": [
1564
+ {
1565
+ "name": "normal"
1566
+ },
1567
+ {
1568
+ "name": "small"
1569
+ }
1570
+ ]
1571
+ },
1572
+ {
1573
+ "name": "status",
1574
+ "description": "The status to display.",
1575
+ "values": [
1576
+ {
1577
+ "name": "accepted"
1578
+ },
1579
+ {
1580
+ "name": "canceled"
1581
+ },
1582
+ {
1583
+ "name": "complete"
1584
+ },
1585
+ {
1586
+ "name": "declined"
1587
+ },
1588
+ {
1589
+ "name": "in progress"
1590
+ },
1591
+ {
1592
+ "name": "invited"
1593
+ },
1594
+ {
1595
+ "name": "opened"
1596
+ },
1597
+ {
1598
+ "name": "pending"
1599
+ },
1600
+ {
1601
+ "name": "signed"
1602
+ },
1603
+ {
1604
+ "name": "submitted"
1605
+ }
1606
+ ]
1607
+ },
1608
+ {
1609
+ "name": "theme",
1610
+ "description": "The theme to use for diplay.",
1611
+ "values": [
1612
+ {
1613
+ "name": "dark"
1614
+ },
1615
+ {
1616
+ "name": "light"
1617
+ }
1618
+ ]
1619
+ }
1620
+ ]
1621
+ },
1622
+ {
1623
+ "name": "verdocs-switch",
1624
+ "description": {
1625
+ "kind": "markdown",
1626
+ "value": "Displays a toggle switch.\n\n```ts\n<verdocs-switch checked={sendReminders} onCheckedChange={setSendReminders} />\n```"
1627
+ },
1628
+ "attributes": [
1629
+ {
1630
+ "name": "checked",
1631
+ "description": ""
1632
+ },
1633
+ {
1634
+ "name": "disabled",
1635
+ "description": "Should the field be disabled?"
1636
+ },
1637
+ {
1638
+ "name": "theme",
1639
+ "description": "Select purple or green treatments.",
1640
+ "values": [
1641
+ {
1642
+ "name": "primary"
1643
+ },
1644
+ {
1645
+ "name": "secondary"
1646
+ }
1647
+ ]
1648
+ }
1649
+ ]
1650
+ },
1651
+ {
1652
+ "name": "verdocs-table",
1653
+ "description": {
1654
+ "kind": "markdown",
1655
+ "value": "Display a simple table of data. Columns and data cells may have custom renderers defined to\nsupport creating interactive table layouts.\n\n```ts\n<verdocs-table columns={[...columns]} data={[...data]} />\n```"
1656
+ },
1657
+ "attributes": []
1658
+ },
1659
+ {
1660
+ "name": "verdocs-tabs",
1661
+ "description": {
1662
+ "kind": "markdown",
1663
+ "value": "Display a simple row of selectable tabs. This is a controlled element.\nThe parent must adjust selectedTab as selection events are fired.\n\n```ts\n<verdocs-tabs tabs={[...tabs]} />\n```"
1664
+ },
1665
+ "attributes": [
1666
+ {
1667
+ "name": "selected-tab",
1668
+ "description": "The index of the tab to show selected."
1669
+ }
1670
+ ]
1671
+ },
1672
+ {
1673
+ "name": "verdocs-template-attachments",
1674
+ "description": {
1675
+ "kind": "markdown",
1676
+ "value": "Displays an edit form that allows the user to view, add, or remove a template's attachments.\nNote that an active session and valid template ID must be supplied."
1677
+ },
1678
+ "attributes": [
1679
+ {
1680
+ "name": "template-id",
1681
+ "description": "The template ID to edit."
1682
+ }
1683
+ ]
1684
+ },
1685
+ {
1686
+ "name": "verdocs-template-build-tabs",
1687
+ "description": {
1688
+ "kind": "markdown",
1689
+ "value": "Display a set of tabs for the template builder."
1690
+ },
1691
+ "attributes": [
1692
+ {
1693
+ "name": "step",
1694
+ "description": "The step in the creation process to display.",
1695
+ "values": [
1696
+ {
1697
+ "name": "attachments"
1698
+ },
1699
+ {
1700
+ "name": "fields"
1701
+ },
1702
+ {
1703
+ "name": "preview"
1704
+ },
1705
+ {
1706
+ "name": "roles"
1707
+ },
1708
+ {
1709
+ "name": "settings"
1710
+ }
1711
+ ]
1712
+ },
1713
+ {
1714
+ "name": "template-id",
1715
+ "description": "The ID of the template to create the document from. Unlike most other components, this is an optional parameter here.\nIf the template ID is known, `step` may also be specified to force displaying a specific step in the creation process.\nIf it is not specified, `step` will be ignored and the create step will be shown."
1716
+ }
1717
+ ]
1718
+ },
1719
+ {
1720
+ "name": "verdocs-template-card",
1721
+ "description": {
1722
+ "kind": "markdown",
1723
+ "value": "Displays a summary of a template"
1724
+ },
1725
+ "attributes": []
1726
+ },
1727
+ {
1728
+ "name": "verdocs-template-create",
1729
+ "description": {
1730
+ "kind": "markdown",
1731
+ "value": "Displays a file upload mechanism suitable for the first step of creating a template.\nThis is typically the first step in a template creation workflow."
1732
+ },
1733
+ "attributes": [
1734
+ {
1735
+ "name": "max-size",
1736
+ "description": ""
1737
+ }
1738
+ ]
1739
+ },
1740
+ {
1741
+ "name": "verdocs-template-document-page",
1742
+ "description": {
1743
+ "kind": "markdown",
1744
+ "value": "Represents one document page. This is primarily a layout container used to coordinate positions of\npage-related layers such as the page itself, signature fields, etc. It is not intended to be used\non its own as an individual component."
1745
+ },
1746
+ "attributes": [
1747
+ {
1748
+ "name": "disabled",
1749
+ "description": "Whether the fields should be disabled (Builder)"
1750
+ },
1751
+ {
1752
+ "name": "document-id",
1753
+ "description": "The ID of the document to display."
1754
+ },
1755
+ {
1756
+ "name": "done",
1757
+ "description": "Whether the field are interactable (done/submitted disables this)"
1758
+ },
1759
+ {
1760
+ "name": "editable",
1761
+ "description": "Whether the fields should be editable (Builder)"
1762
+ },
1763
+ {
1764
+ "name": "page-number",
1765
+ "description": "The page number being rendered. (Reminder: page numbers are 1-based.)"
1766
+ },
1767
+ {
1768
+ "name": "template-id",
1769
+ "description": "The ID of the template the document is for."
1770
+ },
1771
+ {
1772
+ "name": "virtual-height",
1773
+ "description": "The \"virtual\" height of the page canvas. Defaults to 792 which at 72dpi is 11\" tall. This is used to compute\nthe aspect ratio of the final rendered element when scaling up/down."
1774
+ },
1775
+ {
1776
+ "name": "virtual-width",
1777
+ "description": "The \"virtual\" width of the page canvas. Defaults to 612 which at 72dpi is 8.5\" wide. This is used to compute\nthe aspect ratio of the final rendered element when scaling up/down."
1778
+ }
1779
+ ]
1780
+ },
1781
+ {
1782
+ "name": "verdocs-template-field-properties",
1783
+ "description": {
1784
+ "kind": "markdown",
1785
+ "value": "Displays an edit form that allows the user to adjust a field's settings."
1786
+ },
1787
+ "attributes": [
1788
+ {
1789
+ "name": "field-name",
1790
+ "description": "The field to configure."
1791
+ },
1792
+ {
1793
+ "name": "help-text",
1794
+ "description": "If specified, the properties card will have a \"back\" side with the help text as its content."
1795
+ },
1796
+ {
1797
+ "name": "template-id",
1798
+ "description": "The template ID to edit."
1799
+ }
1800
+ ]
1801
+ },
1802
+ {
1803
+ "name": "verdocs-template-fields",
1804
+ "description": {
1805
+ "kind": "markdown",
1806
+ "value": "Displays a builder experience for laying out fields in a template. Note that this experience requires a large display area to\npresent all of the required controls, so it is primarily intended to be used in desktop environments."
1807
+ },
1808
+ "attributes": [
1809
+ {
1810
+ "name": "template-id",
1811
+ "description": "The ID of the template to create the document from."
1812
+ },
1813
+ {
1814
+ "name": "toolbar-target-id",
1815
+ "description": "If set, (recommended), the host application should create a <DIV> element with a unique ID. When this\ncomponent renders, the toolbar will be removed from its default location and placed in the target element.\nThis allows the parent application to more easily control its placement and scroll effects.\n\nThe movement of the toolbar to the target container is not dynamic - it is performed only on the initial\nrender. Host applications should not conditionally render this container. If the toolbar's visibility must\nbe externally controlled, use CSS display options to hide/show it instead."
1816
+ }
1817
+ ]
1818
+ },
1819
+ {
1820
+ "name": "verdocs-template-role-properties",
1821
+ "description": {
1822
+ "kind": "markdown",
1823
+ "value": "Present an editing form suitable for adjusting template-role properties."
1824
+ },
1825
+ "attributes": [
1826
+ {
1827
+ "name": "role-name",
1828
+ "description": "The role name to edit."
1829
+ },
1830
+ {
1831
+ "name": "template-id",
1832
+ "description": "The template ID to edit."
1833
+ }
1834
+ ]
1835
+ },
1836
+ {
1837
+ "name": "verdocs-template-roles",
1838
+ "description": {
1839
+ "kind": "markdown",
1840
+ "value": "Display an edit form that allows the user to adjust a template's roles and workflow."
1841
+ },
1842
+ "attributes": [
1843
+ {
1844
+ "name": "template-id",
1845
+ "description": "The template ID to edit."
1846
+ }
1847
+ ]
1848
+ },
1849
+ {
1850
+ "name": "verdocs-template-star",
1851
+ "description": {
1852
+ "kind": "markdown",
1853
+ "value": "Displays a clickable star that allows users to mark frequently-used templates."
1854
+ },
1855
+ "attributes": []
1856
+ },
1857
+ {
1858
+ "name": "verdocs-template-tags",
1859
+ "description": {
1860
+ "kind": "markdown",
1861
+ "value": "Displays a message listing a template's tags."
1862
+ },
1863
+ "attributes": []
1864
+ },
1865
+ {
1866
+ "name": "verdocs-templates-list",
1867
+ "description": {
1868
+ "kind": "markdown",
1869
+ "value": "Displays a list of envelopes matching specified conditions."
1870
+ },
1871
+ "attributes": [
1872
+ {
1873
+ "name": "name",
1874
+ "description": "If set, filter templates by the specified name."
1875
+ },
1876
+ {
1877
+ "name": "rows-per-page",
1878
+ "description": "The number of rows to display per page."
1879
+ },
1880
+ {
1881
+ "name": "selected-page",
1882
+ "description": "The initial page number to select. Pagination is internally controlled but may be overriden by the\nhost applicaiton."
1883
+ },
1884
+ {
1885
+ "name": "show-pagination",
1886
+ "description": "Whether or not pagination should be enabled."
1887
+ },
1888
+ {
1889
+ "name": "sort",
1890
+ "description": "The sort order to display."
1891
+ },
1892
+ {
1893
+ "name": "starred",
1894
+ "description": "The starred settings to filter by.",
1895
+ "values": [
1896
+ {
1897
+ "name": "all"
1898
+ },
1899
+ {
1900
+ "name": "starred"
1901
+ },
1902
+ {
1903
+ "name": "unstarred"
1904
+ }
1905
+ ]
1906
+ },
1907
+ {
1908
+ "name": "visibility",
1909
+ "description": "The sharing settings to filter by.",
1910
+ "values": [
1911
+ {
1912
+ "name": "private"
1913
+ },
1914
+ {
1915
+ "name": "private_shared"
1916
+ },
1917
+ {
1918
+ "name": "public"
1919
+ },
1920
+ {
1921
+ "name": "shared"
1922
+ }
1923
+ ]
1924
+ }
1925
+ ]
1926
+ },
1927
+ {
1928
+ "name": "verdocs-text-input",
1929
+ "description": {
1930
+ "kind": "markdown",
1931
+ "value": "Display a text input field. This is just a standard HTML input field with minimal markup to fit the\nvisual styles of the other components. Note that events \"bubble\" from the input field to the container,\nso you can subscribe to the same DOM events (input, blur, etc) that a normal input would emit.\n\n```ts\n<verdocs-text-input type=\"text\" label=\"Name\" placeholder=\"Enter your name...\" value=\"\" />\n```"
1932
+ },
1933
+ "attributes": [
1934
+ {
1935
+ "name": "autocomplete",
1936
+ "description": "If desired, the autocomplete attribute to set."
1937
+ },
1938
+ {
1939
+ "name": "clearable",
1940
+ "description": "If set, a clear button will be displayed."
1941
+ },
1942
+ {
1943
+ "name": "copyable",
1944
+ "description": "If set, a copy-to-clipboard button will be displayed. NOTE: A field may not be\nboth clearable and copyable. If both properties are set to true, copyable will\nbe ignored."
1945
+ },
1946
+ {
1947
+ "name": "disabled",
1948
+ "description": "Should the field be disabled?"
1949
+ },
1950
+ {
1951
+ "name": "help-text",
1952
+ "description": "If supplied, a help icon will be displayed to provide the user more information."
1953
+ },
1954
+ {
1955
+ "name": "label",
1956
+ "description": "The label for the field."
1957
+ },
1958
+ {
1959
+ "name": "placeholder",
1960
+ "description": "The placeholder for the field."
1961
+ },
1962
+ {
1963
+ "name": "required",
1964
+ "description": "Should the field be required?"
1965
+ },
1966
+ {
1967
+ "name": "type",
1968
+ "description": "The type of field to render. Only text-type fields are allowed here for the current styling. Additional types\n(e.g. a date picker) will be supported by other controls in the future.",
1969
+ "values": [
1970
+ {
1971
+ "name": "email"
1972
+ },
1973
+ {
1974
+ "name": "number"
1975
+ },
1976
+ {
1977
+ "name": "password"
1978
+ },
1979
+ {
1980
+ "name": "search"
1981
+ },
1982
+ {
1983
+ "name": "tel"
1984
+ },
1985
+ {
1986
+ "name": "text"
1987
+ },
1988
+ {
1989
+ "name": "url"
1990
+ }
1991
+ ]
1992
+ },
1993
+ {
1994
+ "name": "value",
1995
+ "description": "The initial value for the input field."
1996
+ }
1997
+ ]
1998
+ },
1999
+ {
2000
+ "name": "verdocs-toggle",
2001
+ "description": {
2002
+ "kind": "markdown",
2003
+ "value": "Displays a label and a set of buttons, also allowing a default selection of a button.\n\n```ts\n<verdocs-toggle options={[...options]} theme=\"light\"></verdocs-toggle>\n```"
2004
+ },
2005
+ "attributes": [
2006
+ {
2007
+ "name": "theme",
2008
+ "description": "The \"theme\" to be used",
2009
+ "values": [
2010
+ {
2011
+ "name": "dark"
2012
+ },
2013
+ {
2014
+ "name": "light"
2015
+ }
2016
+ ]
2017
+ }
2018
+ ]
2019
+ },
2020
+ {
2021
+ "name": "verdocs-toggle-button",
2022
+ "description": {
2023
+ "kind": "markdown",
2024
+ "value": "Displays a single button that can be toggled on or off by clicking it.\n\n```ts\n<verdocs-toggle-button icon={MessageIcon} size=\"normal\" active={true} />\n```"
2025
+ },
2026
+ "attributes": [
2027
+ {
2028
+ "name": "active",
2029
+ "description": ""
2030
+ },
2031
+ {
2032
+ "name": "icon",
2033
+ "description": "If set, should be an SVG object. This will be rendered as the button's visible element. If icon is supplied, label is ignored."
2034
+ },
2035
+ {
2036
+ "name": "label",
2037
+ "description": "If set, should be an SVG object. This will be rendered as the button's visible element. If icon is supplied, label is ignored."
2038
+ },
2039
+ {
2040
+ "name": "size",
2041
+ "description": "How large the button should be. Small buttons are intended for dialog boxes and other smaller scale UI regions.",
2042
+ "values": [
2043
+ {
2044
+ "name": "normal"
2045
+ },
2046
+ {
2047
+ "name": "small"
2048
+ }
2049
+ ]
2050
+ }
2051
+ ]
2052
+ },
2053
+ {
2054
+ "name": "verdocs-toolbar-icon",
2055
+ "description": {
2056
+ "kind": "markdown",
2057
+ "value": "Displays a simple help icon. Upon hover or focus, a tooltip will be displayed with help text.\n\n```ts\n<verdocs-toolbar-icon text=\"Sample tooltip text\" icon={CalendarIcon} />\n```"
2058
+ },
2059
+ "attributes": [
2060
+ {
2061
+ "name": "icon",
2062
+ "description": "SVG icon to display"
2063
+ },
2064
+ {
2065
+ "name": "placement",
2066
+ "description": "Override the Popper \"placement\" setting",
2067
+ "values": [
2068
+ {
2069
+ "name": "auto"
2070
+ },
2071
+ {
2072
+ "name": "auto-end"
2073
+ },
2074
+ {
2075
+ "name": "auto-start"
2076
+ },
2077
+ {
2078
+ "name": "bottom"
2079
+ },
2080
+ {
2081
+ "name": "bottom-end"
2082
+ },
2083
+ {
2084
+ "name": "bottom-start"
2085
+ },
2086
+ {
2087
+ "name": "left"
2088
+ },
2089
+ {
2090
+ "name": "left-end"
2091
+ },
2092
+ {
2093
+ "name": "left-start"
2094
+ },
2095
+ {
2096
+ "name": "right"
2097
+ },
2098
+ {
2099
+ "name": "right-end"
2100
+ },
2101
+ {
2102
+ "name": "right-start"
2103
+ },
2104
+ {
2105
+ "name": "top"
2106
+ },
2107
+ {
2108
+ "name": "top-end"
2109
+ },
2110
+ {
2111
+ "name": "top-start"
2112
+ }
2113
+ ]
2114
+ },
2115
+ {
2116
+ "name": "text",
2117
+ "description": "Help text to display on hover/focus"
2118
+ }
2119
+ ]
2120
+ },
2121
+ {
2122
+ "name": "verdocs-upload-dialog",
2123
+ "description": {
2124
+ "kind": "markdown",
2125
+ "value": "Display a file upload tool. Note that the file is not actually transmitted, so it may be used by\ncallers with a variety of workflows. Instead, data about the chosen file will be passed to the\ncaller via the onNext event handler. A delete event is also exposed to delete existing attachments.\nTo represent an existing attachment, set the existingFile property."
2126
+ },
2127
+ "attributes": [
2128
+ {
2129
+ "name": "existing-file",
2130
+ "description": ""
2131
+ },
2132
+ {
2133
+ "name": "max-size",
2134
+ "description": ""
2135
+ }
2136
+ ]
2137
+ },
2138
+ {
2139
+ "name": "verdocs-view",
2140
+ "description": {
2141
+ "kind": "markdown",
2142
+ "value": "Render the documents attached to an envelope in read-only (view) mode. All documents are\ndisplayed in order.\n\n```ts\n<verdocs-view\n envelopeId={envelopeId}\n onSdkError={({ detail }) => { console.log('SDK error', detail) }\n />\n```"
2143
+ },
2144
+ "attributes": [
2145
+ {
2146
+ "name": "envelope-id",
2147
+ "description": "The envelope ID to render. Set ONE OF templateId or envelopeId. If both are set, envelopeId will be ignored."
2148
+ },
2149
+ {
2150
+ "name": "header-target-id",
2151
+ "description": "If set, (recommended), the host application should create a <DIV> element with a unique ID. When this\ncomponent renders, the header will be removed from its default location and placed in the target element.\nThis allows the parent application to more easily control its placement and scroll effects (e.g. \"fixed\").\n\nThe movement of the header to the target container is not dynamic - it is performed only on the initial\nrender. Host applications should not conditionally render this container. If the header's visibility must\nbe externally controlled, use CSS display options to hide/show it instead."
2152
+ }
2153
+ ]
2154
+ }
2155
+ ]
2156
+ }