Input Radio (Deprecated)

ui:inputRadio

Deprecated as of API version 47.0. We recommend migrating to Lightning Web Components and using the lightning-input component. For radio groups, use lightning-radio-group.

For Use In

Lightning Experience, Experience Builder Sites, Salesforce Mobile App, Lightning Out (Beta), Standalone Lightning App

Deprecation Guidelines

We recommend using Lightning Web Components whenever possible. When migrating to Lightning Web Components, use lightning-input with radio type. For radio groups, use lightning-radio-group.

For more information, see Aura Components in the ui Namespace Are Deprecated.

Usage Overview (Deprecated)

A ui:inputRadio component represents a radio button whose state is controlled by the value and disabled attributes. It’s rendered as an HTML input tag of type radio. To apply Lightning Design System styling, we recommend that you use lightning:radioGroup instead of ui:inputRadio.

To group your radio buttons together, specify the name attribute with a unique name.

This is a basic set up of a radio button.

1<ui:inputRadio label="Yes" />

This example results in the following HTML.

1<div class="uiInput uiInputRadio uiInput--default uiInput--radio">
2  <label class="uiLabel-left form-element__label uiLabel">
3    <span>Yes</span>
4  </label>
5
6  <input type="radio" />
7</div>

To create forms for Salesforce objects without using Apex controllers, use lightning:inputField with lightning:recordEditForm, or use lightning:recordForm. To create an input field for different data types, use lightning:input.

Note

Attributes

Name	Description	Type	Default
body	The body of the component. In markup, this is everything in the body of the tag.	Aura.Component[]
class	A CSS style to be attached to the component. This style is added in addition to base styles output by the component.	String
class	A CSS style to be attached to the component. This style is added in addition to base styles output by the component.	String
disabled	Specifies whether the component should be displayed in a disabled state. Default value is "false".	Boolean	false
disabled	Specifies whether the component should be displayed in a disabled state. Default value is "false".	Boolean	false
errors	The list of errors to be displayed.	Object[]
label	The text displayed on the component.	String
label	The text of the label component	String
labelClass	The CSS class of the label component	String
name	The name of the component.	String
required	Specifies whether the input is required. Default value is "false".	Boolean	false
requiredIndicatorClass	The CSS class of the required indicator component	String
text	The input value attribute.	String
updateOn	Updates the component's value binding if the updateOn attribute is set to the handled event. Default value is "change".	String	change
value	Indicates whether the status of the option is selected. Default value is “false”.	Boolean	false
value	The value currently in the input field.	String

Input Radio (Deprecated)

Deprecation Guidelines

Usage Overview (Deprecated)

Attributes

Lightning Component Reference

Contents