@vonage/vivid-react 3.5.2 → 5.19.0

package/v3/VwcColorPicker/index.d.ts

@@ -0,0 +1,60 @@
+import React, { ReactNode, SyntheticEvent } from 'react';
+/** VwcColorPicker
+* For more info on this Vivid element please visit https://vivid.deno.dev/components/color-picker
+* @param {string} placeholder - Text that appears in the input element when it has no value set **attribute** `placeholder`
+* @param {string | undefined} savedColorsKey - Sets the localStorage key used to store saved colors explicitly **attribute** `saved-colors-key`
+* @param {boolean} disableSavedColors - Disables the saving colors functionality **attribute** `disable-saved-colors`
+* @param {number} maxSwatches - Limits number of swatches that can be saved. **attribute** `max-swatches`
+* @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 | undefined} errorText - Provides a custom error message. Any current error state will be overridden. **attribute** `error-text`
+* @param  validate
+* @param {string | undefined} successText - Provides a custom success message. Any current error state will be overridden. **attribute** `success-text`
+* @param {boolean} open - Indicates whether the popup is open **attribute** `open`
+* @param {ColorSwatch[]} swatches - List of color swatches, has to be an array of objects
+
+### Examples
+* @param {string | undefined} label - The label for the form element. **attribute** `label`
+* @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
+only when the `value` property has not been explicitly set. **attribute** `value`
+* @param {boolean} disabled - Sets the element's disabled state. A disabled element will not be included during form submission. **attribute** `disabled`
+* @param {string} name - The name of the element. This element's value will be surfaced during form submission under the provided name. **attribute** `name`
+* @param {boolean} required - Require the field to be completed prior to form submission. **attribute** `required`
+* @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 VwcColorPicker: {
+    (props: {
+        children?: ReactNode;
+        slot?: string;
+        id?: string;
+        style?: React.CSSProperties;
+        ref?: ((instance: HTMLDivElement | null) => void) | React.RefObject<HTMLDivElement> | null | undefined;
+        onChange?: (event: SyntheticEvent) => void;
+        onInput?: (event: SyntheticEvent) => void;
+        "placeholder"?: string;
+        "savedColorsKey"?: string | undefined;
+        "disableSavedColors"?: boolean;
+        "maxSwatches"?: number;
+        "helperText"?: string | undefined;
+        "errorText"?: string | undefined;
+        "validate"?: any;
+        "successText"?: string | undefined;
+        "open"?: boolean;
+        "swatches"?: any[];
+        "label"?: string | undefined;
+        "value"?: string;
+        "currentValue"?: any;
+        "initialValue"?: string;
+        "disabled"?: boolean;
+        "name"?: string;
+        "required"?: boolean;
+        "VIVID_VERSION"?: string;
+        "componentName"?: string;
+    }): JSX.Element;
+    displayName: string;
+};
+export default VwcColorPicker;

package/v3/VwcColorPicker/index.js

@@ -0,0 +1,647 @@
+/*
+* DO NOT EDIT THIS FILE. IT IS GENERATED
+*/
+/*
+Code in this file were generated using following JSON:
+{
+ "kind": "class",
+ "description": "",
+ "name": "ColorPicker",
+ "slots": [
+  {
+   "description": "Describes how to use the text-field. Alternative to the `helper-text` attribute.",
+   "name": "helper-text"
+  },
+  {
+   "description": "Overrides the default \"Color Picker\" title of the Popup window.",
+   "name": "popup-text"
+  },
+  {
+   "description": " Overrides the default \"Saved colors:\" text above color swatches.",
+   "name": "swatches-text"
+  }
+ ],
+ "members": [
+  {
+   "kind": "field",
+   "name": "placeholder",
+   "type": {
+    "text": "string"
+   },
+   "description": "Text that appears in the input element when it has no value set",
+   "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "savedColorsKey",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Sets the localStorage key used to store saved colors explicitly",
+   "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "disableSavedColors",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Disables the saving colors functionality",
+   "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "maxSwatches",
+   "type": {
+    "text": "number"
+   },
+   "default": "6",
+   "description": "Limits number of swatches that can be saved.",
+   "privacy": "public"
+  },
+  {
+   "kind": "field",
+   "name": "#iconResetTimer",
+   "privacy": "private",
+   "type": {
+    "text": "ReturnType<typeof setTimeout> | null"
+   },
+   "default": "null"
+  },
+  {
+   "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": "successText",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Provides a custom success message. Any current error state will be overridden.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "WithSuccessText",
+    "module": "src/shared/patterns/form-elements/with-success-text.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": "placeholder",
+   "type": {
+    "text": "string"
+   },
+   "description": "Text that appears in the input element when it has no value set",
+   "fieldName": "placeholder"
+  },
+  {
+   "name": "saved-colors-key",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Sets the localStorage key used to store saved colors explicitly",
+   "fieldName": "savedColorsKey"
+  },
+  {
+   "name": "disable-saved-colors",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Disables the saving colors functionality",
+   "fieldName": "disableSavedColors"
+  },
+  {
+   "name": "max-swatches",
+   "type": {
+    "text": "number"
+   },
+   "default": "6",
+   "description": "Limits number of swatches that can be saved.",
+   "fieldName": "maxSwatches"
+  },
+  {
+   "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": "success-text",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "Provides a custom success message. Any current error state will be overridden.",
+   "fieldName": "successText",
+   "inheritedFrom": {
+    "name": "WithSuccessText",
+    "module": "src/shared/patterns/form-elements/with-success-text.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": "WithContextualHelp",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "WithFeedback",
+   "module": "/src/shared/feedback/mixins"
+  },
+  {
+   "name": "WithErrorText",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "WithSuccessText",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "DelegatesAria",
+   "module": "/src/shared/aria/delegates-aria"
+  },
+  {
+   "name": "TrappedFocus",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "BaseColorPicker",
+   "module": "/src/shared/color-picker"
+  }
+ ],
+ "superclass": {
+  "name": "VividElement",
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
+ },
+ "vividComponent": {
+  "public": true,
+  "name": "color-picker",
+  "vueModels": [
+   {
+    "name": "modelValue",
+    "propName": "value",
+    "eventNames": [
+     "input",
+     "@lazy:change"
+    ],
+    "valueMapping": "event.currentTarget.value"
+   }
+  ]
+ }
+}
+*/
+import wrapper from '@repo/react-component-wrapper'
+import { registerColorPicker } from '@vonage/vivid'
+
+registerColorPicker('vvd3')
+
+const VwcColorPicker = wrapper(`vvd3-color-picker`,  {
+    events: [{"name":"input","propName":"onInput"},{"name":"change","propName":"onChange"}],
+    attributes: [],
+    properties: ['placeholder', 'savedColorsKey', 'disableSavedColors', 'maxSwatches', 'helperText', 'errorText', 'validate', 'successText', 'open', 'swatches', 'label', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
+})
+
+VwcColorPicker.displayName = 'VwcColorPicker'
+
+export default VwcColorPicker