UXML element Toggle

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

Inherited 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 visual elementA node of a visual tree that instantiates or derives from the C# VisualElement class. You can style the look, define the behaviour, and display it on screen as part of the UI. More info
See in Glossary at every level of its hierarchy.

Create a Toggle

A Toggle includes an image and a label. Just like other standard UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary 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.

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

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 Inspector. It displays additional options when you activate Physical Camera mode.

Respond to user actions

A Toggle responds to Change events.

Examples

​To see a simple Toggle example, in Unity, select Window > UI Toolkit > Samples > Toggle.

The following example uses a Toggle to create a conditional UI. The example creates a custom Editor window with two toggles. You can use the toggles to do the following:

• Show or hide a label
• Activate or deactivate a button

You can find the completed files that this example creates in this GitHub repository.

To create the example:

1. Create a Unity project with any template.

2. In the Project windowA window that shows the contents of your Assets folder (Project tab) More info
   See in Glossary, create a folder named Editor.

3. In the Editor folder, create a C# script file named ToggleExample with the following content:

   using UnityEngine;
   using UnityEditor;
   using UnityEngine.UIElements;
   namespace Samples.Editor.Controls
   {
       public class ToggleExample : EditorWindow
       {
           private Toggle showToggle;
           private Toggle activateToggle;
           private Label labelToShow;
           private Button buttonToActivate;
           [MenuItem("Window/ToggleExample")]
           public static void OpenWindow()
           {
               var window = GetWindow<ToggleExample>("Controls: Toggle Sample");
               window.minSize = new Vector2(200, 170);
               EditorGUIUtility.PingObject(MonoScript.FromScriptableObject(window));
           }
           public void OnEnable()
           {
               showToggle = new Toggle("Show label")
               {
                   value = true
               };
               activateToggle = new Toggle("Active button")
               {
                   value = true
               };
               labelToShow = new Label("This label is shown when the above toggle is set to On");
               buttonToActivate = new Button(() => Debug.Log("Button pressed!"))
               {
                   text = "Active if above toggle is On"
               };
               rootVisualElement.Add(showToggle);
               rootVisualElement.Add(labelToShow);
               rootVisualElement.Add(activateToggle);
               rootVisualElement.Add(buttonToActivate);
               showToggle.RegisterValueChangedCallback(evt => labelToShow.visible = evt.newValue);
               activateToggle.RegisterValueChangedCallback(evt => buttonToActivate.SetEnabled(evt.newValue));
           }
       }
   }
   

4. To try the example, from the menu, select Window > ToggleExample.

Additional resources

• Create a slide toggle custom control
• UXML element Foldout