Version: 2023.2+
This example demonstrates how to create a “switch-like” variation of a toggle.
The example creates a custom control: a toggle that users can flip with the mouse, the keyboard, a gamepad, and other devices. It comes with a label that can describe what the toggle represents.
You can find the completed files that this example creates in this GitHub repository.
This guide is for developers familiar with the Unity Editor, UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary Toolkit, and C# scripting. Before you start, get familiar with the following:
Create the slide toggle class with a C# script.
slide-toggle
to store your files.slide-toggle
folder, create a C# script named SlideToggle.cs
.SlideToggle.cs
in a text editor and replace its content with the following:using UnityEngine; using UnityEngine.UIElements; namespace MyUILibrary { // Derives from BaseField<bool> base class. Represents a container for its input part. [UxmlElement] public partial class SlideToggle : BaseField<bool> { // In the spirit of the BEM standard, the SlideToggle has its own block class and two element classes. It also // has a class that represents the enabled state of the toggle. public static readonly new string ussClassName = "slide-toggle"; public static readonly new string inputUssClassName = "slide-toggle__input"; public static readonly string inputKnobUssClassName = "slide-toggle__input-knob"; public static readonly string inputCheckedUssClassName = "slide-toggle__input--checked"; VisualElement m_Input; VisualElement m_Knob; // Custom controls need a default constructor. This default constructor calls the other constructor in this // class. public SlideToggle() : this(null) { } // This constructor allows users to set the contents of the label. public SlideToggle(string label) : base(label, null) { // Style the control overall. AddToClassList(ussClassName); // Get the BaseField's visual input element and use it as the background of the slide. m_Input = this.Q(className: BaseField<bool>.inputUssClassName); m_Input.AddToClassList(inputUssClassName); // Create a "knob" child element for the background to represent the actual slide of the toggle. m_Knob = new(); m_Knob.AddToClassList(inputKnobUssClassName); m_Input.Add(m_Knob); // There are three main ways to activate or deactivate the SlideToggle. All three event handlers use the // static function pattern described in the Custom control best practices. // ClickEvent fires when a sequence of pointer down and pointer up actions occurs. RegisterCallback<ClickEvent>(evt => OnClick(evt)); // KeydownEvent fires when the field has focus and a user presses a key. RegisterCallback<KeyDownEvent>(evt => OnKeydownEvent(evt)); // NavigationSubmitEvent detects input from keyboards, gamepads, or other devices at runtime. RegisterCallback<NavigationSubmitEvent>(evt => OnSubmit(evt)); } static void OnClick(ClickEvent evt) { var slideToggle = evt.currentTarget as SlideToggle; slideToggle.ToggleValue(); evt.StopPropagation(); } static void OnSubmit(NavigationSubmitEvent evt) { var slideToggle = evt.currentTarget as SlideToggle; slideToggle.ToggleValue(); evt.StopPropagation(); } static void OnKeydownEvent(KeyDownEvent evt) { var slideToggle = evt.currentTarget as SlideToggle; // NavigationSubmitEvent event already covers keydown events at runtime, so this method shouldn't handle // them. if (slideToggle.panel?.contextType == ContextType.Player) return; // Toggle the value only when the user presses Enter, Return, or Space. if (evt.keyCode == KeyCode.KeypadEnter || evt.keyCode == KeyCode.Return || evt.keyCode == KeyCode.Space) { slideToggle.ToggleValue(); evt.StopPropagation(); } } // All three callbacks call this method. void ToggleValue() { value = !value; } // Because ToggleValue() sets the value property, the BaseField class dispatches a ChangeEvent. This results in a // call to SetValueWithoutNotify(). This example uses it to style the toggle based on whether it's currently // enabled. public override void SetValueWithoutNotify(bool newValue) { base.SetValueWithoutNotify(newValue); //This line of code styles the input element to look enabled or disabled. m_Input.EnableInClassList(inputCheckedUssClassName, newValue); } } }
Style the slide toggle with a USS file.
slide-toggle
folder, create a USS file named SlideToggle.uss
.SlideToggle.uss
in a text editor and replace its contents with the following:.slide-toggle__input { background-color: var(--unity-colors-slider_groove-background); max-width: 25px; border-top-left-radius: 8px; border-bottom-left-radius: 8px; border-top-right-radius: 8px; border-bottom-right-radius: 8px; overflow: visible; border-left-width: 1px; border-right-width: 1px; border-top-width: 1px; border-bottom-width: 1px; border-right-color: var(--unity-colors-slider_thumb-border); border-top-color: var(--unity-colors-slider_thumb-border); border-bottom-color: var(--unity-colors-slider_thumb-border); max-height: 16px; margin-top: 10px; border-left-color: var(--unity-colors-slider_thumb-border); transition-property: background-color; transition-duration: 0.5s; } .slide-toggle__input-knob { height: 16px; width: 16px; background-color: var(--unity-colors-slider_thumb-background); position: absolute; border-top-left-radius: 25px; border-bottom-left-radius: 25px; border-top-right-radius: 25px; border-bottom-right-radius: 25px; top: -1px; transition-property: translate, background-color; transition-duration: 0.5s, 0.5s; translate: -1px 0; border-left-width: 1px; border-right-width: 1px; border-top-width: 1px; border-bottom-width: 1px; border-left-color: var(--unity-colors-slider_thumb-border); border-right-color: var(--unity-colors-slider_thumb-border); border-top-color: var(--unity-colors-slider_thumb-border); border-bottom-color: var(--unity-colors-slider_thumb-border); } .slide-toggle__input--checked { background-color: rgb(0, 156, 10); } .slide-toggle__input--checked > .slide-toggle__input-knob { translate: 8px 0; } .slide-toggle:focus .slide-toggle__input-knob { border-left-width: 1px; border-right-width: 1px; border-top-width: 1px; border-bottom-width: 1px; border-left-color: var(--unity-colors-input_field-border-focus); border-right-color: var(--unity-colors-input_field-border-focus); border-top-color: var(--unity-colors-input_field-border-focus); border-bottom-color: var(--unity-colors-input_field-border-focus); }
slide-toggle
folder, create a UI Document file named SlideToggleUsage.uxml
.SlideToggleUsage.uxml
in the UI Builder.SlideToggle.uss
as the existing USS.SlideToggleUsage.uxml
into the Source Asset field in the Inspector.Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.