Module: Radio

A radio input component.

Parameters:

Name Type Description

props

object

Component props.

Properties

Name	Type	Description
`children`	JSX.Element	React element children.
`customAttributes`	object	Custom attributes for the component.
`customClasses`	string \| Array \| object	Custom classes for the component.
`disabled`	boolean	If radio is disabled.
`externalChecked`	boolean	If radio is checked or not, can change current checked state if changed.
`externalControl`	boolean	If radio can be controlled externally.
`helpTextAttributes`	object	Custom attribute for the help text.
`id`	string	Optional id. Auto generated if not passed.
`initialChecked`	boolean	Is it checked on render?
`labelAttributes`	object	Any custom attributes for the label.
`name`	string	The name attribute for the radio.
`onBlur`	function	On blur function handler.
`onChange`	function	On change function handler.
`onFocus`	function	On focus function handler.
`size`	string	The radio size: small (`size-sm`) or medium (`size-md`).
`spacing`	string \| number \| Array \| object	The spacing for the component, as a string, number, array, or object.
`theme`	string	The theme of the radio.
`type`	string	The radio type. 'standard' or 'image'.
`value`	string	The radio value.
`wrapperAttributes`	object	Custom attributes for the wrapper element.
`wrapperClasses`	string \| Array \| object	Custom classes for the wrapper element.
`wrapperTagName`	object	Tag to use for the radio wrapper. Defaults to `div`.

ref

object | null

Ref to the component.

Since: 1.1.15
Source: elements/Radio/index.js, line 9

Returns:

The radio component.

Type:: JSX.Element

Example

import Radio from '@gravityforms/components/react/admin/elements/Radio';

return <Radio id="radio-id" name="radio-name" onChange={ () => {} } value="radio-value" />;