@vonage/vivid-react 3.4.1 → 3.5.0

package/v3/VwcDateTimePicker/index.js

@@ -0,0 +1,885 @@
+/*
+* DO NOT EDIT THIS FILE. IT IS GENERATED
+*/
+/*
+Code in this file were generated using following JSON:
+{
+ "kind": "class",
+ "description": "Single date picker component.",
+ "name": "DateTimePicker",
+ "slots": [
+  {
+   "description": "Describes how to use the date-picker. Alternative to the `helper-text` attribute.",
+   "name": "helper-text"
+  }
+ ],
+ "members": [
+  {
+   "kind": "field",
+   "name": "min",
+   "type": {
+    "text": "string"
+   },
+   "description": "The earliest accepted date-time.",
+   "privacy": "public",
+   "default": "''"
+  },
+  {
+   "kind": "field",
+   "name": "minTime",
+   "type": {
+    "text": "string"
+   },
+   "description": "The earliest accepted time part of the date-time.",
+   "privacy": "public",
+   "default": "''"
+  },
+  {
+   "kind": "field",
+   "name": "minDate",
+   "type": {
+    "text": "string"
+   },
+   "description": "The earliest accepted date part of the date-time.",
+   "privacy": "public",
+   "default": "''"
+  },
+  {
+   "kind": "field",
+   "name": "max",
+   "type": {
+    "text": "string"
+   },
+   "description": "The latest accepted date-time.",
+   "privacy": "public",
+   "default": "''"
+  },
+  {
+   "kind": "field",
+   "name": "maxTime",
+   "type": {
+    "text": "string"
+   },
+   "description": "The latest accepted time part of the date-time.",
+   "privacy": "public",
+   "default": "''"
+  },
+  {
+   "kind": "field",
+   "name": "maxDate",
+   "type": {
+    "text": "string"
+   },
+   "description": "The latest accepted time date of the date-time.",
+   "privacy": "public",
+   "default": "''"
+  },
+  {
+   "kind": "field",
+   "name": "_resolvedMinDate",
+   "readonly": true
+  },
+  {
+   "kind": "field",
+   "name": "_resolvedMaxDate",
+   "readonly": true
+  },
+  {
+   "kind": "field",
+   "name": "_resolvedMinTime",
+   "readonly": true
+  },
+  {
+   "kind": "field",
+   "name": "_resolvedMaxTime",
+   "readonly": true
+  },
+  {
+   "kind": "field",
+   "name": "type",
+   "type": {
+    "text": "string"
+   },
+   "default": "'datetime-local'"
+  },
+  {
+   "kind": "field",
+   "name": "step",
+   "type": {
+    "text": "string"
+   },
+   "default": "'1'"
+  },
+  {
+   "kind": "field",
+   "name": "minutesStep",
+   "type": {
+    "text": "number | null"
+   },
+   "default": "null",
+   "description": "Distance between presented minute options.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "TimeSelectionPicker",
+    "module": "src/shared/picker-field/mixins/time-selection-picker.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "secondsStep",
+   "type": {
+    "text": "number | null"
+   },
+   "default": "null",
+   "description": "Distance between presented seconds options. If null, seconds are not presented.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "TimeSelectionPicker",
+    "module": "src/shared/picker-field/mixins/time-selection-picker.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "clock",
+   "type": {
+    "text": "'12h' | '24h' | undefined"
+   },
+   "description": "Forces a 12h or 24h clock to be used.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "TimeSelectionPicker",
+    "module": "src/shared/picker-field/mixins/time-selection-picker.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#clockChangeHandler",
+   "privacy": "private",
+   "type": {
+    "text": "object"
+   },
+   "default": "{\n\t\t\thandleChange: () => {\n\t\t\t\tif (this.value) {\n\t\t\t\t\tthis._presentationValue = this._toPresentationValue(this.value);\n\t\t\t\t}\n\t\t\t},\n\t\t}",
+   "inheritedFrom": {
+    "name": "TimeSelectionPicker",
+    "module": "src/shared/picker-field/mixins/time-selection-picker.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#clockChangeObserver",
+   "privacy": "private",
+   "type": {
+    "text": "BindingObserver"
+   },
+   "inheritedFrom": {
+    "name": "TimeSelectionPicker",
+    "module": "src/shared/picker-field/mixins/time-selection-picker.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#startObservingClockChanges",
+   "inheritedFrom": {
+    "name": "TimeSelectionPicker",
+    "module": "src/shared/picker-field/mixins/time-selection-picker.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#stopObservingClockChanges",
+   "inheritedFrom": {
+    "name": "TimeSelectionPicker",
+    "module": "src/shared/picker-field/mixins/time-selection-picker.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#isMonthAfterValidRange",
+   "parameters": [
+    {
+     "name": "month",
+     "type": {
+      "text": "Month"
+     }
+    }
+   ],
+   "inheritedFrom": {
+    "name": "CalendarPicker",
+    "module": "src/shared/picker-field/mixins/calendar-picker.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#isMonthBeforeValidRange",
+   "parameters": [
+    {
+     "name": "month",
+     "type": {
+      "text": "Month"
+     }
+    }
+   ],
+   "inheritedFrom": {
+    "name": "CalendarPicker",
+    "module": "src/shared/picker-field/mixins/calendar-picker.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "value",
+   "type": {
+    "text": "string"
+   },
+   "description": "The current value of the element.",
+   "default": "''",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "readOnly",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Whether the date-picker is readonly.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "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": "object"
+   },
+   "default": "{\n\t\thandleChange: () => {\n\t\t\tthis._updatePresentationValue();\n\t\t},\n\t}",
+   "inheritedFrom": {
+    "name": "PickerField",
+    "module": "src/shared/picker-field/picker-field.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#localeChangeObserver",
+   "privacy": "private",
+   "type": {
+    "text": "BindingObserver"
+   },
+   "inheritedFrom": {
+    "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": "#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 | 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.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "WithFeedback",
+    "module": "src/shared/feedback/mixins.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "errorText",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Provides a custom error message. Any current error state will be overridden.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#blockValidateCalls",
+   "privacy": "private",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#originalValidateFn",
+   "privacy": "private",
+   "type": {
+    "text": "() => void"
+   },
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#forceCustomError",
+   "parameters": [
+    {
+     "name": "errorMessage",
+     "type": {
+      "text": "string"
+     }
+    }
+   ],
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#clearCustomErrorAndRevalidate",
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "validate",
+   "inheritedFrom": {
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "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": "FormElement",
+    "module": "src/shared/patterns/form-elements/form-element.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "validity",
+   "type": {
+    "text": "ValidityState"
+   },
+   "description": "Returns the validity state of the element",
+   "readonly": true,
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "form",
+   "type": {
+    "text": "HTMLFormElement | null"
+   },
+   "description": "Retrieve a reference to the associated form.\nReturns null if not associated to any form.",
+   "readonly": true,
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "validationMessage",
+   "type": {
+    "text": "string"
+   },
+   "description": "Retrieve the localized validation message,\nor custom validation message if set.",
+   "readonly": true,
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "willValidate",
+   "type": {
+    "text": "boolean"
+   },
+   "description": "Whether the element will be validated when the\nform is submitted",
+   "readonly": true,
+   "inheritedFrom": {
+    "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": "checkValidity",
+   "return": {
+    "type": {
+     "text": "boolean"
+    }
+   },
+   "description": "Return the current validity of the element.",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "reportValidity",
+   "return": {
+    "type": {
+     "text": "boolean"
+    }
+   },
+   "description": "Return the current validity of the element.\nIf false, fires an invalid event at the element.",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "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"
+   },
+   "inheritedFrom": {
+    "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"
+   }
+  }
+ ],
+ "events": [
+  {
+   "type": {
+    "text": "CustomEvent<undefined>"
+   },
+   "description": "Emitted when the date is changed by the user.",
+   "name": "input"
+  },
+  {
+   "type": {
+    "text": "CustomEvent<undefined>"
+   },
+   "description": "Emitted when the date is changed by the user.",
+   "name": "change"
+  }
+ ],
+ "attributes": [
+  {
+   "name": "min",
+   "type": {
+    "text": "string"
+   },
+   "description": "The earliest accepted date-time.",
+   "default": "''",
+   "fieldName": "min"
+  },
+  {
+   "name": "min-time",
+   "type": {
+    "text": "string"
+   },
+   "description": "The earliest accepted time part of the date-time.",
+   "default": "''",
+   "fieldName": "minTime"
+  },
+  {
+   "name": "min-date",
+   "type": {
+    "text": "string"
+   },
+   "description": "The earliest accepted date part of the date-time.",
+   "default": "''",
+   "fieldName": "minDate"
+  },
+  {
+   "name": "max",
+   "type": {
+    "text": "string"
+   },
+   "description": "The latest accepted date-time.",
+   "default": "''",
+   "fieldName": "max"
+  },
+  {
+   "name": "max-time",
+   "type": {
+    "text": "string"
+   },
+   "description": "The latest accepted time part of the date-time.",
+   "default": "''",
+   "fieldName": "maxTime"
+  },
+  {
+   "name": "max-date",
+   "type": {
+    "text": "string"
+   },
+   "description": "The latest accepted time date of the date-time.",
+   "default": "''",
+   "fieldName": "maxDate"
+  },
+  {
+   "name": "minutes-step",
+   "type": {
+    "text": "number | null"
+   },
+   "default": "null",
+   "description": "Distance between presented minute options.",
+   "fieldName": "minutesStep",
+   "inheritedFrom": {
+    "name": "TimeSelectionPicker",
+    "module": "src/shared/picker-field/mixins/time-selection-picker.ts"
+   }
+  },
+  {
+   "name": "seconds-step",
+   "type": {
+    "text": "number | null"
+   },
+   "default": "null",
+   "description": "Distance between presented seconds options. If null, seconds are not presented.",
+   "fieldName": "secondsStep",
+   "inheritedFrom": {
+    "name": "TimeSelectionPicker",
+    "module": "src/shared/picker-field/mixins/time-selection-picker.ts"
+   }
+  },
+  {
+   "name": "clock",
+   "type": {
+    "text": "'12h' | '24h' | undefined"
+   },
+   "description": "Forces a 12h or 24h clock to be used.",
+   "fieldName": "clock",
+   "inheritedFrom": {
+    "name": "TimeSelectionPicker",
+    "module": "src/shared/picker-field/mixins/time-selection-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"
+   }
+  },
+  {
+   "name": "value",
+   "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.",
+   "fieldName": "initialValue",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "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 name of the element. This element's value will be surfaced during form submission under the provided name.",
+   "fieldName": "name",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "name": "required",
+   "type": {
+    "text": "boolean"
+   },
+   "description": "Require the field to be completed prior to form submission.",
+   "default": "false",
+   "fieldName": "required",
+   "inheritedFrom": {
+    "name": "FormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  }
+ ],
+ "mixins": [
+  {
+   "name": "TimeSelectionPicker",
+   "module": "/src/shared/picker-field/mixins/time-selection-picker"
+  },
+  {
+   "name": "SingleDatePickerMixin",
+   "module": "/src/shared/picker-field/mixins/single-date-picker"
+  },
+  {
+   "name": "SingleValuePicker",
+   "module": "/src/shared/picker-field/mixins/single-value-picker"
+  },
+  {
+   "name": "CalendarPicker",
+   "module": "/src/shared/picker-field/mixins/calendar-picker"
+  }
+ ],
+ "superclass": {
+  "name": "PickerField",
+  "module": "/src/shared/picker-field/picker-field"
+ },
+ "vividComponent": {
+  "public": true,
+  "name": "date-time-picker",
+  "vueModels": [
+   {
+    "name": "modelValue",
+    "propName": "value",
+    "eventNames": [
+     "input"
+    ],
+    "valueMapping": "event.currentTarget.value"
+   }
+  ]
+ }
+}
+*/
+import wrapper from '@vonage/vivid-react-wrapper'
+import { registerDateTimePicker } from '@vonage/vivid'
+
+registerDateTimePicker('vvd3')
+
+const VwcDateTimePicker = wrapper(`vvd3-date-time-picker`,  {
+    events: [{"name":"change","propName":"onChange"},{"name":"input","propName":"onInput"}],
+    attributes: [],
+    properties: ['min', 'minTime', 'minDate', 'max', 'maxTime', 'maxDate', 'type', 'step', 'minutesStep', 'secondsStep', 'clock', 'value', 'readOnly', 'helperText', 'errorText', 'validate', 'label', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
+})
+
+VwcDateTimePicker.displayName = 'VwcDateTimePicker'
+
+export default VwcDateTimePicker