@vonage/vivid-react 3.4.0 → 3.5.0

package/v3/VwcDatePicker/index.js

@@ -14,266 +14,457 @@ Code in this file were generated using following JSON:
   }
  ],
  "members": [
+  {
+   "kind": "field",
+   "name": "type",
+   "type": {
+    "text": "string"
+   },
+   "default": "'date'"
+  },
+  {
+   "kind": "field",
+   "name": "min",
+   "type": {
+    "text": "string"
+   },
+   "description": "The earliest accepted date.",
+   "privacy": "public",
+   "default": "''",
+   "inheritedFrom": {
+    "name": "MinMaxCalendarPicker",
+    "module": "src/shared/picker-field/mixins/min-max-calendar-picker.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "max",
+   "type": {
+    "text": "string"
+   },
+   "description": "The latest accepted date.",
+   "privacy": "public",
+   "default": "''",
+   "inheritedFrom": {
+    "name": "MinMaxCalendarPicker",
+    "module": "src/shared/picker-field/mixins/min-max-calendar-picker.ts"
+   }
+  },
   {
    "kind": "method",
-   "name": "_updatePresentationValue",
-   "privacy": "protected",
-   "return": {
-    "type": {
-     "text": "void"
+   "name": "#isMonthAfterValidRange",
+   "parameters": [
+    {
+     "name": "month",
+     "type": {
+      "text": "Month"
+     }
     }
-   },
+   ],
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "CalendarPicker",
+    "module": "src/shared/picker-field/mixins/calendar-picker.ts"
    }
   },
   {
    "kind": "method",
-   "name": "#updateValueDueToUserInteraction",
+   "name": "#isMonthBeforeValidRange",
    "parameters": [
     {
-     "name": "newValue",
+     "name": "month",
      "type": {
-      "text": "DateStr"
+      "text": "Month"
      }
     }
-   ]
+   ],
+   "inheritedFrom": {
+    "name": "CalendarPicker",
+    "module": "src/shared/picker-field/mixins/calendar-picker.ts"
+   }
   },
   {
    "kind": "field",
-   "name": "type",
+   "name": "value",
    "type": {
     "text": "string"
    },
-   "default": "'date'"
+   "description": "The current value of the element.",
+   "default": "''",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
   },
   {
    "kind": "field",
-   "name": "label",
+   "name": "readOnly",
    "type": {
-    "text": "string"
+    "text": "boolean"
    },
+   "default": "false",
+   "description": "Whether the date-picker is readonly.",
+   "privacy": "public",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
    }
   },
   {
    "kind": "field",
-   "name": "min",
+   "name": "#onFocusIn",
+   "privacy": "private",
+   "inheritedFrom": {
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#onFocusOut",
+   "privacy": "private",
+   "inheritedFrom": {
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#localeChangeHandler",
+   "privacy": "private",
    "type": {
-    "text": "string"
+    "text": "object"
    },
-   "description": "The earliest accepted date of the date-picker.",
-   "privacy": "public",
-   "default": "''",
+   "default": "{\n\t\thandleChange: () => {\n\t\t\tthis._updatePresentationValue();\n\t\t},\n\t}",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
    }
   },
   {
    "kind": "field",
-   "name": "max",
+   "name": "#localeChangeObserver",
+   "privacy": "private",
    "type": {
-    "text": "string"
+    "text": "BindingObserver"
    },
-   "description": "The latest accepted date of the date-picker.",
-   "privacy": "public",
-   "default": "''",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#startObservingLocaleChanges",
+   "inheritedFrom": {
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#stopObservingLocaleChanges",
+   "inheritedFrom": {
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
    }
   },
   {
    "kind": "field",
-   "name": "initialValue",
+   "name": "#dismissOnClickOutside",
+   "privacy": "private",
+   "inheritedFrom": {
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#openPopupIfPossible",
+   "inheritedFrom": {
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "helperText",
    "type": {
-    "text": "string"
+    "text": "string | undefined"
    },
-   "description": "The initial value of the date-picker.",
+   "description": "Provides additional information to help the user enter the correct information.\nTo add HTML to the helper text, use the helper-text slot instead.",
    "privacy": "public",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "WithFeedback",
+    "module": "src/shared/feedback/mixins.ts"
    }
   },
   {
    "kind": "field",
-   "name": "currentValue",
+   "name": "errorText",
    "type": {
-    "text": "string"
+    "text": "string | undefined"
    },
-   "description": "The current value of the date-picker.",
+   "description": "Provides a custom error message. Any current error state will be overridden.",
    "privacy": "public",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
    }
   },
   {
    "kind": "field",
-   "name": "readOnly",
+   "name": "#blockValidateCalls",
+   "privacy": "private",
    "type": {
     "text": "boolean"
    },
    "default": "false",
-   "description": "Whether the date-picker is readonly.",
-   "privacy": "public",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
    }
   },
   {
-   "kind": "method",
-   "name": "_adjustSelectedMonthToEnsureVisibilityOf",
-   "privacy": "protected",
-   "parameters": [
-    {
-     "name": "date",
-     "type": {
-      "text": "DateStr"
-     }
-    }
-   ],
+   "kind": "field",
+   "name": "#originalValidateFn",
+   "privacy": "private",
+   "type": {
+    "text": "() => void"
+   },
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
    }
   },
   {
    "kind": "method",
-   "name": "#isMonthAfterValidRange",
+   "name": "#forceCustomError",
    "parameters": [
     {
-     "name": "month",
+     "name": "errorMessage",
      "type": {
-      "text": "Month"
+      "text": "string"
      }
     }
    ],
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
    }
   },
   {
    "kind": "method",
-   "name": "#isMonthBeforeValidRange",
-   "parameters": [
-    {
-     "name": "month",
-     "type": {
-      "text": "Month"
-     }
-    }
-   ],
+   "name": "#clearCustomErrorAndRevalidate",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
    }
   },
   {
    "kind": "field",
-   "name": "#onFocusIn",
-   "privacy": "private",
+   "name": "validate",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
    }
   },
   {
    "kind": "field",
-   "name": "#onFocusOut",
+   "name": "label",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "The label for the form element.",
+   "inheritedFrom": {
+    "name": "FormElement",
+    "module": "src/shared/patterns/form-elements/form-element.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#handleInvalidEvent",
    "privacy": "private",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "FormElement",
+    "module": "src/shared/patterns/form-elements/form-element.ts"
    }
   },
   {
-   "kind": "method",
-   "name": "_getCustomValidationError",
-   "privacy": "protected",
-   "return": {
-    "type": {
-     "text": "string | null"
-    }
+   "kind": "field",
+   "name": "validity",
+   "type": {
+    "text": "ValidityState"
    },
+   "description": "Returns the validity state of the element",
+   "readonly": true,
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
    }
   },
   {
    "kind": "field",
-   "name": "#localeChangeHandler",
-   "privacy": "private",
+   "name": "form",
    "type": {
-    "text": "object"
+    "text": "HTMLFormElement | null"
    },
-   "default": "{\n\t\thandleChange: () => {\n\t\t\tthis._updatePresentationValue();\n\t\t},\n\t}",
+   "description": "Retrieve a reference to the associated form.\nReturns null if not associated to any form.",
+   "readonly": true,
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
    }
   },
   {
    "kind": "field",
-   "name": "#localeChangeObserver",
-   "privacy": "private",
+   "name": "validationMessage",
    "type": {
-    "text": "BindingObserver"
+    "text": "string"
    },
+   "description": "Retrieve the localized validation message,\nor custom validation message if set.",
+   "readonly": true,
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
    }
   },
   {
    "kind": "field",
-   "name": "#dismissOnClickOutside",
-   "privacy": "private",
+   "name": "willValidate",
+   "type": {
+    "text": "boolean"
+   },
+   "description": "Whether the element will be validated when the\nform is submitted",
+   "readonly": true,
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "labels",
+   "type": {
+    "text": "ReadonlyArray<Node>"
+   },
+   "description": "A reference to all associated label elements",
+   "readonly": true,
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "currentValue",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "initialValue",
+   "type": {
+    "text": "string"
+   },
+   "description": "The default value of the element. This value sets the `value` property\nonly when the `value` property has not been explicitly set.",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "disabled",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "name",
+   "type": {
+    "text": "string"
+   },
+   "description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "required",
+   "type": {
+    "text": "boolean"
+   },
+   "description": "Require the field to be completed prior to form submission.",
+   "default": "false",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
    }
   },
   {
    "kind": "method",
-   "name": "#openPopupIfPossible",
+   "name": "checkValidity",
+   "return": {
+    "type": {
+     "text": "boolean"
+    }
+   },
+   "description": "Return the current validity of the element.",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
    }
   },
   {
    "kind": "method",
-   "name": "_getSelectedDates",
-   "privacy": "protected",
+   "name": "reportValidity",
    "return": {
     "type": {
-     "text": "DateStr[]"
+     "text": "boolean"
     }
    },
+   "description": "Return the current validity of the element.\nIf false, fires an invalid event at the element.",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
    }
   },
   {
    "kind": "field",
-   "name": "value",
+   "name": "VIVID_VERSION",
+   "static": true,
+   "default": "__PACKAGE_VERSION__",
+   "description": "The current version of the Vivid library, which is useful for debugging.\nIt can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.",
    "type": {
     "text": "string"
    },
-   "default": "''",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "VividElement",
+    "module": "src/shared/foundation/vivid-element/vivid-element.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "componentName",
+   "type": {
+    "text": "string"
+   },
+   "static": true,
+   "description": "Core component name, without prefix",
+   "inheritedFrom": {
+    "name": "VividElement",
+    "module": "src/shared/foundation/vivid-element/vivid-element.ts"
    }
   }
  ],
@@ -291,22 +482,29 @@ Code in this file were generated using following JSON:
    },
    "description": "Emitted when the date is changed by the user.",
    "name": "change"
+  }
+ ],
+ "mixins": [
+  {
+   "name": "SingleDatePickerMixin",
+   "module": "/src/shared/picker-field/mixins/single-date-picker"
   },
   {
-   "type": {
-    "text": "CustomEvent<undefined>"
-   },
-   "description": "Event emitted when the clear button is clicked.",
-   "name": "clear-click",
-   "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
-   }
+   "name": "SingleValuePicker",
+   "module": "/src/shared/picker-field/mixins/single-value-picker"
+  },
+  {
+   "name": "MinMaxCalendarPicker",
+   "module": "/src/shared/picker-field/mixins/min-max-calendar-picker"
+  },
+  {
+   "name": "CalendarPicker",
+   "module": "/src/shared/picker-field/mixins/calendar-picker"
   }
  ],
  "superclass": {
-  "name": "DatePickerBase",
-  "module": "/libs/components/src/shared/date-picker/date-picker-base"
+  "name": "PickerField",
+  "module": "/src/shared/picker-field/picker-field"
  },
  "vividComponent": {
   "public": true,
@@ -314,25 +512,100 @@ Code in this file were generated using following JSON:
   "vueModels": [
    {
     "name": "modelValue",
-    "attributeName": "value",
+    "propName": "value",
     "eventNames": [
      "input"
     ],
-    "valueMapping": "(event.target as HTMLInputElement).value"
+    "valueMapping": "event.currentTarget.value"
    }
   ]
  },
  "attributes": [
   {
+   "name": "min",
    "type": {
     "text": "string"
    },
-   "description": "The earliest accepted date of the date-picker.",
+   "description": "The earliest accepted date.",
    "default": "''",
    "fieldName": "min",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "MinMaxCalendarPicker",
+    "module": "src/shared/picker-field/mixins/min-max-calendar-picker.ts"
+   }
+  },
+  {
+   "name": "max",
+   "type": {
+    "text": "string"
+   },
+   "description": "The latest accepted date.",
+   "default": "''",
+   "fieldName": "max",
+   "inheritedFrom": {
+    "name": "MinMaxCalendarPicker",
+    "module": "src/shared/picker-field/mixins/min-max-calendar-picker.ts"
+   }
+  },
+  {
+   "name": "readonly",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Whether the date-picker is readonly.",
+   "fieldName": "readOnly",
+   "inheritedFrom": {
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
+   }
+  },
+  {
+   "name": "helper-text",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Provides additional information to help the user enter the correct information.\nTo add HTML to the helper text, use the helper-text slot instead.",
+   "fieldName": "helperText",
+   "inheritedFrom": {
+    "name": "WithFeedback",
+    "module": "src/shared/feedback/mixins.ts"
+   }
+  },
+  {
+   "name": "error-text",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Provides a custom error message. Any current error state will be overridden.",
+   "fieldName": "errorText",
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "name": "label",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "The label for the form element.",
+   "fieldName": "label",
+   "inheritedFrom": {
+    "name": "FormElement",
+    "module": "src/shared/patterns/form-elements/form-element.ts"
+   }
+  },
+  {
+   "name": "current-value",
+   "type": {
+    "text": "string"
+   },
+   "description": "The current value of the element.",
+   "fieldName": "value",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
    }
   },
   {
@@ -340,36 +613,49 @@ Code in this file were generated using following JSON:
    "type": {
     "text": "string"
    },
-   "description": "The initial value of the date-picker.",
+   "description": "The default value of the element. This value sets the `value` property\nonly when the `value` property has not been explicitly set.",
    "fieldName": "initialValue",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
    }
   },
   {
-   "name": "current-value",
+   "name": "disabled",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
+   "fieldName": "disabled",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "name": "name",
    "type": {
     "text": "string"
    },
-   "description": "The current value of the date-picker.",
-   "fieldName": "currentValue",
+   "description": "The name of the element. This element's value will be surfaced during form submission under the provided name.",
+   "fieldName": "name",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
    }
   },
   {
-   "name": "readonly",
+   "name": "required",
    "type": {
     "text": "boolean"
    },
+   "description": "Require the field to be completed prior to form submission.",
    "default": "false",
-   "description": "Whether the date-picker is readonly.",
-   "fieldName": "readOnly",
+   "fieldName": "required",
    "inheritedFrom": {
-    "name": "DatePickerBase",
-    "module": "libs/components/src/shared/date-picker/date-picker-base.ts"
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
    }
   }
  ]
@@ -381,9 +667,9 @@ import { registerDatePicker } from '@vonage/vivid'
 registerDatePicker('vvd3')
 
 const VwcDatePicker = wrapper(`vvd3-date-picker`,  {
-    events: [{"name":"input","propName":"onInput"},{"name":"change","propName":"onChange"},{"name":"clear-click","propName":"onClearClick"}],
+    events: [{"name":"input","propName":"onInput"},{"name":"change","propName":"onChange"}],
     attributes: [],
-    properties: ['type', 'label', 'min', 'max', 'initialValue', 'currentValue', 'readOnly', 'value', 'errorText']
+    properties: ['type', 'min', 'max', 'value', 'readOnly', 'helperText', 'errorText', 'validate', 'label', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName', 'errorText']
 })
 
 VwcDatePicker.displayName = 'VwcDatePicker'