Toggle

A Toggle includes an image and a label. Just like other standard UI Toolkit controls, such as a Button, a Toggle has a Clickable manipulator attached to it that registers to MouseUpEvent and PointerUpEvent. When one of those events triggers the manipulator, the Toggle’s value changes from true to false or from false to true. You can read or set the current values of a Toggle. You can also bind a Toggle to a Boolean variable.

You can display or hide elements based on other conditions, such as a selection from a drop-down, or an enabled option. An example of a conditional UI is the Unity CameraA component which creates an image of a particular viewpoint in your scene. The output is either drawn to the screen or captured as a texture. More info
See in Glossary 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. It displays additional options when you activate Physical Camera mode.

Note: To align an element with other fields in an Inspector window, simply apply the .unity-base-field__aligned USS class to it. For more information, refer to BaseField.

Create a Toggle

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

The following C# example creates a Toggle with a specific label:

Toggle myToggle = new Toggle("Click me");

Style a Toggle

By default, a Toggle control appears as a checkbox. You can apply styles to make it look like a typical toggle switch.

To style the checkbox of a toggle, use the .unity-toggle__input and .unity-toggle__checkmark style properties. For example, if you have applied a class named className to the Toggle. The following USS changes the background images of the checkbox when you select or clear the toggle:

/* Set the background image when the checkbox is selected. */
.className:checked > .unity-toggle__input > .unity-toggle__checkmark {
    background-image: url("path/to/image-file");
}

/* Set the background image When the checkbox is not selected. */
.className > .unity-toggle__input > .unity-toggle__checkmark {
    background-image: url("path/to/image-file"); 
}

Examples

The following UXML example creates a Toggle:

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

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

/// <sample>
// Get a reference to the field from UXML and assign a value to it.
var uxmlField = container.Q<Toggle>("the-uxml-field");
uxmlField.value = true;

// Create a new field, disable it, and give it a style class.
var csharpField = new Toggle("C# Field");
csharpField.value = false;
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<bool>>((evt) =>
{
    csharpField.value = evt.newValue;
});
/// </sample>

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

For more examples, refer to the following:

• Create a conditional UI.

C# base class and namespace

C# class: Toggle
Namespace: UnityEngine.UIElements
Base class: BaseBoolField

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

• Foldout
• Pseudo-classes