@verdocs/web-sdk 1.9.14 → 1.9.15

package/dist/docs.json

@@ -1,5 +1,5 @@
 {
-  "timestamp": "2023-01-03T03:13:14",
+  "timestamp": "2023-01-03T18:39:02",
   "compiler": {
     "name": "@stencil/core",
     "version": "2.20.0",
@@ -558,6 +558,23 @@
           "optional": true,
           "required": false
         },
+        {
+          "name": "label",
+          "type": "string",
+          "mutable": false,
+          "attr": "label",
+          "reflectToAttr": false,
+          "docs": "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.",
+          "docsTags": [],
+          "default": "''",
+          "values": [
+            {
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "name",
           "type": "string",
@@ -575,13 +592,35 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "theme",
+          "type": "\"dark\" | \"light\"",
+          "mutable": false,
+          "attr": "theme",
+          "reflectToAttr": false,
+          "docs": "Style of checkbox to render. Use 'dark' when rendering on a dark background.",
+          "docsTags": [],
+          "default": "'light'",
+          "values": [
+            {
+              "value": "dark",
+              "type": "string"
+            },
+            {
+              "value": "light",
+              "type": "string"
+            }
+          ],
+          "optional": false,
+          "required": false
+        },
         {
           "name": "value",
           "type": "string",
           "mutable": false,
           "attr": "value",
           "reflectToAttr": false,
-          "docs": "Value to track with the input.",
+          "docs": "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.",
           "docsTags": [],
           "default": "''",
           "values": [
@@ -600,10 +639,14 @@
       "slots": [],
       "parts": [],
       "dependents": [
+        "verdocs-sign",
         "verdocs-template-properties"
       ],
       "dependencies": [],
       "dependencyGraph": {
+        "verdocs-sign": [
+          "verdocs-checkbox"
+        ],
         "verdocs-template-properties": [
           "verdocs-checkbox"
         ]
@@ -855,7 +898,7 @@
       "filePath": "./src/components/controls/verdocs-dropdown/verdocs-dropdown.tsx",
       "encapsulation": "none",
       "tag": "verdocs-dropdown",
-      "docs": "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.\n\n```html\n<verdocs-dropdown\n  options={[\n    {label: 'Option 1', disabled: true},\n    {label: 'Option 2', id: '2'}\n  ]}\n  label=\"OK\" onClick={() => (console.log('OK clicked'))}\n/>\n```",
+      "docs": "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.\n\n```html\n<verdocs-dropdown\n  options={[\n    {label: 'Option 1', disabled: true},\n    {label: 'Option 2', id: '2'}\n   ]}\n  label=\"OK\" onClick={() => (console.log('OK clicked'))}\n/>\n```",
       "docsTags": [],
       "usage": {},
       "props": [
@@ -947,15 +990,17 @@
           "required": false
         },
         {
-          "name": "recipient",
-          "type": "IRecipient",
+          "name": "roleIndex",
+          "type": "number",
           "mutable": false,
+          "attr": "role-index",
           "reflectToAttr": false,
-          "docs": "The recipient completing the form, if known.",
+          "docs": "If set, the field will be colored using this index value to select the background color.",
           "docsTags": [],
+          "default": "0",
           "values": [
             {
-              "type": "IRecipient"
+              "type": "number"
             }
           ],
           "optional": true,
@@ -1055,15 +1100,17 @@
           "required": false
         },
         {
-          "name": "recipient",
-          "type": "IRecipient",
+          "name": "roleindex",
+          "type": "number",
           "mutable": false,
+          "attr": "roleindex",
           "reflectToAttr": false,
-          "docs": "The recipient completing the form, if known.",
+          "docs": "If set, the field will be colored using this index value to select the background color.",
           "docsTags": [],
+          "default": "0",
           "values": [
             {
-              "type": "IRecipient"
+              "type": "number"
             }
           ],
           "optional": true,
@@ -1076,15 +1123,9 @@
       "styles": [],
       "slots": [],
       "parts": [],
-      "dependents": [
-        "verdocs-sign"
-      ],
+      "dependents": [],
       "dependencies": [],
-      "dependencyGraph": {
-        "verdocs-sign": [
-          "verdocs-field-checkbox"
-        ]
-      }
+      "dependencyGraph": {}
     },
     {
       "filePath": "./src/components/elements/verdocs-field-date/verdocs-field-date.tsx",
@@ -1164,21 +1205,6 @@
           "optional": true,
           "required": false
         },
-        {
-          "name": "recipient",
-          "type": "IRecipient",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "The recipient completing the form, if known.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "IRecipient"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "roleindex",
           "type": "number",
@@ -1284,15 +1310,17 @@
           "required": false
         },
         {
-          "name": "recipient",
-          "type": "IRecipient",
+          "name": "roleindex",
+          "type": "number",
           "mutable": false,
+          "attr": "roleindex",
           "reflectToAttr": false,
-          "docs": "The recipient completing the form, if known.",
+          "docs": "If set, the field will be colored using this index value to select the background color.",
           "docsTags": [],
+          "default": "0",
           "values": [
             {
-              "type": "IRecipient"
+              "type": "number"
             }
           ],
           "optional": true,
@@ -1313,15 +1341,6 @@
         }
       ],
       "events": [
-        {
-          "event": "fieldBlur",
-          "detail": "boolean",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the input field gains focus.",
-          "docsTags": []
-        },
         {
           "event": "fieldChange",
           "detail": "string",
@@ -1330,15 +1349,6 @@
           "composed": true,
           "docs": "Event fired when the input field value changes. Note that this will only be fired on blur, tab-out, ENTER key press, etc.\nIt is generally the best event to subscribe to than `input` for most cases EXCEPT autocomplete fields that need to see every\nkeypress.",
           "docsTags": []
-        },
-        {
-          "event": "fieldFocus",
-          "detail": "boolean",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the input field loses focus.",
-          "docsTags": []
         }
       ],
       "listeners": [],
@@ -1444,21 +1454,6 @@
           "optional": true,
           "required": false
         },
-        {
-          "name": "recipient",
-          "type": "IRecipient",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "The recipient completing the form, if known.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "IRecipient"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "roleindex",
           "type": "number",
@@ -1739,21 +1734,6 @@
           "optional": false,
           "required": false
         },
-        {
-          "name": "recipient",
-          "type": "IRecipient",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "The recipient completing the form, if known.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "IRecipient"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "recipients",
           "type": "any",
@@ -1786,6 +1766,23 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "roleindex",
+          "type": "number",
+          "mutable": false,
+          "attr": "roleindex",
+          "reflectToAttr": false,
+          "docs": "If set, the field will be colored using this index value to select the background color.",
+          "docsTags": [],
+          "default": "0",
+          "values": [
+            {
+              "type": "number"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "selectedRoleName",
           "type": "string",
@@ -1911,15 +1908,17 @@
           "required": false
         },
         {
-          "name": "recipient",
-          "type": "IRecipient",
+          "name": "roleindex",
+          "type": "number",
           "mutable": false,
+          "attr": "roleindex",
           "reflectToAttr": false,
-          "docs": "The recipient completing the form, if known.",
+          "docs": "If set, the field will be colored using this index value to select the background color.",
           "docsTags": [],
+          "default": "0",
           "values": [
             {
-              "type": "IRecipient"
+              "type": "number"
             }
           ],
           "optional": true,
@@ -1942,15 +1941,9 @@
       "styles": [],
       "slots": [],
       "parts": [],
-      "dependents": [
-        "verdocs-sign"
-      ],
+      "dependents": [],
       "dependencies": [],
-      "dependencyGraph": {
-        "verdocs-sign": [
-          "verdocs-field-radio-button"
-        ]
-      }
+      "dependencyGraph": {}
     },
     {
       "filePath": "./src/components/elements/verdocs-field-signature/verdocs-field-signature.tsx",
@@ -2047,21 +2040,6 @@
           "optional": true,
           "required": false
         },
-        {
-          "name": "recipient",
-          "type": "IRecipient",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "If set, the signature creation dialog will be initialized from this object.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "IRecipient"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "roleindex",
           "type": "number",
@@ -2220,21 +2198,6 @@
           "optional": true,
           "required": false
         },
-        {
-          "name": "recipient",
-          "type": "IRecipient",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "The recipient completing the form, if known.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "IRecipient"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "roleindex",
           "type": "number",
@@ -2266,44 +2229,7 @@
           "docsTags": []
         }
       ],
-      "events": [
-        {
-          "event": "fieldBlur",
-          "detail": "boolean",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the input field gains focus.",
-          "docsTags": []
-        },
-        {
-          "event": "fieldChange",
-          "detail": "string",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the input field value changes. Note that this will only be fired on blur, tab-out, ENTER key press, etc.\nIt is generally the best event to subscribe to than `input` for most cases EXCEPT autocomplete fields that need to see every\nkeypress.",
-          "docsTags": []
-        },
-        {
-          "event": "fieldFocus",
-          "detail": "boolean",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the input field loses focus.",
-          "docsTags": []
-        },
-        {
-          "event": "fieldInput",
-          "detail": "string",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired on every character entered into / deleted from the field.",
-          "docsTags": []
-        }
-      ],
+      "events": [],
       "listeners": [],
       "styles": [],
       "slots": [],
@@ -2400,21 +2326,6 @@
           "optional": true,
           "required": false
         },
-        {
-          "name": "recipient",
-          "type": "IRecipient",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "The recipient completing the form, if known.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "IRecipient"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "roleindex",
           "type": "number",
@@ -2447,42 +2358,6 @@
         }
       ],
       "events": [
-        {
-          "event": "fieldBlur",
-          "detail": "boolean",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the input field gains focus.",
-          "docsTags": []
-        },
-        {
-          "event": "fieldChange",
-          "detail": "string",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the input field value changes. Note that this will only be fired on blur, tab-out, ENTER key press, etc.\nIt is generally the best event to subscribe to than `input` for most cases EXCEPT autocomplete fields that need to see every\nkeypress.",
-          "docsTags": []
-        },
-        {
-          "event": "fieldFocus",
-          "detail": "boolean",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the input field loses focus.",
-          "docsTags": []
-        },
-        {
-          "event": "fieldInput",
-          "detail": "string",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired on every character entered into / deleted from the field.",
-          "docsTags": []
-        },
         {
           "event": "recipientChanged",
           "detail": "string",
@@ -2589,21 +2464,6 @@
           "optional": true,
           "required": false
         },
-        {
-          "name": "recipient",
-          "type": "IRecipient",
-          "mutable": false,
-          "reflectToAttr": false,
-          "docs": "The recipient completing the form, if known.",
-          "docsTags": [],
-          "values": [
-            {
-              "type": "IRecipient"
-            }
-          ],
-          "optional": true,
-          "required": false
-        },
         {
           "name": "roleindex",
           "type": "number",
@@ -2635,53 +2495,7 @@
           "docsTags": []
         }
       ],
-      "events": [
-        {
-          "event": "fieldBlur",
-          "detail": "boolean",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the input field gains focus.",
-          "docsTags": []
-        },
-        {
-          "event": "fieldChange",
-          "detail": "string",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the input field value changes. Note that this will only be fired on blur, tab-out, ENTER key press, etc.\nIt is generally the best event to subscribe to than `input` for most cases EXCEPT autocomplete fields that need to see every\nkeypress.",
-          "docsTags": []
-        },
-        {
-          "event": "fieldFocus",
-          "detail": "boolean",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired when the input field loses focus.",
-          "docsTags": []
-        },
-        {
-          "event": "fieldInput",
-          "detail": "string",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired on every character entered into / deleted from the field.",
-          "docsTags": []
-        },
-        {
-          "event": "settingsPress",
-          "detail": "any",
-          "bubbles": true,
-          "cancelable": true,
-          "composed": true,
-          "docs": "Event fired on every character entered into / deleted from the field.",
-          "docsTags": []
-        }
-      ],
+      "events": [],
       "listeners": [],
       "styles": [],
       "slots": [],
@@ -3010,6 +2824,7 @@
       "parts": [],
       "dependents": [
         "verdocs-preview",
+        "verdocs-sign",
         "verdocs-template-fields",
         "verdocs-view"
       ],
@@ -3018,6 +2833,9 @@
         "verdocs-preview": [
           "verdocs-loader"
         ],
+        "verdocs-sign": [
+          "verdocs-loader"
+        ],
         "verdocs-template-fields": [
           "verdocs-loader"
         ],
@@ -3112,7 +2930,8 @@
       "slots": [],
       "parts": [],
       "dependents": [
-        "verdocs-auth"
+        "verdocs-auth",
+        "verdocs-sign"
       ],
       "dependencies": [
         "verdocs-button"
@@ -3123,6 +2942,9 @@
         ],
         "verdocs-auth": [
           "verdocs-ok-dialog"
+        ],
+        "verdocs-sign": [
+          "verdocs-ok-dialog"
         ]
       }
     },
@@ -3995,19 +3817,24 @@
       "parts": [],
       "dependents": [],
       "dependencies": [
-        "verdocs-field-checkbox",
-        "verdocs-field-radio-button",
+        "verdocs-loader",
         "verdocs-dropdown",
+        "verdocs-checkbox",
         "verdocs-button",
-        "verdocs-document-page"
+        "verdocs-document-page",
+        "verdocs-ok-dialog"
       ],
       "dependencyGraph": {
         "verdocs-sign": [
-          "verdocs-field-checkbox",
-          "verdocs-field-radio-button",
+          "verdocs-loader",
           "verdocs-dropdown",
+          "verdocs-checkbox",
           "verdocs-button",
-          "verdocs-document-page"
+          "verdocs-document-page",
+          "verdocs-ok-dialog"
+        ],
+        "verdocs-ok-dialog": [
+          "verdocs-button"
         ]
       }
     },