@vonage/vivid-react 3.5.2 → 5.19.0

package/v3/VwcSimpleColorPicker/index.js

@@ -0,0 +1,508 @@
+/*
+* DO NOT EDIT THIS FILE. IT IS GENERATED
+*/
+/*
+Code in this file were generated using following JSON:
+{
+ "kind": "class",
+ "description": "",
+ "name": "SimpleColorPicker",
+ "slots": [
+  {
+   "description": "Slot for attaching the toggle button",
+   "name": "anchor"
+  }
+ ],
+ "members": [
+  {
+   "kind": "field",
+   "name": "placement",
+   "type": {
+    "text": "Placement | undefined"
+   },
+   "default": "'top-start'",
+   "description": "Preferred placement of the Color Picker's popup in relation to the anchor element",
+   "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "swatchesPerRow",
+   "type": {
+    "text": "number"
+   },
+   "default": "7",
+   "description": "Number of swatches per row for grid layout",
+   "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "anchor",
+   "type": {
+    "text": "AnchorType | undefined"
+   },
+   "description": "ID or direct reference to the component's anchor element.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "Anchored",
+    "module": "src/shared/patterns/anchored.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#updateAnchorEl",
+   "privacy": "private",
+   "inheritedFrom": {
+    "name": "Anchored",
+    "module": "src/shared/patterns/anchored.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#observer",
+   "privacy": "private",
+   "type": {
+    "text": "MutationObserver | undefined"
+   },
+   "inheritedFrom": {
+    "name": "Anchored",
+    "module": "src/shared/patterns/anchored.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#observeMissingAnchor",
+   "privacy": "private",
+   "inheritedFrom": {
+    "name": "Anchored",
+    "module": "src/shared/patterns/anchored.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "#cleanupObserverIfNeeded",
+   "privacy": "private",
+   "inheritedFrom": {
+    "name": "Anchored",
+    "module": "src/shared/patterns/anchored.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "open",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Indicates whether the popup is open",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "BaseColorPicker",
+    "module": "src/shared/color-picker/base-color-picker.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "swatches",
+   "type": {
+    "text": "ColorSwatch[]"
+   },
+   "default": "[]",
+   "description": "List of color swatches, has to be an array of objects\n\n### Examples",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "BaseColorPicker",
+    "module": "src/shared/color-picker/base-color-picker.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": "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"
+   }
+  }
+ ],
+ "events": [
+  {
+   "type": {
+    "text": "CustomEvent<undefined>"
+   },
+   "description": "Fires when the value changes",
+   "name": "change"
+  },
+  {
+   "type": {
+    "text": "Event"
+   },
+   "description": "Fires when the value of the element changes.",
+   "name": "input"
+  }
+ ],
+ "attributes": [
+  {
+   "name": "placement",
+   "type": {
+    "text": "Placement | undefined"
+   },
+   "default": "'top-start'",
+   "description": "Preferred placement of the Color Picker's popup in relation to the anchor element",
+   "fieldName": "placement"
+  },
+  {
+   "name": "swatches-per-row",
+   "type": {
+    "text": "number"
+   },
+   "default": "7",
+   "description": "Number of swatches per row for grid layout",
+   "fieldName": "swatchesPerRow"
+  },
+  {
+   "name": "anchor",
+   "type": {
+    "text": "AnchorType | undefined"
+   },
+   "description": "ID or direct reference to the component's anchor element.",
+   "fieldName": "anchor",
+   "inheritedFrom": {
+    "name": "Anchored",
+    "module": "src/shared/patterns/anchored.ts"
+   }
+  },
+  {
+   "name": "open",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Indicates whether the popup is open",
+   "fieldName": "open",
+   "inheritedFrom": {
+    "name": "BaseColorPicker",
+    "module": "src/shared/color-picker/base-color-picker.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": "Anchored",
+   "module": "/src/shared/patterns/anchored"
+  },
+  {
+   "name": "BaseColorPicker",
+   "module": "/src/shared/color-picker"
+  }
+ ],
+ "superclass": {
+  "name": "VividElement",
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
+ },
+ "vividComponent": {
+  "public": true,
+  "name": "simple-color-picker",
+  "vueModels": [
+   {
+    "name": "modelValue",
+    "propName": "value",
+    "eventNames": [
+     "input",
+     "@lazy:change"
+    ],
+    "valueMapping": "event.currentTarget.value"
+   }
+  ]
+ }
+}
+*/
+import wrapper from '@repo/react-component-wrapper'
+import { registerSimpleColorPicker } from '@vonage/vivid'
+
+registerSimpleColorPicker('vvd3')
+
+const VwcSimpleColorPicker = wrapper(`vvd3-simple-color-picker`,  {
+    events: [{"name":"input","propName":"onInput"},{"name":"change","propName":"onChange"}],
+    attributes: [],
+    properties: ['placement', 'swatchesPerRow', 'anchor', 'open', 'swatches', 'label', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
+})
+
+VwcSimpleColorPicker.displayName = 'VwcSimpleColorPicker'
+
+export default VwcSimpleColorPicker

package/v3/VwcSimpleColorPicker/package.json

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

package/v3/VwcSlider/index.d.ts

@@ -19,9 +19,8 @@ import React, { ReactNode, SyntheticEvent } from 'react';
 * @param {Orientation} orientation - The orientation of the slider. **attribute** `orientation`
 * @param {SliderMode} mode - The selection mode. **attribute** `mode`
 * @param {boolean} markers - Display markers on/off **attribute** `markers`
-* @param {boolean} pin - Show current value on the thumb. **attribute** `pin`
-* @param {SliderConnotation | undefined} connotation - slider connotation **attribute** `connotation`
-* @param {'delegate'} _vividAriaBehaviour
+* @param {boolean} pin - Show current values on the thumbs. **attribute** `pin`
+* @param {SliderConnotation | undefined} connotation - The connotation of the component **attribute** `connotation`
 * @param {string} value - The current value of the element. **attribute** `current-value`
 * @param  currentValue
 * @param {string} initialValue - The default value of the element. This value sets the `value` property
@@ -36,31 +35,31 @@ It can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.
 declare const VwcSlider: {
     (props: {
         children?: ReactNode;
-        slot?: string | undefined;
-        id?: string | undefined;
-        style?: React.CSSProperties | undefined;
-        ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
-        onChange?: ((event: SyntheticEvent) => void) | undefined;
-        min?: number | undefined;
-        max?: number | undefined;
-        step?: number | undefined;
-        orientation?: string | undefined;
-        markers?: boolean | undefined;
-        connotation?: string | undefined;
-        pin?: boolean | undefined;
-        disabled?: boolean | undefined;
-        value?: string | undefined;
-        readOnly?: boolean | undefined;
-        valueAsNumber?: number | undefined;
-        valueTextFormatter?: any;
-        mode?: any;
-        _vividAriaBehaviour?: any;
-        currentValue?: any;
-        initialValue?: string | undefined;
-        name?: string | undefined;
-        required?: boolean | undefined;
-        VIVID_VERSION?: string | undefined;
-        componentName?: string | undefined;
+        slot?: string;
+        id?: string;
+        style?: React.CSSProperties;
+        ref?: ((instance: HTMLDivElement | null) => void) | React.RefObject<HTMLDivElement> | null | undefined;
+        onChange?: (event: SyntheticEvent) => void;
+        onChange?: (event: SyntheticEvent) => void;
+        "min"?: number;
+        "max"?: number;
+        "step"?: number;
+        "orientation"?: string;
+        "markers"?: boolean;
+        "connotation"?: string;
+        "pin"?: boolean;
+        "disabled"?: boolean;
+        "value"?: string;
+        "readOnly"?: boolean;
+        "valueAsNumber"?: number;
+        "valueTextFormatter"?: any;
+        "mode"?: any;
+        "currentValue"?: any;
+        "initialValue"?: string;
+        "name"?: string;
+        "required"?: boolean;
+        "VIVID_VERSION"?: string;
+        "componentName"?: string;
     }): JSX.Element;
     displayName: string;
 };