@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
42 lines (41 loc) • 2.47 kB
TypeScript
import React, { ReactNode, SyntheticEvent } from 'react';
/** VwcRadioGroup
* For more info on this Vivid element please visit https://vivid.deno.dev/components/radio-group
* @param {string} label - The label for the radio group **attribute** `label`
* @param {boolean} required - When true, the radio group and all its radio buttons will be required **attribute** `required`
* @param {boolean} readOnly - When true, the child radios 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} disabled - Disables the radio group and child radios. **attribute** `disabled`
* @param {string} name - The name of the radio group. Setting this value will set the name value
for all child radio elements. **attribute** `name`
* @param {string} value - The value of the checked radio **attribute** `value`
* @param {string} errorText **attribute** `error-text`
* @param {Orientation | 'horizontal' | 'vertical'} orientation - The orientation of the group **attribute** `orientation`
* @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} 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 VwcRadioGroup: {
(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;
label?: string | undefined;
required?: boolean | undefined;
readOnly?: boolean | undefined;
disabled?: boolean | undefined;
name?: string | undefined;
value?: string | undefined;
errorText?: string | undefined;
orientation?: any;
helperText?: string | undefined;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcRadioGroup;