@vonage/vivid-react/v3/VwcCombobox/index.js

Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings

/*
* DO NOT EDIT THIS FILE. IT IS GENERATED
*/
/*
Code in this file were generated using following JSON:
{
 "kind": "class",
 "description": "",
 "name": "Combobox",
 "slots": [
  {
   "description": "Default slot.",
   "name": ""
  },
  {
   "description": "The preferred way to add an icon to the combobox control.",
   "name": "icon"
  },
  {
   "description": "Slot to add meta content to the combobox control.",
   "name": "meta"
  },
  {
   "description": "Describes how to use the combobox. Alternative to the `helper-text` attribute.",
   "name": "helper-text"
  }
 ],
 "members": [
  {
   "kind": "field",
   "name": "autocomplete",
   "type": {
    "text": "ComboboxAutocomplete | undefined"
   },
   "description": "The autocomplete attribute.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "filteredOptions",
   "type": {
    "text": "ListboxOption[]"
   },
   "default": "[]",
   "description": "The collection of currently filtered options.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "appearance",
   "type": {
    "text": "ComboboxAppearance | undefined"
   },
   "description": "The appearance attribute.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "shape",
   "type": {
    "text": "ComboboxShape | undefined"
   },
   "description": "The shape attribute.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "scale",
   "type": {
    "text": "ComboboxSize | undefined"
   },
   "description": "The size the combobox should have.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "placement",
   "type": {
    "text": "PopupPlacement | undefined"
   },
   "description": "the placement of the combobox\n\nHTML Attribute: string"
  },
  {
   "kind": "field",
   "name": "fixedDropdown",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "Whether the dropdown is using a fixed positioning strategy.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "_popup",
   "type": {
    "text": "Popup"
   }
  },
  {
   "kind": "field",
   "name": "_anchor",
   "type": {
    "text": "HTMLElement"
   }
  },
  {
   "kind": "method",
   "name": "validate",
   "return": {
    "type": {
     "text": "void"
    }
   },
   "description": "{@inheritDoc (FormAssociated:interface).validate}",
   "inheritedFrom": {
    "name": "WithErrorText",
    "module": "src/shared/patterns/form-elements/with-error-text.ts"
   }
  },
  {
   "kind": "field",
   "name": "isAutocompleteInline",
   "type": {
    "text": "boolean"
   },
   "privacy": "private",
   "readonly": true
  },
  {
   "kind": "field",
   "name": "isAutocompleteList",
   "type": {
    "text": "boolean"
   },
   "privacy": "private",
   "readonly": true
  },
  {
   "kind": "field",
   "name": "isAutocompleteBoth",
   "type": {
    "text": "boolean"
   },
   "privacy": "private",
   "readonly": true
  },
  {
   "kind": "field",
   "name": "open",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "The open attribute.",
   "privacy": "public"
  },
  {
   "kind": "field",
   "name": "options",
   "type": {
    "text": "ListboxOption[]"
   },
   "description": "The list of options.",
   "privacy": "public",
   "inheritedFrom": {
    "name": "Listbox",
    "module": "src/shared/foundation/listbox/listbox.ts"
   }
  },
  {
   "kind": "field",
   "name": "placeholder",
   "type": {
    "text": "string"
   },
   "description": "Sets the placeholder value of the element, generally used to provide a hint to the user.",
   "privacy": "public"
  },
  {
   "kind": "method",
   "name": "filterOptions",
   "return": {
    "type": {
     "text": "void"
    }
   },
   "description": "Filter available options by text value.",
   "privacy": "public"
  },
  {
   "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": "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": "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": "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"
   },
   "description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
   "privacy": "public",
   "default": "false",
   "inheritedFrom": {
    "name": "Listbox",
    "module": "src/shared/foundation/listbox/listbox.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": "length",
   "type": {
    "text": "number"
   },
   "description": "The number of options.",
   "privacy": "public",
   "readonly": true,
   "inheritedFrom": {
    "name": "Listbox",
    "module": "src/shared/foundation/listbox/listbox.ts"
   }
  },
  {
   "kind": "field",
   "name": "selectedIndex",
   "type": {
    "text": "number"
   },
   "default": "-1",
   "description": "The index of the selected option.",
   "privacy": "public",
   "inheritedFrom": {
    "name": "Listbox",
    "module": "src/shared/foundation/listbox/listbox.ts"
   }
  },
  {
   "kind": "field",
   "name": "selectedOptions",
   "type": {
    "text": "ListboxOption[]"
   },
   "default": "[]",
   "description": "A collection of the selected options.",
   "privacy": "public",
   "inheritedFrom": {
    "name": "Listbox",
    "module": "src/shared/foundation/listbox/listbox.ts"
   }
  },
  {
   "kind": "field",
   "name": "slottedOptionFilter",
   "static": true,
   "description": "A static filter to include only selectable options.",
   "parameters": [
    {
     "description": "element to filter",
     "name": "n"
    }
   ],
   "privacy": "public",
   "inheritedFrom": {
    "name": "Listbox",
    "module": "src/shared/foundation/listbox/listbox.ts"
   }
  },
  {
   "kind": "method",
   "name": "selectFirstOption",
   "return": {
    "type": {
     "text": "void"
    }
   },
   "description": "Moves focus to the first selectable option.",
   "privacy": "public",
   "inheritedFrom": {
    "name": "Listbox",
    "module": "src/shared/foundation/listbox/listbox.ts"
   }
  },
  {
   "kind": "method",
   "name": "setSelectedOptions",
   "privacy": "public",
   "description": "Sets an option as selected and gives it focus.",
   "inheritedFrom": {
    "name": "Listbox",
    "module": "src/shared/foundation/listbox/listbox.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 a custom 'change' event when the value updates",
   "name": "change"
  }
 ],
 "attributes": [
  {
   "name": "autocomplete",
   "type": {
    "text": "ComboboxAutocomplete | undefined"
   },
   "description": "The autocomplete attribute.",
   "fieldName": "autocomplete"
  },
  {
   "name": "appearance",
   "type": {
    "text": "ComboboxAppearance | undefined"
   },
   "description": "The appearance attribute.",
   "fieldName": "appearance"
  },
  {
   "name": "shape",
   "type": {
    "text": "ComboboxShape | undefined"
   },
   "description": "The shape attribute.",
   "fieldName": "shape"
  },
  {
   "name": "scale",
   "type": {
    "text": "ComboboxSize | undefined"
   },
   "description": "The size the combobox should have.",
   "fieldName": "scale"
  },
  {
   "name": "placement",
   "type": {
    "text": "PopupPlacement | undefined"
   },
   "description": "the placement of the combobox\n\nHTML Attribute: string",
   "fieldName": "placement"
  },
  {
   "name": "fixed-dropdown",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "Whether the dropdown is using a fixed positioning strategy.",
   "fieldName": "fixedDropdown"
  },
  {
   "name": "open",
   "type": {
    "text": "boolean"
   },
   "default": "false",
   "description": "The open attribute.",
   "fieldName": "open"
  },
  {
   "name": "placeholder",
   "type": {
    "text": "string"
   },
   "description": "Sets the placeholder value of the element, generally used to provide a hint to the user.",
   "fieldName": "placeholder"
  },
  {
   "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",
   "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"
   },
   "description": "Sets the element's disabled state. A disabled element will not be included during form submission.",
   "fieldName": "disabled",
   "default": "false",
   "inheritedFrom": {
    "name": "Listbox",
    "module": "src/shared/foundation/listbox/listbox.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": "AffixIcon",
   "module": "/src/shared/patterns"
  },
  {
   "name": "FormAssociated",
   "module": "/src/shared/foundation/form-associated/form-associated"
  }
 ],
 "superclass": {
  "name": "Listbox",
  "module": "/src/shared/foundation/listbox/listbox"
 },
 "vividComponent": {
  "public": true,
  "name": "combobox",
  "vueModels": [
   {
    "name": "modelValue",
    "propName": "value",
    "eventNames": [
     "change"
    ],
    "valueMapping": "event.currentTarget.value"
   }
  ]
 }
}
*/
import wrapper from '@vonage/vivid-react-wrapper'
import { registerCombobox } from '@vonage/vivid'

registerCombobox('vvd3')

const VwcCombobox = wrapper(`vvd3-combobox`,  {
    events: [{"name":"change","propName":"onChange"}],
    attributes: [],
    properties: ['autocomplete', 'filteredOptions', 'appearance', 'shape', 'scale', 'placement', 'fixedDropdown', '_popup', '_anchor', 'open', 'options', 'placeholder', 'helperText', 'errorText', 'successText', 'label', 'icon', 'value', 'currentValue', 'initialValue', 'disabled', 'name', 'required', 'selectedIndex', 'selectedOptions', 'slottedOptionFilter', 'VIVID_VERSION', 'componentName']
})

VwcCombobox.displayName = 'VwcCombobox'

export default VwcCombobox