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

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

import React, { ReactNode, SyntheticEvent } from 'react';
/** VwcTextArea
* For more info on this Vivid element please visit https://vivid.deno.dev/components/text-area
* @param {boolean} readOnly - When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly | readonly HTML attribute for more information. **attribute** `readOnly`
* @param {TextAreaResize} resize - The resize mode of the element. **attribute** `resize`
* @param {boolean} autofocus - Indicates that this element should get focus after the page finishes loading. **attribute** `autofocus`
* @param {string} formId - The https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id | id of the https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form | form the element is associated to **attribute** `form`
* @param {string} list - Allows associating a https://developer.mozilla.org/en-US/docs/Web/HTML/Element/datalist | datalist to the element by https://developer.mozilla.org/en-US/docs/Web/API/Element/id. **attribute** `list`
* @param {number} maxlength - The maximum number of characters a user can enter. **attribute** `maxlength`
* @param {number} minlength - The minimum number of characters a user can enter. **attribute** `minlength`
* @param {string} placeholder - Sets the placeholder value of the element, generally used to provide a hint to the user. **attribute** `placeholder`
* @param {number} cols - Sizes the element horizontally by a number of character columns. **attribute** `cols`
* @param {number} rows - Sizes the element vertically by a number of character rows. **attribute** `rows`
* @param {boolean} spellcheck - Sets if the element is eligible for spell checking
but the UA. **attribute** `spellcheck`
* @param {TextAreaWrap | undefined} wrap - The wrap attribute **attribute** `wrap`
* @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} value - The current value of the element. **attribute** `current-value`
* @param {boolean} charCount - Use in combination with `maxlength` to display a character count. **attribute** `char-count`
* @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 {'delegate'} _vividAriaBehaviour
* @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 VwcTextArea: {
    (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;
        onInput?: ((event: SyntheticEvent) => void) | undefined;
        readOnly?: boolean | undefined;
        resize?: any;
        autofocus?: boolean | undefined;
        formId?: string | undefined;
        list?: string | undefined;
        maxlength?: number | undefined;
        minlength?: number | undefined;
        placeholder?: string | undefined;
        cols?: number | undefined;
        rows?: number | undefined;
        spellcheck?: boolean | undefined;
        wrap?: any;
        helperText?: string | undefined;
        value?: string | undefined;
        charCount?: boolean | undefined;
        errorText?: string | undefined;
        successText?: string | undefined;
        label?: string | undefined;
        _vividAriaBehaviour?: any;
        currentValue?: any;
        initialValue?: string | undefined;
        disabled?: boolean | undefined;
        name?: string | undefined;
        required?: boolean | undefined;
        VIVID_VERSION?: string | undefined;
        componentName?: string | undefined;
    }): JSX.Element;
    displayName: string;
};
export default VwcTextArea;