@vonage/vivid-react 3.4.1 → 3.5.1

package/v3/VwcRadio/index.js

@@ -66,15 +66,6 @@ Code in this file were generated using following JSON:
    },
    "default": "null"
   },
-  {
-   "kind": "field",
-   "name": "label",
-   "type": {
-    "text": "string | undefined"
-   },
-   "description": "Indicates the radio's label.",
-   "privacy": "public"
-  },
   {
    "kind": "field",
    "name": "connotation",
@@ -93,14 +84,6 @@ Code in this file were generated using following JSON:
    "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.",
    "privacy": "public"
   },
-  {
-   "kind": "field",
-   "name": "name",
-   "type": {
-    "text": "string"
-   },
-   "description": "The name of the radio. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname | name attribute for more info."
-  },
   {
    "kind": "method",
    "name": "isInsideRadioGroup",
@@ -113,49 +96,362 @@ Code in this file were generated using following JSON:
   },
   {
    "kind": "field",
-   "name": "proxy",
+   "name": "#radioSiblings",
+   "privacy": "private",
+   "type": {
+    "text": "Radio[]"
+   },
+   "readonly": true
+  },
+  {
+   "kind": "field",
+   "name": "#radioGroup",
+   "privacy": "private",
+   "type": {
+    "text": "RadioGroup | null"
+   },
+   "readonly": true
+  },
+  {
+   "kind": "field",
+   "name": "#validateValueMissingWithSiblings",
+   "privacy": "private"
+  },
+  {
+   "kind": "field",
+   "name": "#syncSiblingsRequiredValidationStatus",
+   "privacy": "private"
+  },
+  {
+   "kind": "field",
+   "name": "checked",
+   "type": {
+    "text": "boolean"
+   },
+   "description": "The current checkedness of the element.",
+   "privacy": "public",
    "inheritedFrom": {
-    "name": "FormAssociatedRadio",
-    "module": "libs/components/src/lib/radio/radio.form-associated.ts"
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
    }
   },
   {
    "kind": "field",
-   "name": "#radioSiblings",
-   "privacy": "private",
+   "name": "dirtyChecked",
    "type": {
-    "text": "_Radio[]"
+    "text": "boolean"
    },
-   "readonly": true,
+   "default": "false"
+  },
+  {
+   "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": "FormAssociatedRadio",
-    "module": "libs/components/src/lib/radio/radio.form-associated.ts"
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
    }
   },
   {
    "kind": "field",
-   "name": "#validateValueMissingWithSiblings",
+   "name": "#blockValidateCalls",
    "privacy": "private",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
    "inheritedFrom": {
-    "name": "FormAssociatedRadio",
-    "module": "libs/components/src/lib/radio/radio.form-associated.ts"
+    "name": "WithErrorText",
+    "module": "src/shared/patterns/form-elements/with-error-text.ts"
    }
   },
   {
    "kind": "field",
-   "name": "#syncSiblingsRequiredValidationStatus",
+   "name": "#originalValidateFn",
    "privacy": "private",
+   "type": {
+    "text": "() => void"
+   },
    "inheritedFrom": {
-    "name": "FormAssociatedRadio",
-    "module": "libs/components/src/lib/radio/radio.form-associated.ts"
+    "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": "FormAssociatedRadio",
-    "module": "libs/components/src/lib/radio/radio.form-associated.ts"
+    "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": "defaultChecked",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "The default checkedness of the element. This value sets the `checked` property\nonly when the `checked` property has not been explicitly set.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "checkedAttribute",
+   "inheritedFrom": {
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "currentChecked",
+   "inheritedFrom": {
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.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": "value",
+   "type": {
+    "text": "string"
+   },
+   "description": "The current value of the element.",
+   "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"
    }
   }
  ],
@@ -177,14 +473,6 @@ Code in this file were generated using following JSON:
    "default": "null",
    "fieldName": "ariaLabel"
   },
-  {
-   "name": "label",
-   "type": {
-    "text": "string | undefined"
-   },
-   "description": "Indicates the radio's label.",
-   "fieldName": "label"
-  },
   {
    "name": "connotation",
    "type": {
@@ -201,18 +489,135 @@ Code in this file were generated using following JSON:
    "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information.",
    "fieldName": "readOnly"
   },
+  {
+   "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": "checked",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "The default checkedness of the element. This value sets the `checked` property\nonly when the `checked` property has not been explicitly set.",
+   "fieldName": "defaultChecked",
+   "inheritedFrom": {
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.ts"
+   }
+  },
+  {
+   "name": "current-checked",
+   "type": {
+    "text": "boolean"
+   },
+   "description": "The current checkedness of the element.",
+   "fieldName": "checked",
+   "inheritedFrom": {
+    "name": "CheckableFormAssociated",
+    "module": "src/shared/foundation/form-associated/form-associated.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 radio. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname | name attribute for more info.",
-   "fieldName": "name"
+   "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": "WithErrorText",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "FormElement",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "CheckableFormAssociated",
+   "module": "/src/shared/foundation/form-associated/form-associated"
   }
  ],
  "superclass": {
-  "name": "FormAssociatedRadio",
-  "module": "/libs/components/src/lib/radio/radio.form-associated"
+  "name": "VividElement",
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
  },
  "vividComponent": {
   "public": true,
@@ -228,7 +633,7 @@ registerRadio('vvd3')
 const VwcRadio = wrapper(`vvd3-radio`,  {
     events: [{"name":"change","propName":"onChange"}],
     attributes: [],
-    properties: ['ariaLabel', 'label', 'connotation', 'readOnly', 'name', 'proxy', 'validate']
+    properties: ['ariaLabel', 'connotation', 'readOnly', 'checked', 'dirtyChecked', 'errorText', 'validate', 'label', 'defaultChecked', 'checkedAttribute', 'currentChecked', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
 })
 
 VwcRadio.displayName = 'VwcRadio'

package/v3/VwcRadio/package.json

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

package/v3/VwcRadioGroup/index.d.ts

@@ -1,13 +1,20 @@
 import React, { ReactNode, SyntheticEvent } from 'react';
 /** VwcRadioGroup
 * For more info on this Vivid element please visit https://vivid.deno.dev/components/radio-group
-* @param {string | undefined} label - Indicates the group's label. **attribute** `label`
+* @param {string} label - The label for the radio group **attribute** `label`
+* @param {boolean} required - When true, the radio group and all its radio buttons will be required **attribute** `required`
 * @param {boolean} readOnly - When true, the child radios will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information. **attribute** `readonly`
 * @param {boolean} disabled - Disables the radio group and child radios. **attribute** `disabled`
 * @param {string} name - The name of the radio group. Setting this value will set the name value
 for all child radio elements. **attribute** `name`
 * @param {string} value - The value of the checked radio **attribute** `value`
+* @param {string} errorText  **attribute** `error-text`
 * @param {Orientation | 'horizontal' | 'vertical'} orientation - The orientation of the group **attribute** `orientation`
+* @param {string | undefined} helperText - Provides additional information to help the user enter the correct information.
+To add HTML to the helper text, use the helper-text slot instead. **attribute** `helper-text`
+* @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 VwcRadioGroup: {
     (props: {
@@ -18,11 +25,16 @@ declare const VwcRadioGroup: {
         ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
         onChange?: ((event: SyntheticEvent) => void) | undefined;
         label?: string | undefined;
+        required?: boolean | undefined;
         readOnly?: boolean | undefined;
         disabled?: boolean | undefined;
         name?: string | undefined;
         value?: string | undefined;
+        errorText?: string | undefined;
         orientation?: any;
+        helperText?: string | undefined;
+        VIVID_VERSION?: string | undefined;
+        componentName?: string | undefined;
     }): JSX.Element;
     displayName: string;
 };