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

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

import React, { ReactNode, SyntheticEvent } from 'react';
/** VwcNumberField
* For more info on this Vivid element please visit https://vivid.deno.dev/components/number-field
* @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 {boolean} autofocus - Indicates that this element should get focus after the page finishes loading. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefautofocus | autofocus HTML attribute for more information. **attribute** `autofocus`
* @param {string} placeholder - Sets the placeholder value of the element, generally used to provide a hint to the user. **attribute** `placeholder`
* @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 {number} size - Sets the width of the element to a specified number of characters. **attribute** `size`
* @param {NumberFieldSize | undefined} scale - The size the number-field should have. **attribute** `scale`
* @param {number} step - Amount to increment or decrement the value by **attribute** `step`
* @param {number} max - The maximum the value can be **attribute** `max`
* @param {number} min - The minimum the value can be **attribute** `min`
* @param {number} valueAsNumber - The value property, typed as a number.
* @param {| string
        | null} incrementButtonAriaLabel  **attribute** `increment-button-aria-label`
* @param {| string
        | null} decrementButtonAriaLabel  **attribute** `decrement-button-aria-label`
* @param {NumberFieldAppearance | undefined} appearance  **attribute** `appearance`
* @param {NumberFieldShape | undefined} shape  **attribute** `shape`
* @param {string | undefined} autoComplete  **attribute** `autoComplete`
* @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 {'delegate'} _vividAriaBehaviour
* @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 {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 VwcNumberField: {
    (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;
        readOnly?: boolean | undefined;
        autofocus?: boolean | undefined;
        placeholder?: string | undefined;
        list?: string | undefined;
        maxlength?: number | undefined;
        minlength?: number | undefined;
        size?: number | undefined;
        scale?: any;
        step?: number | undefined;
        max?: number | undefined;
        min?: number | undefined;
        valueAsNumber?: number | undefined;
        incrementButtonAriaLabel?: any;
        decrementButtonAriaLabel?: any;
        appearance?: any;
        shape?: any;
        autoComplete?: string | undefined;
        helperText?: string | undefined;
        errorText?: string | undefined;
        successText?: string | undefined;
        label?: string | undefined;
        icon?: string | undefined;
        _vividAriaBehaviour?: any;
        value?: string | undefined;
        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 VwcNumberField;