@vonage/vivid-react 3.4.1 → 3.5.1

package/v3/VwcPickerField/index.js

@@ -0,0 +1,555 @@
+/*
+* DO NOT EDIT THIS FILE. IT IS GENERATED
+*/
+/*
+Code in this file were generated using following JSON:
+{
+ "kind": "class",
+ "description": "Base class for picker fields. Picker fields consist of a text field with a button that opens a popup that allows\npicking values.",
+ "name": "PickerField",
+ "members": [
+  {
+   "kind": "field",
+   "name": "readOnly",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Whether the date-picker is readonly.",
+   "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "#onFocusIn",
+   "privacy": "private"
+  },
+  {
+   "kind": "field",
+   "name": "#onFocusOut",
+   "privacy": "private"
+  },
+  {
+   "kind": "field",
+   "name": "#localeChangeHandler",
+   "privacy": "private",
+   "type": {
+    "text": "object"
+   },
+   "default": "{\n\t\thandleChange: () => {\n\t\t\tthis._updatePresentationValue();\n\t\t},\n\t}"
+  },
+  {
+   "kind": "field",
+   "name": "#localeChangeObserver",
+   "privacy": "private",
+   "type": {
+    "text": "BindingObserver"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#startObservingLocaleChanges"
+  },
+  {
+   "kind": "method",
+   "name": "#stopObservingLocaleChanges"
+  },
+  {
+   "kind": "field",
+   "name": "#dismissOnClickOutside",
+   "privacy": "private"
+  },
+  {
+   "kind": "method",
+   "name": "#openPopupIfPossible"
+  },
+  {
+   "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": "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"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "specialHandling",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "inheritedFrom": {
+    "name": "VividElement",
+    "module": "src/shared/foundation/vivid-element/vivid-element.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "_vividAriaBehaviour",
+   "type": {
+    "text": "VividAriaBehaviour"
+   },
+   "default": "'default'",
+   "inheritedFrom": {
+    "name": "VividElement",
+    "module": "src/shared/foundation/vivid-element/vivid-element.ts"
+   }
+  },
+  {
+   "kind": "method",
+   "name": "#handleReplacedProp",
+   "parameters": [
+    {
+     "name": "replacedProp",
+     "type": {
+      "text": "ReplacedPropConfiguration<any, any>"
+     }
+    }
+   ],
+   "inheritedFrom": {
+    "name": "VividElement",
+    "module": "src/shared/foundation/vivid-element/vivid-element.ts"
+   }
+  }
+ ],
+ "attributes": [
+  {
+   "name": "readonly",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Whether the date-picker is readonly.",
+   "fieldName": "readOnly"
+  },
+  {
+   "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": "WithFeedback",
+   "module": "/src/shared/feedback/mixins"
+  },
+  {
+   "name": "WithErrorText",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "FormElement",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "TrappedFocus",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "Localized",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "FormAssociated",
+   "module": "/src/shared/foundation/form-associated/form-associated"
+  }
+ ],
+ "superclass": {
+  "name": "VividElement",
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
+ }
+}
+*/
+import wrapper from '@vonage/vivid-react-wrapper'
+import { registerPickerField } from '@vonage/vivid'
+
+registerPickerField('vvd3')
+
+const VwcPickerField = wrapper(`vvd3-picker-field`,  {
+    events: [],
+    attributes: [],
+    properties: ['readOnly', 'value', 'helperText', 'errorText', 'validate', 'label', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName', 'specialHandling', '_vividAriaBehaviour']
+})
+
+VwcPickerField.displayName = 'VwcPickerField'
+
+export default VwcPickerField

package/v3/VwcPickerField/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@vonage/vivid-react-vvd3-picker-field",
+  "version": "4.28.0",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "private": true,
+  "license": "MIT",
+  "dependencies": {
+    "@vonage/vivid": "4.28.0"
+  }
+}

package/v3/VwcPopup/index.d.ts

@@ -0,0 +1,44 @@
+import React, { ReactNode } from 'react';
+/** VwcPopup
+* For more info on this Vivid element please visit https://vivid.deno.dev/components/popup
+* @param {HTMLElement} popupEl
+* @param {HTMLElement} arrowEl
+* @param {boolean} open - indicates whether the popup is open **attribute** `open`
+* @param {boolean} dismissible - adds close button to the popup **attribute** `dismissible`
+* @param {boolean} arrow - adds small triangle to indicate the trigger element **attribute** `arrow`
+* @param {boolean} alternate - set the color-scheme to dark **attribute** `alternate`
+* @param {Placement | undefined} placement - the placement of the popup **attribute** `placement`
+* @param {PlacementStrategyId} placementStrategy - The placement strategy of the popup.
+* @param {boolean} animationFrame - Whether to update the position of the floating element on every animation frame if required. **attribute** `animation-frame`
+* @param {Strategy | undefined} strategy - The strategy of the popup **attribute** `strategy`
+* @param {number | null} offset - Adds offset to the popup **attribute** `offset`
+* @param {HTMLElement | undefined} anchor - The element to anchor the popup to.
+* @param {string} VIVID_VERSION - The current version of the Vivid library, which is useful for debugging.
+It can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.
+* @param {string} componentName - Core component name, without prefix
+*/
+declare const VwcPopup: {
+    (props: {
+        children?: ReactNode;
+        slot?: string | undefined;
+        id?: string | undefined;
+        style?: React.CSSProperties | undefined;
+        ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
+        popupEl?: any;
+        arrowEl?: any;
+        open?: boolean | undefined;
+        dismissible?: boolean | undefined;
+        arrow?: boolean | undefined;
+        alternate?: boolean | undefined;
+        placement?: any;
+        placementStrategy?: any;
+        animationFrame?: boolean | undefined;
+        strategy?: any;
+        offset?: number | undefined;
+        anchor?: any;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
+    }): JSX.Element;
+    displayName: string;
+};
+export default VwcPopup;