Transition events inform you of the changes in a transition’s state.
UI Toolkit uses transitions when a VisualElement
’s style property is modified. Changes to VisualElement
property are immediately reflected visually. However, you can use the transition
USS property to interpolate between the initial and end results gradually.
A transition’s lifecycle has the following stages:
A VisualElement
’s property is modified when you:
element.ToggleInClassList()
(where element
is any VisualElement
).:hover
.style
property. For example: element.style.backgroundColor = Color.red;
(where element
is any VisualElement
).A TransitionRunEvent
is sent.
If the resolved transition-delay
property for the changing property has a value other than 0
, nothing happens for the duration of the delay.
After the delay, a TransitionStartEvent
is sent, and the transition starts with the property at its initial value.
For the length of time set by transition-duration
, the transition occurs. During that time, the property goes from its initial to its final value.
If the property is changed to a new value during the transition, TransitionCancelEvent
is sent. The transition process restarts at step 2.
After the transition-duration
elapses, the property sets to its final value. A TransitionEndEvent
is sent.
The following table describes the transition events and their propagation phases:
Event | Description | Trickles down | Bubbles up | Cancellable |
---|---|---|---|---|
TransitionRunEvent | Sent when a transition is created. | Yes | ||
TransitionStartEvent | Sent when a transition’s delay phase ends and the transition starts. | Yes | ||
TransitionEndEvent | Sent when a transition ends. | Yes | ||
TransitionCancelEvent | Sent when an a transition is canceled. | Yes |
Each transition property has its own lifecycle and its own transition events. You can access the current property with an event’s stylePropertyNames
property.
If a shorthand USS property is changed, every component also gets its own lifecycle. For example, if you change margin
, margin-left
, margin-right
, margin-top
and margin-bottom
, they all get their own TransitionRunEvent
, TransitionStartEvent
and TransitionEndEvent
, for a total of 12 separate events.
If you set transition-delay
to 0
, the TransitionRunEvent
and TransitionStartEvent
are sent one after the other within a few milliseconds.
If you set transition-delay
to a value below 0
, the transition won’t start at the beginning. For example, with a transition-delay
of -3
seconds and transition-duration
of 5
seconds, the TransitionRunEvent
and TransitionStartEvent
is sent with an elapsedTime
property set to 3
seconds and the transition effectively starts at the third second of a five-second animation.
This section describes the target
, stylePropertyNames
, and elapsedTime
of each transition event.
A TransitionRunEvent
event is sent when a transition is created.
target
: The element that executes the transition.stylePropertyNames
: The list of properties modified by the transition.elapsedTime
: The time since the start of the transition.A TransitionStartEvent
event is sent when the transition’s delay phase ends and the transition begins.
target
: The element that executes the transition.stylePropertyNames
: The list of properties modified by the transition.elapsedTime
: The time since the start of the transition.A TransitionEndEvent
event is sent when a transition ends.
target
: The element that executes the transition.stylePropertyNames
: The list of properties modified by the transition.elapsedTime
: The time since the start of the transition.A TransitionCancelEvent
event is sent when a transition is interrupted by the property being changed again.
target
: The element that executes the transition.stylePropertyNames
: The list of properties modified by the transition.elapsedTime
: The time since the start of the transition.TransitionEndEvent
to create transitions that loop.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.