@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
86 lines (85 loc) • 5.15 kB
TypeScript
import React, { ReactNode, SyntheticEvent } from 'react';
/** VwcSelect
* For more info on this Vivid element please visit https://vivid.deno.dev/components/select
* @param {boolean | undefined} disabled **attribute** `disabled`
* @param {string | undefined} errorText **attribute** `error-text`
* @param {string | undefined} helperText **attribute** `helper-text`
* @param {string | undefined} icon **attribute** `icon`
* @param {boolean | undefined} iconTrailing **attribute** `icon-trailing`
* @param {string | undefined} initialValue **attribute** `value`
* @param {string | undefined} label **attribute** `label`
* @param {string | undefined} name **attribute** `name`
* @param {boolean | undefined} required **attribute** `required`
* @param {string | undefined} successText **attribute** `success-text`
* @param {string | undefined} value **attribute** `current-value`
* @param {boolean} multiple - Indicates if the listbox is in multi-selection mode. **attribute** `multiple`
* @param {boolean} open - The open attribute. **attribute** `open`
* @param {SelectSize | undefined} scale - The size the select should have. **attribute** `scale`
* @param {SelectAppearance | undefined} appearance - The appearance attribute. **attribute** `appearance`
* @param {SelectShape | undefined} shape - The shape attribute. **attribute** `shape`
* @param {boolean} fixedDropdown - The fixed-dropdown attribute. **attribute** `fixed-dropdown`
* @param {string | undefined} placeholder - The placeholder attribute. **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 validate
* @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 {'host'} _vividAriaBehaviour
* @param {boolean} iconTrailing - Indicates the icon affix alignment. **attribute** `icon-trailing`
* @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 {ListboxOption[]} options - The list of options.
* @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 VwcSelect: {
(props: {
children?: ReactNode;
slot?: string | undefined;
id?: string | undefined;
style?: React.CSSProperties | undefined;
ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
onInput?: ((event: SyntheticEvent) => void) | undefined;
onChange?: ((event: SyntheticEvent) => void) | undefined;
disabled?: any;
errorText?: string | undefined;
helperText?: string | undefined;
icon?: string | undefined;
iconTrailing?: any;
initialValue?: string | undefined;
label?: string | undefined;
name?: string | undefined;
required?: any;
successText?: string | undefined;
value?: string | undefined;
multiple?: boolean | undefined;
open?: boolean | undefined;
scale?: any;
appearance?: any;
shape?: any;
fixedDropdown?: boolean | undefined;
placeholder?: string | undefined;
validate?: any;
_vividAriaBehaviour?: any;
currentValue?: any;
options?: any[] | undefined;
selectedIndex?: number | undefined;
selectedOptions?: any[] | undefined;
slottedOptionFilter?: any;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcSelect;