Focus events occur when an element gains or loses focus.
Focus events are useful when you need to change focus to and away from visual elementsA 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. Controls often use focus events to change their contents, depending on the focus state. For example, a text field can display placeholder text while it isn’t in focus, or it can react to the FocusInEvent
to clear the placeholder text.
Focus can change on a visual element from user interactions, such as tabbing or clicking, or using C# scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary with element.Focus()
.
Focus events separate into two distinct types:
FocusOutEvent
and FocusInEvent
are sent along the propagation path just before a focus change occurs.FocusEvent
and BlurEvent
are sent to the event target, immediately after the change in focus.The base class for all focus events is FocusEventBase.
Event | Description | Trickles down | Bubbles up | Cancellable |
---|---|---|---|---|
FocusOutEvent | Sent before an element loses focus. | ✔ | ✔ | |
FocusInEvent | Sent before an element gains focus. | ✔ | ✔ | |
BlurEvent | Sent after an element has lost focus. | ✔ | ||
FocusEvent | Sent after an element has gained focus. | ✔ |
The following section explains relevant properties unique to focus events. This isn’t a complete list of all properties within the focus event family. For a full list, see the FocusEventBase in the API documentation.
relatedTarget
: Contains the visual element that’s the secondary target of an event. For FocusOut
and Blur
events, it contains the element that gains focus. For FocusIn
and Focus
events, it contains the element that loses focus.
Event | target | relatedTarget |
---|---|---|
Blur | The element that loses focus. | The element that gains focus. |
Focus | The element that gains focus. | The element that loses focus. |
focusIn | The element that gains focus. | The element that loses focus. |
focusOut | The element that loses focus. | The element that gains focus. |
The FocusOutEvent
is sent when an element is about to lose focus.
target
: The element that will lose focus.
relatedTarget
: The element that will gain focus.
The FocusInEvent
is sent when an element is about to gain focus.
target
: The element that will gain focus.
relatedTarget
: The element that will lose focus.
The BlurEvent
is sent after an element lost focus.
target
: The element that lost focus.
relatedTarget
: The element that gained focus.
The FocusEvent
is sent after an element gained focus.
target
: The element that gained focus.
relatedTarget
: The element that lost focus.
The following example shows how to use placeholder text in a TextField.
After you create the elements through UXML, the script assigns a placeholder text to the TextField. When the TextField is in focus, FocusInEvent
fires and clears the placeholder text. FocusOutEvent
toggles the placeholder mode based on the TextField contents.
To see the example in action, do the following:
using UnityEditor; using UnityEngine; using UnityEngine.UIElements; public class PlaceHolderExample : EditorWindow { [MenuItem("Window/UI Toolkit/PlaceHolderExample")] public static void ShowExample() { PlaceHolderExample wnd = GetWindow<PlaceHolderExample>(); wnd.titleContent = new GUIContent("PlaceHolderExample"); } private bool placeHolderMode = true; private const string placeHolderText = "Write here"; public void CreateGUI() { TextField textField = new TextField(); textField.value = placeHolderText; rootVisualElement.Add(textField); textField.RegisterCallback<FocusInEvent>(OnFocusInTextField); textField.RegisterCallback<FocusOutEvent>(OnFocusOutTextField); } private void OnFocusInTextField(FocusInEvent evt) { // If the text field just received focus and the user might want to write // or edit the text inside, the placeholder text should be cleared (if active) if (placeHolderMode) { var textField = evt.target as TextField; if (textField != null) { textField.value = ""; } } } private void OnFocusOutTextField(FocusOutEvent evt) { // If the text field is empty after the user is done editing and the // element lost focus, write placeholder text into the text field var textField = evt.target as TextField; if (textField != null) { placeHolderMode = string.IsNullOrEmpty(textField.value); if (placeHolderMode) textField.value = placeHolderText; } } }
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.