Element: transitioncancel event
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2015.
The transitioncancel
event is fired when a CSS transition is canceled.
Syntax
Use the event name in methods like addEventListener()
, or set an event handler property.
addEventListener("transitioncancel", (event) => {});
ontransitioncancel = (event) => {};
Event type
A TransitionEvent
. Inherits from Event
.
Event properties
Also inherits properties from its parent Event
.
TransitionEvent.propertyName
Read only-
A string containing the name CSS property associated with the transition.
TransitionEvent.elapsedTime
Read only-
A
float
giving the amount of time the transition has been running, in seconds, when this event fired. This value is not affected by thetransition-delay
property. TransitionEvent.pseudoElement
Read only-
A string, starting with
::
, containing the name of the pseudo-element the animation runs on. If the transition doesn't run on a pseudo-element but on the element, an empty string:''
.
Examples
This code gets an element that has a transition defined and adds a listener to the transitioncancel
event:
const transition = document.querySelector(".transition");
transition.addEventListener("transitioncancel", () => {
console.log("Transition canceled");
});
The same, but using the ontransitioncancel
property instead of addEventListener()
:
const transition = document.querySelector(".transition");
transition.ontransitioncancel = () => {
console.log("Transition canceled");
};
Live example
In the following example, we have a simple <div>
element, styled with a transition that includes a delay:
<div class="transition"></div>
<div class="message"></div>
.transition {
width: 100px;
height: 100px;
background: rgb(255 0 0 / 100%);
transition-property: transform, background;
transition-duration: 2s;
transition-delay: 2s;
}
.transition:hover {
transform: rotate(90deg);
background: rgb(255 0 0 / 0%);
}
To this, we'll add some JavaScript to indicate that the transitionstart
, transitionrun
, transitioncancel
, and transitionend
events fire. In this example, to cancel the transition, stop hovering over the transitioning box before the transition ends. For the transition end event to fire, stay hovered over the transition until the transition ends.
const message = document.querySelector(".message");
const el = document.querySelector(".transition");
el.addEventListener("transitionrun", () => {
message.textContent = "transitionrun fired";
});
el.addEventListener("transitionstart", () => {
message.textContent = "transitionstart fired";
});
el.addEventListener("transitioncancel", () => {
message.textContent = "transitioncancel fired";
});
el.addEventListener("transitionend", () => {
message.textContent = "transitionend fired";
});
The transitioncancel
event is fired if the transition is cancelled in either direction after the transitionrun
event occurs and before the transitionend
is fired.
If there is no transition delay or duration, if both are 0s or neither is declared, there is no transition, and none of the transition events are fired.
If the transitioncancel
event is fired, the transitionend
event will not fire.
Specifications
Specification |
---|
CSS Transitions # transitioncancel |
CSS Transitions # dom-globaleventhandlers-ontransitioncancel |
Browser compatibility
BCD tables only load in the browser
See also
- The
TransitionEvent
interface - CSS properties:
transition
,transition-delay
,transition-duration
,transition-property
,transition-timing-function
- Related events:
transitionrun
,transitionstart
,transitionend