@vonage/vivid 3.52.0 → 3.53.0

package/custom-elements.json

@@ -3913,6 +3913,12 @@
               "default": "var(--vvd-color-canvas-text)"
             }
           ],
+          "slots": [
+            {
+              "description": "Describes how to use the checkbox. Alternative to the `helper-text` attribute.",
+              "name": "helper-text"
+            }
+          ],
           "members": [
             {
               "kind": "field",
@@ -4883,6 +4889,12 @@
           "kind": "class",
           "description": "Single date picker component.",
           "name": "DatePicker",
+          "slots": [
+            {
+              "description": "Describes how to use the date-picker. Alternative to the `helper-text` attribute.",
+              "name": "helper-text"
+            }
+          ],
           "members": [
             {
               "kind": "method",
@@ -5245,6 +5257,12 @@
           "kind": "class",
           "description": "",
           "name": "DateRangePicker",
+          "slots": [
+            {
+              "description": "Describes how to use the date-range-picker. Alternative to the `helper-text` attribute.",
+              "name": "helper-text"
+            }
+          ],
           "members": [
             {
               "kind": "field",
@@ -5721,6 +5739,300 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/dial-pad/definition.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "dialPadDefinition"
+        },
+        {
+          "kind": "variable",
+          "name": "registerDialPad",
+          "description": "Registers the dial-pad element with the design system.",
+          "parameters": [
+            {
+              "description": "the prefix to use for the component name",
+              "name": "prefix"
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "dialPadDefinition",
+          "declaration": {
+            "name": "dialPadDefinition",
+            "module": "libs/components/src/lib/dial-pad/definition.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "registerDialPad",
+          "declaration": {
+            "name": "registerDialPad",
+            "module": "libs/components/src/lib/dial-pad/definition.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/dial-pad/dial-pad.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Base class for dial-pad",
+          "name": "DialPad",
+          "cssProperties": [
+            {
+              "name": "--vvd-dial-pad-accent-contrast",
+              "default": "var(--vvd-color-neutral-800)"
+            },
+            {
+              "name": "--vvd-dial-pad-accent-soft",
+              "default": "var(--vvd-color-neutral-100)"
+            },
+            {
+              "name": "--vvd-dial-pad-accent-pale",
+              "default": "var(--vvd-color-neutral-300)"
+            },
+            {
+              "name": "--vvd-dial-pad-accent-fierce",
+              "default": "var(--vvd-color-neutral-700)"
+            },
+            {
+              "name": "--vvd-dial-pad-accent-firm-all",
+              "default": "var(--vvd-color-neutral-600)"
+            },
+            {
+              "name": "--vvd-dial-pad-accent-faint",
+              "default": "var(--vvd-color-neutral-50)"
+            },
+            {
+              "name": "--vvd-dial-pad-accent-dim",
+              "default": "var(--vvd-color-neutral-200)"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "helperText",
+              "type": {
+                "text": "string | null"
+              },
+              "default": "null",
+              "description": "Indicates the helper-text's text.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "placeholder",
+              "type": {
+                "text": "string | null"
+              },
+              "default": "null",
+              "description": "Indicates the placeholder's text.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "value",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "Indicates the value's text.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "valueChanged",
+              "parameters": [
+                {
+                  "name": "_oldValue",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "newValue",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "pattern",
+              "type": {
+                "text": "string"
+              },
+              "default": "'^[0-9#*]*$'",
+              "description": "Indicates the dial pad's pattern.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates the disabled state of the dial-pad.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "callActive",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates the active state of the dial-pad.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "noCall",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates the no-call state of the dial-pad.",
+              "privacy": "public"
+            }
+          ],
+          "events": [
+            {
+              "description": "Emitted when the text field value changes",
+              "name": "change"
+            },
+            {
+              "description": "Emitted when the text field value changes",
+              "name": "input"
+            },
+            {
+              "description": "Emitted when the text field loses focus",
+              "name": "blur"
+            },
+            {
+              "description": "Emitted when the text field receives focus",
+              "name": "focus"
+            },
+            {
+              "description": "Emitted when a digit button is clicked",
+              "name": "keypad-click"
+            },
+            {
+              "description": "Emitted when the call button is clicked",
+              "name": "dial"
+            },
+            {
+              "description": "Emitted when the end call button is clicked",
+              "name": "end-call"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "helper-text",
+              "type": {
+                "text": "string | null"
+              },
+              "default": "null",
+              "description": "Indicates the helper-text's text.",
+              "fieldName": "helperText"
+            },
+            {
+              "name": "placeholder",
+              "type": {
+                "text": "string | null"
+              },
+              "default": "null",
+              "description": "Indicates the placeholder's text.",
+              "fieldName": "placeholder"
+            },
+            {
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "description": "Indicates the value's text.",
+              "fieldName": "value"
+            },
+            {
+              "type": {
+                "text": "string"
+              },
+              "default": "'^[0-9#*]*$'",
+              "description": "Indicates the dial pad's pattern.",
+              "fieldName": "pattern"
+            },
+            {
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates the disabled state of the dial-pad.",
+              "fieldName": "disabled"
+            },
+            {
+              "name": "call-active",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates the active state of the dial-pad.",
+              "fieldName": "callActive"
+            },
+            {
+              "name": "no-call",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Indicates the no-call state of the dial-pad.",
+              "fieldName": "noCall"
+            }
+          ],
+          "superclass": {
+            "name": "FoundationElement",
+            "package": "@microsoft/fast-foundation"
+          },
+          "vividComponent": {
+            "public": true,
+            "name": "dial-pad",
+            "vueModels": [
+              {
+                "name": "modelValue",
+                "attributeName": "value",
+                "eventName": "input",
+                "valueMapping": "(event.target as any).value"
+              }
+            ]
+          }
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "DialPad",
+          "declaration": {
+            "name": "DialPad",
+            "module": "libs/components/src/lib/dial-pad/dial-pad.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/dial-pad/locale.ts",
+      "declarations": [],
+      "exports": []
+    },
     {
       "kind": "javascript-module",
       "path": "libs/components/src/lib/dialog/definition.ts",
@@ -6595,6 +6907,12 @@
           "kind": "class",
           "description": "",
           "name": "FilePicker",
+          "slots": [
+            {
+              "description": "Describes how to use the file-picker. Alternative to the `helper-text` attribute.",
+              "name": "helper-text"
+            }
+          ],
           "members": [
             {
               "kind": "field",
@@ -8549,6 +8867,32 @@
                 "name": "TextAnchor",
                 "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
               }
+            },
+            {
+              "kind": "field",
+              "name": "connotation",
+              "type": {
+                "text": "TextAnchorConnotation | undefined"
+              },
+              "description": "The connotation Text-Anchor should have.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TextAnchor",
+                "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "appearance",
+              "type": {
+                "text": "TextAnchorAppearance | undefined"
+              },
+              "description": "The appearance Text-Anchor should have.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TextAnchor",
+                "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
+              }
             }
           ],
           "superclass": {
@@ -8561,12 +8905,36 @@
           },
           "attributes": [
             {
-              "name": "text",
+              "name": "text",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Indicates the text anchor's text.",
+              "fieldName": "text",
+              "inheritedFrom": {
+                "name": "TextAnchor",
+                "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
+              }
+            },
+            {
+              "name": "connotation",
+              "type": {
+                "text": "TextAnchorConnotation | undefined"
+              },
+              "description": "The connotation Text-Anchor should have.",
+              "fieldName": "connotation",
+              "inheritedFrom": {
+                "name": "TextAnchor",
+                "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
+              }
+            },
+            {
+              "name": "appearance",
               "type": {
-                "text": "string | undefined"
+                "text": "TextAnchorAppearance | undefined"
               },
-              "description": "Indicates the text anchor's text.",
-              "fieldName": "text",
+              "description": "The appearance Text-Anchor should have.",
+              "fieldName": "appearance",
               "inheritedFrom": {
                 "name": "TextAnchor",
                 "module": "libs/components/src/lib/text-anchor/text-anchor.ts"
@@ -8890,6 +9258,12 @@
               "default": "var(--vvd-color-neutral-100)"
             }
           ],
+          "slots": [
+            {
+              "description": "Describes how to use the number-field. Alternative to the `helper-text` attribute.",
+              "name": "helper-text"
+            }
+          ],
           "members": [
             {
               "kind": "field",
@@ -10776,6 +11150,10 @@
             {
               "description": "Slot to add meta content to the select control.",
               "name": "meta"
+            },
+            {
+              "description": "Describes how to use the select. Alternative to the `helper-text` attribute.",
+              "name": "helper-text"
             }
           ],
           "members": [
@@ -13193,6 +13571,22 @@
         }
       ],
       "exports": [
+        {
+          "kind": "js",
+          "name": "TextAnchorConnotation",
+          "declaration": {
+            "name": "TextAnchorConnotation",
+            "module": "./text-anchor"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "TextAnchorAppearance",
+          "declaration": {
+            "name": "TextAnchorAppearance",
+            "module": "./text-anchor"
+          }
+        },
         {
           "kind": "js",
           "name": "textAnchorDefinition",
@@ -13234,6 +13628,24 @@
               },
               "description": "Indicates the text anchor's text.",
               "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "connotation",
+              "type": {
+                "text": "TextAnchorConnotation | undefined"
+              },
+              "description": "The connotation Text-Anchor should have.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "appearance",
+              "type": {
+                "text": "TextAnchorAppearance | undefined"
+              },
+              "description": "The appearance Text-Anchor should have.",
+              "privacy": "public"
             }
           ],
           "attributes": [
@@ -13244,6 +13656,22 @@
               },
               "description": "Indicates the text anchor's text.",
               "fieldName": "text"
+            },
+            {
+              "name": "connotation",
+              "type": {
+                "text": "TextAnchorConnotation | undefined"
+              },
+              "description": "The connotation Text-Anchor should have.",
+              "fieldName": "connotation"
+            },
+            {
+              "name": "appearance",
+              "type": {
+                "text": "TextAnchorAppearance | undefined"
+              },
+              "description": "The appearance Text-Anchor should have.",
+              "fieldName": "appearance"
             }
           ],
           "superclass": {
@@ -13420,6 +13848,12 @@
               "default": "var(--vvd-color-neutral-100)"
             }
           ],
+          "slots": [
+            {
+              "description": "Describes how to use the text-area. Alternative to the `helper-text` attribute.",
+              "name": "helper-text"
+            }
+          ],
           "members": [
             {
               "kind": "field",
@@ -13584,6 +14018,10 @@
             {
               "description": "Used to add action items to the end of the text-field.",
               "name": "action-items"
+            },
+            {
+              "description": "Describes how to use the text-field. Alternative to the `helper-text` attribute.",
+              "name": "helper-text"
             }
           ],
           "members": [
@@ -13808,6 +14246,12 @@
               "default": "var(--vvd-color-neutral-300)"
             }
           ],
+          "slots": [
+            {
+              "description": "Describes how to use the time-picker. Alternative to the `helper-text` attribute.",
+              "name": "helper-text"
+            }
+          ],
           "members": [
             {
               "kind": "field",
@@ -14656,6 +15100,275 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/video-player/definition.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "videoPlayerDefinition"
+        },
+        {
+          "kind": "variable",
+          "name": "registerVideoPlayer",
+          "description": "Registers the video-player element with the design system.",
+          "parameters": [
+            {
+              "description": "the prefix to use for the component name",
+              "name": "prefix"
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "videoPlayerDefinition",
+          "declaration": {
+            "name": "videoPlayerDefinition",
+            "module": "libs/components/src/lib/video-player/definition.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "registerVideoPlayer",
+          "declaration": {
+            "name": "registerVideoPlayer",
+            "module": "libs/components/src/lib/video-player/definition.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/video-player/locale.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/video-player/video-player.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "DEFAULT_PLAYBACK_RATES",
+          "type": {
+            "text": "string"
+          },
+          "default": "'0.5, 1, 1.5, 2'"
+        },
+        {
+          "kind": "class",
+          "description": "Base class for video-player",
+          "name": "VideoPlayer",
+          "slots": [
+            {
+              "description": "Default slot",
+              "name": ""
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "poster",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Reference to an image which is displayed before the video is played",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "src",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "URL of a video file",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "autoplay",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Allows the video will play automatically (muted)",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "loop",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Allows the video to loop back to the beginning when finished",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "playbackRates",
+              "type": {
+                "text": "string"
+              },
+              "default": "'0.5, 1, 1.5, 2'",
+              "description": "Sets the available playback rates. When an empty string, no choices will be available",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "skipBy",
+              "type": {
+                "text": "MediaSkipBy"
+              },
+              "description": "Allows the video to loop back to the beginning when finished",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "#noSourceErrorElement",
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "#disposePlayer"
+            },
+            {
+              "kind": "method",
+              "name": "#setupVideoElement"
+            },
+            {
+              "kind": "field",
+              "name": "#controlElement",
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "#hideNoSourceError",
+              "parameters": [
+                {
+                  "name": "show",
+                  "default": "true"
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "#setupVideoPlayer",
+              "parameters": [
+                {
+                  "name": "settings",
+                  "type": {
+                    "text": "any"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "#setupPlayerEvents"
+            }
+          ],
+          "events": [
+            {
+              "description": "Fired when the video is played",
+              "name": "play"
+            },
+            {
+              "description": "Fired when the video is paused",
+              "name": "pause"
+            },
+            {
+              "description": "Fired when the video is ended",
+              "name": "ended"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "poster",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Reference to an image which is displayed before the video is played",
+              "fieldName": "poster"
+            },
+            {
+              "name": "src",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "URL of a video file",
+              "fieldName": "src"
+            },
+            {
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Allows the video will play automatically (muted)",
+              "fieldName": "autoplay"
+            },
+            {
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Allows the video to loop back to the beginning when finished",
+              "fieldName": "loop"
+            },
+            {
+              "name": "playback-rates",
+              "type": {
+                "text": "string"
+              },
+              "default": "DEFAULT_PLAYBACK_RATES",
+              "description": "Sets the available playback rates. When an empty string, no choices will be available",
+              "resolveInitializer": {
+                "module": "libs/components/src/lib/video-player/video-player.ts"
+              },
+              "fieldName": "playbackRates"
+            },
+            {
+              "name": "skip-by",
+              "type": {
+                "text": "MediaSkipBy"
+              },
+              "description": "Allows the video to loop back to the beginning when finished",
+              "fieldName": "skipBy"
+            }
+          ],
+          "superclass": {
+            "name": "FoundationElement",
+            "package": "@microsoft/fast-foundation"
+          },
+          "vividComponent": {
+            "public": true,
+            "name": "video-player"
+          }
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "DEFAULT_PLAYBACK_RATES",
+          "declaration": {
+            "name": "DEFAULT_PLAYBACK_RATES",
+            "module": "libs/components/src/lib/video-player/video-player.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "VideoPlayer",
+          "declaration": {
+            "name": "VideoPlayer",
+            "module": "libs/components/src/lib/video-player/video-player.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "libs/components/src/lib/range-slider/utils/lerp.ts",