RadioButtonGroup

A RadioButtonGroup offers a single selection out of a logical group of radio buttons. Selecting one cancels the others. RadioButtonGroup is similar to a DropdownField except that it exposes all choices in the UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary.

Note: To align an element with other fields in an InspectorA Unity window that displays information about the currently selected GameObject, asset or project settings, allowing you to inspect and edit the values. More info
See in Glossary window, simply apply the .unity-base-field__aligned USS class to it. For more information, refer to BaseField.

Create a RadioButtonGroup

You can create a RadioButtonGroup with UI Builder, UXML, or C#.

UI BUilder

In UI Builder, you can add options to a RadioButtonGroup by entering the choices you want separated by commas in the Choices field located within the Inspector panel of the RadioButtonGroup.

To set the default value, in the Inspector of the RadioButtonGroup, enter the numbering sequence of the option in Value, starting at 0.

C#

The following C# example creates a new RadioButtonGroup with four options and registers to its value changed callback:

var radiogroup = new RadioButtonGroup("Options", new List<string> { "Option 1", "Option 2", "Option 3", "Option 4" });
radiogroup.RegisterValueChangedCallback(evt => Debug.Log(evt.newValue));
window.rootVisualElement.Add(radiogroup);

Examples

The following UXML example creates a RadioButtonGroup:

<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
    <RadioButtonGroup label="UXML Field" name="the-uxml-field" />
</UXML>

The following C# example illustrates some of the customizable functionalities of the RadioButtonGroup:

/// <sample>
// You can provide the list of choices by code, or by comma separated values in UXML
// <DropdownField .... choices="Option 1,Option 2,Option 3" .... />
var choices = new List<string> { "Option 1", "Option 2", "Option 3" };

// Get a reference to the radio button group field from UXML and assign a value to it.
var uxmlField = container.Q<RadioButtonGroup>("the-uxml-field");
uxmlField.choices = choices;
uxmlField.value = 0;

// Create a new field, disable it, and give it a style class.
var csharpField = new RadioButtonGroup("C# Field", choices);
csharpField.value = 0;
csharpField.SetEnabled(false);
csharpField.AddToClassList("some-styled-field");
csharpField.value = uxmlField.value;
container.Add(csharpField);

// Mirror the value of the UXML field into the C# field.
uxmlField.RegisterCallback<ChangeEvent<int>>((evt) =>
{
    csharpField.value = evt.newValue;
});
/// </sample>

To try this example live in Unity, go to Window > UI Toolkit > Samples.

C# class and namespace

C# class: RadioButtonGroup
Namespace: UnityEngine.UIElements
Base class: BaseField_1

Member UXML attributes

This element has the following member attributes:

Inherited UXML attributes

This element inherits the following attributes from its base class:

This element also inherits the following attributes from VisualElement:

USS classes

The following table lists all the C# public property names and their related USS selector.

You can also use the Matching Selectors section in the Inspector or the UI Toolkit Debugger to see which USS selectors affect the components of the VisualElement at every level of its hierarchy.

Additional resources

• RadioButton