@vonage/vivid-react 3.4.1 → 3.5.1

package/v3/VwcSearchableSelect/index.js

@@ -47,7 +47,7 @@ Code in this file were generated using following JSON:
    "name": ""
   },
   {
-   "description": "Slot to add an icon to the control.",
+   "description": "The preferred way to add an icon to the control.",
    "name": "icon"
   },
   {
@@ -65,6 +65,10 @@ Code in this file were generated using following JSON:
   {
    "description": "Message that appears when no options match the search query.",
    "name": "no-matches"
+  },
+  {
+   "description": "Message that appears there are no options to display and the component is in a loading state.",
+   "name": "loading-options"
   }
  ],
  "members": [
@@ -213,6 +217,12 @@ Code in this file were generated using following JSON:
    "name": "selectedOptions",
    "readonly": true
   },
+  {
+   "kind": "field",
+   "name": "searchText",
+   "description": "The current search text of the component.",
+   "readonly": true
+  },
   {
    "kind": "field",
    "name": "#slottedOptionsChangeHandler",
@@ -270,12 +280,20 @@ Code in this file were generated using following JSON:
   },
   {
    "kind": "field",
-   "name": "#suppressFilter",
-   "privacy": "private",
+   "name": "optionFilter",
+   "type": {
+    "text": "(\n\t\toption: ListboxOption,\n\t\tsearchText: string\n\t) => boolean | undefined"
+   },
+   "description": "Function to filter the options to display."
+  },
+  {
+   "kind": "field",
+   "name": "loading",
    "type": {
     "text": "boolean"
    },
-   "default": "false"
+   "default": "false",
+   "description": "Whether the component is in a loading state."
   },
   {
    "kind": "method",
@@ -395,6 +413,20 @@ Code in this file were generated using following JSON:
    "description": "Adds a clear button to the input field that clears the selected values.",
    "privacy": "public"
   },
+  {
+   "kind": "field",
+   "name": "maxSelected",
+   "type": {
+    "text": "number | null"
+   },
+   "default": "null",
+   "privacy": "public",
+   "description": ""
+  },
+  {
+   "kind": "method",
+   "name": "#updateSelectionLimit"
+  },
   {
    "kind": "method",
    "name": "#determineInitialValues"
@@ -415,10 +447,348 @@ Code in this file were generated using following JSON:
   },
   {
    "kind": "field",
-   "name": "proxy",
+   "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": "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": "_vividAriaBehaviour",
+   "default": "'delegate'",
+   "type": {
+    "text": "'delegate'"
+   },
+   "inheritedFrom": {
+    "name": "DelegatesAria",
+    "module": "src/shared/aria/delegates-aria.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "iconTrailing",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Indicates the icon affix alignment.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "AffixIconWithTrailing",
+    "module": "src/shared/patterns/affix.ts"
+   }
+  },
+  {
+   "kind": "field",
+   "name": "icon",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "A decorative icon the custom element should have.",
+   "privacy": "public",
+   "inheritedFrom": {
+    "name": "AffixIcon",
+    "module": "src/shared/patterns/affix.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": "FormAssociatedSearchableSelect",
-    "module": "libs/components/src/lib/searchable-select/searchable-select.form-associated.ts"
+    "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"
    }
   }
  ],
@@ -430,6 +800,13 @@ Code in this file were generated using following JSON:
    "description": "Fired when the selected options change",
    "name": "input"
   },
+  {
+   "type": {
+    "text": "CustomEvent<undefined>"
+   },
+   "description": "Fired when the search text changes",
+   "name": "search-text-change"
+  },
   {
    "type": {
     "text": "CustomEvent<undefined>"
@@ -469,6 +846,7 @@ Code in this file were generated using following JSON:
    "fieldName": "placeholder"
   },
   {
+   "name": "open",
    "type": {
     "text": "boolean"
    },
@@ -476,6 +854,7 @@ Code in this file were generated using following JSON:
    "fieldName": "open"
   },
   {
+   "name": "multiple",
    "type": {
     "text": "boolean"
    },
@@ -499,17 +878,204 @@ Code in this file were generated using following JSON:
    "fieldName": "maxLines"
   },
   {
+   "name": "loading",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Whether the component is in a loading state.",
+   "fieldName": "loading"
+  },
+  {
+   "name": "clearable",
    "type": {
     "text": "boolean"
    },
    "default": "false",
    "description": "Adds a clear button to the input field that clears the selected values.",
    "fieldName": "clearable"
+  },
+  {
+   "name": "max-selected",
+   "type": {
+    "text": "number | null"
+   },
+   "default": "null",
+   "fieldName": "maxSelected"
+  },
+  {
+   "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": "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": "icon-trailing",
+   "type": {
+    "text": "boolean"
+   },
+   "default": "false",
+   "description": "Indicates the icon affix alignment.",
+   "fieldName": "iconTrailing",
+   "inheritedFrom": {
+    "name": "AffixIconWithTrailing",
+    "module": "src/shared/patterns/affix.ts"
+   }
+  },
+  {
+   "name": "icon",
+   "type": {
+    "text": "string | undefined"
+   },
+   "description": "A decorative icon the custom element should have.",
+   "fieldName": "icon",
+   "inheritedFrom": {
+    "name": "AffixIcon",
+    "module": "src/shared/patterns/affix.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": "WithSuccessText",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "FormElement",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "DelegatesAria",
+   "module": "/src/shared/aria/delegates-aria"
+  },
+  {
+   "name": "AffixIconWithTrailing",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "Localized",
+   "module": "/src/shared/patterns"
+  },
+  {
+   "name": "FormAssociated",
+   "module": "/src/shared/foundation/form-associated/form-associated"
   }
  ],
  "superclass": {
-  "name": "FormAssociatedSearchableSelect",
-  "module": "/libs/components/src/lib/searchable-select/searchable-select.form-associated"
+  "name": "VividElement",
+  "module": "/src/shared/foundation/vivid-element/vivid-element"
  },
  "vividComponent": {
   "public": true,
@@ -517,19 +1083,19 @@ Code in this file were generated using following JSON:
   "vueModels": [
    {
     "name": "modelValue",
-    "attributeName": "value",
+    "propName": "value",
     "eventNames": [
      "input"
     ],
-    "valueMapping": "(event.target as HTMLInputElement).value"
+    "valueMapping": "event.currentTarget.value"
    },
    {
     "name": "values",
-    "attributeName": "values",
+    "propName": "values",
     "eventNames": [
      "input"
     ],
-    "valueMapping": "(event.target as any).values"
+    "valueMapping": "event.currentTarget.values"
    }
   ]
  }
@@ -541,9 +1107,9 @@ import { registerSearchableSelect } from '@vonage/vivid'
 registerSearchableSelect('vvd3')
 
 const VwcSearchableSelect = wrapper(`vvd3-searchable-select`,  {
-    events: [{"name":"change","propName":"onChange"},{"name":"input","propName":"onInput"}],
+    events: [{"name":"change","propName":"onChange"},{"name":"search-text-change","propName":"onSearchTextChange"},{"name":"input","propName":"onInput"}],
     attributes: [],
-    properties: ['appearance', 'shape', 'fixedDropdown', 'placeholder', 'open', 'multiple', 'externalTags', 'maxLines', 'values', 'initialValues', 'selectedIndex', 'clearable', 'setFormValue', 'proxy']
+    properties: ['appearance', 'shape', 'fixedDropdown', 'placeholder', 'open', 'multiple', 'externalTags', 'maxLines', 'values', 'initialValues', 'selectedIndex', 'optionFilter', 'loading', 'clearable', 'maxSelected', 'setFormValue', 'helperText', 'errorText', 'validate', 'successText', 'label', '_vividAriaBehaviour', 'iconTrailing', 'icon', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'VIVID_VERSION', 'componentName']
 })
 
 VwcSearchableSelect.displayName = 'VwcSearchableSelect'