@vonage/vivid 3.31.0 → 3.32.0

package/custom-elements.json

@@ -1796,6 +1796,14 @@
             }
           ],
           "members": [
+            {
+              "kind": "field",
+              "name": "title",
+              "type": {
+                "text": "string"
+              },
+              "default": "''"
+            },
             {
               "kind": "field",
               "name": "connotation",
@@ -1863,6 +1871,13 @@
             }
           ],
           "attributes": [
+            {
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "fieldName": "title"
+            },
             {
               "name": "connotation",
               "type": {
@@ -3577,6 +3592,248 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/date-picker/date-picker.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Base class for date-picker",
+          "name": "DatePicker",
+          "cssProperties": [
+            {
+              "name": "--vvd-date-picker-accent-primary",
+              "default": "var(--vvd-color-canvas-text)"
+            },
+            {
+              "name": "--vvd-date-picker-accent-faint",
+              "default": "var(--vvd-color-neutral-50)"
+            },
+            {
+              "name": "--vvd-date-picker-accent-soft",
+              "default": "var(--vvd-color-neutral-100)"
+            },
+            {
+              "name": "--vvd-date-picker-accent-dim",
+              "default": "var(--vvd-color-neutral-200)"
+            },
+            {
+              "name": "--vvd-date-picker-accent-pale",
+              "default": "var(--vvd-color-neutral-300)"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "label",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The label text of the date-picker.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "helperText",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The helper-text text of the date-picker.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "errorText",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The error-text text of the date-picker.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "value",
+              "type": {
+                "text": "DateStr | null"
+              },
+              "default": "null",
+              "description": "The currently selected date of the date-picker.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "#updateValueDueToUserInteraction",
+              "parameters": [
+                {
+                  "name": "newValue",
+                  "type": {
+                    "text": "DateStr | null"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "field",
+              "name": "disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether the date-picker is disabled.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "readOnly",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether the date-picker is readonly.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "#dismissOnClickOutside",
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "#isClosingPopup",
+              "privacy": "private",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false"
+            },
+            {
+              "kind": "method",
+              "name": "#openPopupIfPossible"
+            },
+            {
+              "kind": "method",
+              "name": "#closePopup",
+              "parameters": [
+                {
+                  "name": "restoreFocusToTextField",
+                  "default": "true"
+                }
+              ]
+            }
+          ],
+          "attributes": [
+            {
+              "name": "label",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The label text of the date-picker.",
+              "fieldName": "label"
+            },
+            {
+              "name": "helper-text",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The helper-text text of the date-picker.",
+              "fieldName": "helperText"
+            },
+            {
+              "name": "error-text",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The error-text text of the date-picker.",
+              "fieldName": "errorText"
+            },
+            {
+              "type": {
+                "text": "DateStr | null"
+              },
+              "default": "null",
+              "description": "The currently selected date of the date-picker.",
+              "fieldName": "value"
+            },
+            {
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether the date-picker is disabled.",
+              "fieldName": "disabled"
+            },
+            {
+              "name": "readonly",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether the date-picker is readonly.",
+              "fieldName": "readOnly"
+            }
+          ],
+          "superclass": {
+            "name": "FoundationElement",
+            "package": "@microsoft/fast-foundation"
+          }
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "DatePicker",
+          "declaration": {
+            "name": "DatePicker",
+            "module": "libs/components/src/lib/date-picker/date-picker.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/date-picker/definition.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "datePickerDefinition"
+        },
+        {
+          "kind": "variable",
+          "name": "registerDatePicker",
+          "description": "Registers the date-picker element with the design system.",
+          "parameters": [
+            {
+              "description": "the prefix to use for the component name",
+              "name": "prefix"
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "datePickerDefinition",
+          "declaration": {
+            "name": "datePickerDefinition",
+            "module": "libs/components/src/lib/date-picker/definition.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "registerDatePicker",
+          "declaration": {
+            "name": "registerDatePicker",
+            "module": "libs/components/src/lib/date-picker/definition.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/date-picker/locale.ts",
+      "declarations": [],
+      "exports": []
+    },
     {
       "kind": "javascript-module",
       "path": "libs/components/src/lib/dialog/definition.ts",
@@ -7985,31 +8242,35 @@
           "members": [
             {
               "kind": "field",
-              "name": "appearance",
+              "name": "_popup",
               "type": {
-                "text": "SelectAppearance | undefined"
+                "text": "Popup"
               }
             },
             {
               "kind": "field",
-              "name": "shape",
+              "name": "_anchor",
               "type": {
-                "text": "SelectShape | undefined"
+                "text": "HTMLElement"
               }
             },
             {
               "kind": "field",
-              "name": "_popup",
+              "name": "appearance",
               "type": {
-                "text": "Popup"
-              }
+                "text": "SelectAppearance | undefined"
+              },
+              "description": "The appearance attribute.",
+              "privacy": "public"
             },
             {
               "kind": "field",
-              "name": "_anchor",
+              "name": "shape",
               "type": {
-                "text": "HTMLElement"
-              }
+                "text": "SelectShape | undefined"
+              },
+              "description": "The shape attribute.",
+              "privacy": "public"
             },
             {
               "kind": "field",
@@ -8017,7 +8278,18 @@
               "type": {
                 "text": "boolean"
               },
-              "default": "false"
+              "default": "false",
+              "description": "The fixed-dropdown attribute.",
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "placeholder",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The placeholder attribute.",
+              "privacy": "public"
             },
             {
               "kind": "field",
@@ -8026,6 +8298,15 @@
                 "text": "string"
               },
               "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "setDefaultSelectedOption",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
             }
           ],
           "attributes": [
@@ -8034,6 +8315,7 @@
               "type": {
                 "text": "SelectAppearance | undefined"
               },
+              "description": "The appearance attribute.",
               "fieldName": "appearance"
             },
             {
@@ -8041,6 +8323,7 @@
               "type": {
                 "text": "SelectShape | undefined"
               },
+              "description": "The shape attribute.",
               "fieldName": "shape"
             },
             {
@@ -8049,7 +8332,16 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "The fixed-dropdown attribute.",
               "fieldName": "fixedDropdown"
+            },
+            {
+              "name": "placeholder",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "The placeholder attribute.",
+              "fieldName": "placeholder"
             }
           ],
           "superclass": {
@@ -10935,6 +11227,451 @@
           }
         }
       ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/date-picker/calendar/calendarGrid.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "buildCalendarGrid",
+          "return": {
+            "type": {
+              "text": "CalendarGrid"
+            }
+          },
+          "parameters": [
+            {
+              "name": "month",
+              "type": {
+                "text": "Month"
+              }
+            },
+            {
+              "name": "locale",
+              "type": {
+                "text": "DatePickerLocale"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "buildCalendarGrid",
+          "declaration": {
+            "name": "buildCalendarGrid",
+            "module": "libs/components/src/lib/date-picker/calendar/calendarGrid.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/date-picker/calendar/dateStr.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "formatDateStr",
+          "return": {
+            "type": {
+              "text": "DateStr"
+            }
+          },
+          "parameters": [
+            {
+              "name": "date",
+              "type": {
+                "text": "Date"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "currentDateStr",
+          "return": {
+            "type": {
+              "text": "DateStr"
+            }
+          },
+          "parameters": [
+            {
+              "name": "now",
+              "default": "new Date()"
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "parseDateStr",
+          "return": {
+            "type": {
+              "text": "Date"
+            }
+          },
+          "parameters": [
+            {
+              "name": "dateStr",
+              "type": {
+                "text": "DateStr"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "addDays",
+          "return": {
+            "type": {
+              "text": "DateStr"
+            }
+          },
+          "parameters": [
+            {
+              "name": "dateStr",
+              "type": {
+                "text": "DateStr"
+              }
+            },
+            {
+              "name": "days",
+              "type": {
+                "text": "number"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "isValidDateStr",
+          "return": {
+            "type": {
+              "text": "boolean"
+            }
+          },
+          "parameters": [
+            {
+              "name": "string",
+              "type": {
+                "text": "string"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "formatDateStr",
+          "declaration": {
+            "name": "formatDateStr",
+            "module": "libs/components/src/lib/date-picker/calendar/dateStr.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "currentDateStr",
+          "declaration": {
+            "name": "currentDateStr",
+            "module": "libs/components/src/lib/date-picker/calendar/dateStr.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "parseDateStr",
+          "declaration": {
+            "name": "parseDateStr",
+            "module": "libs/components/src/lib/date-picker/calendar/dateStr.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "addDays",
+          "declaration": {
+            "name": "addDays",
+            "module": "libs/components/src/lib/date-picker/calendar/dateStr.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "isValidDateStr",
+          "declaration": {
+            "name": "isValidDateStr",
+            "module": "libs/components/src/lib/date-picker/calendar/dateStr.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/date-picker/calendar/month.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "getCurrentMonth",
+          "return": {
+            "type": {
+              "text": "Month"
+            }
+          },
+          "parameters": [
+            {
+              "name": "now",
+              "default": "new Date()"
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "monthOfDate",
+          "return": {
+            "type": {
+              "text": "Month"
+            }
+          },
+          "parameters": [
+            {
+              "name": "dateStr",
+              "type": {
+                "text": "DateStr"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "addMonths",
+          "return": {
+            "type": {
+              "text": "Month"
+            }
+          },
+          "parameters": [
+            {
+              "name": "{ month, year }",
+              "type": {
+                "text": "Month"
+              }
+            },
+            {
+              "name": "months",
+              "type": {
+                "text": "number"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "areMonthsEqual",
+          "return": {
+            "type": {
+              "text": "boolean"
+            }
+          },
+          "parameters": [
+            {
+              "name": "a",
+              "type": {
+                "text": "Month"
+              }
+            },
+            {
+              "name": "b",
+              "type": {
+                "text": "Month"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "monthToStr",
+          "return": {
+            "type": {
+              "text": "string"
+            }
+          },
+          "parameters": [
+            {
+              "name": "{ month, year }",
+              "type": {
+                "text": "Month"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "getCurrentMonth",
+          "declaration": {
+            "name": "getCurrentMonth",
+            "module": "libs/components/src/lib/date-picker/calendar/month.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "monthOfDate",
+          "declaration": {
+            "name": "monthOfDate",
+            "module": "libs/components/src/lib/date-picker/calendar/month.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "addMonths",
+          "declaration": {
+            "name": "addMonths",
+            "module": "libs/components/src/lib/date-picker/calendar/month.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "areMonthsEqual",
+          "declaration": {
+            "name": "areMonthsEqual",
+            "module": "libs/components/src/lib/date-picker/calendar/month.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "monthToStr",
+          "declaration": {
+            "name": "monthToStr",
+            "module": "libs/components/src/lib/date-picker/calendar/month.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/date-picker/calendar/monthPickerGrid.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "MonthsPerRow",
+          "type": {
+            "text": "number"
+          },
+          "default": "4"
+        },
+        {
+          "kind": "function",
+          "name": "buildMonthPickerGrid",
+          "return": {
+            "type": {
+              "text": "MonthPickerGrid"
+            }
+          },
+          "parameters": [
+            {
+              "name": "year",
+              "type": {
+                "text": "number"
+              }
+            },
+            {
+              "name": "locale",
+              "type": {
+                "text": "DatePickerLocale"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "MonthsPerRow",
+          "declaration": {
+            "name": "MonthsPerRow",
+            "module": "libs/components/src/lib/date-picker/calendar/monthPickerGrid.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "buildMonthPickerGrid",
+          "declaration": {
+            "name": "buildMonthPickerGrid",
+            "module": "libs/components/src/lib/date-picker/calendar/monthPickerGrid.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "libs/components/src/lib/date-picker/calendar/presentationDate.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "formatPresentationDate",
+          "return": {
+            "type": {
+              "text": "string"
+            }
+          },
+          "parameters": [
+            {
+              "name": "dateStr",
+              "type": {
+                "text": "DateStr"
+              }
+            },
+            {
+              "name": "locale",
+              "type": {
+                "text": "DatePickerLocale"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "parsePresentationDate",
+          "return": {
+            "type": {
+              "text": "DateStr"
+            }
+          },
+          "parameters": [
+            {
+              "name": "presentationDate",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "locale",
+              "type": {
+                "text": "DatePickerLocale"
+              }
+            }
+          ],
+          "description": "Parse a presentation date, which is the locale specific format (e.g. DD/MM/YYYY for en-GB).\nAccepts partial dates, e.g. 1/1/2021 will be parsed as 01/01/2021.\nWill throw if the date is can't be parsed"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "formatPresentationDate",
+          "declaration": {
+            "name": "formatPresentationDate",
+            "module": "libs/components/src/lib/date-picker/calendar/presentationDate.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "parsePresentationDate",
+          "declaration": {
+            "name": "parsePresentationDate",
+            "module": "libs/components/src/lib/date-picker/calendar/presentationDate.ts"
+          }
+        }
+      ]
     }
   ]
 }