@vonage/vivid-react/v3/VwcCombobox/index.d.ts

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

import React, { ReactNode, SyntheticEvent } from 'react';
/** VwcCombobox
* For more info on this Vivid element please visit https://vivid.deno.dev/components/combobox
* @param {ComboboxAutocomplete | undefined} autocomplete - The autocomplete attribute. **attribute** `autocomplete`
* @param {ListboxOption[]} filteredOptions - The collection of currently filtered options.
* @param {ComboboxAppearance | undefined} appearance - The appearance attribute. **attribute** `appearance`
* @param {ComboboxShape | undefined} shape - The shape attribute. **attribute** `shape`
* @param {ComboboxSize | undefined} scale - The size the combobox should have. **attribute** `scale`
* @param {PopupPlacement | undefined} placement - the placement of the combobox

HTML Attribute: string **attribute** `placement`
* @param {boolean} fixedDropdown - Whether the dropdown is using a fixed positioning strategy. **attribute** `fixed-dropdown`
* @param {Popup} _popup
* @param {HTMLElement} _anchor
* @param {boolean} open - The open attribute. **attribute** `open`
* @param {ListboxOption[]} options - The list of options.
* @param {string} placeholder - Sets the placeholder value of the element, generally used to provide a hint to the user. **attribute** `placeholder`
* @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 {string | undefined} successText - Provides a custom success message. Any current error state will be overridden. **attribute** `success-text`
* @param {string | undefined} label - The label for the form element. **attribute** `label`
* @param {string | undefined} icon - A decorative icon the custom element should have. **attribute** `icon`
* @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 {number} selectedIndex - The index of the selected option.
* @param {ListboxOption[]} selectedOptions - A collection of the selected options.
* @param  slottedOptionFilter - A static filter to include only selectable options.
* @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 VwcCombobox: {
    (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;
        autocomplete?: any;
        filteredOptions?: any[] | undefined;
        appearance?: any;
        shape?: any;
        scale?: any;
        placement?: any;
        fixedDropdown?: boolean | undefined;
        _popup?: any;
        _anchor?: any;
        open?: boolean | undefined;
        options?: any[] | undefined;
        placeholder?: string | undefined;
        helperText?: string | undefined;
        errorText?: string | undefined;
        successText?: string | undefined;
        label?: string | undefined;
        icon?: string | undefined;
        value?: string | undefined;
        currentValue?: any;
        initialValue?: string | undefined;
        disabled?: boolean | undefined;
        name?: string | undefined;
        required?: boolean | undefined;
        selectedIndex?: number | undefined;
        selectedOptions?: any[] | undefined;
        slottedOptionFilter?: any;
        VIVID_VERSION?: string | undefined;
        componentName?: string | undefined;
    }): JSX.Element;
    displayName: string;
};
export default VwcCombobox;