Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkay581/wait-for-element-transition
Easily wait for an element to CSS transition using native vanilla JavaScript
https://github.com/mkay581/wait-for-element-transition
css css-animation element-transition es6 polymer-element react-animation transition transition-animation transition-property transitionend wait web-animations web-animations-api
Last synced: 3 months ago
JSON representation
Easily wait for an element to CSS transition using native vanilla JavaScript
- Host: GitHub
- URL: https://github.com/mkay581/wait-for-element-transition
- Owner: markcellus
- License: mit
- Created: 2017-07-04T15:09:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-04T21:54:29.000Z (over 1 year ago)
- Last Synced: 2024-04-10T11:15:39.504Z (7 months ago)
- Topics: css, css-animation, element-transition, es6, polymer-element, react-animation, transition, transition-animation, transition-property, transitionend, wait, web-animations, web-animations-api
- Language: TypeScript
- Homepage:
- Size: 1.39 MB
- Stars: 19
- Watchers: 0
- Forks: 1
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/markcellus/wait-for-element-transition)
[](https://badge.fury.io/js/wait-for-element-transition)
# waitForElementTransition()
Let's say you have the problem (that many of us have) where you need to wait for the completion of your element's
[CSS transition](https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/Using_CSS_transitions)
before your code continues. You can use this library and call a `waitForElementTransition` method to wait until
the element finishes its css transition before doing other things in your javascript code.
## Benefits
- Easily wait for an element's css transition to end using JavaScript
- Allows you to keep your transition/animation css properties separate from your JS
- Native javascript with no dependencies
- Safer and more reliable than `transitionstart` and `transitionend` events
- Plays nicely with the latest specifications
## Installation
You can either use the dist file directly in your project:
```html
```
Or install via npm
```bash
npm i wait-for-element-transition
```
and import
```javascript
import waitForElementTransition from 'wait-for-element-transition';
```
## Usage
Here's an example where we want to wait for an element's background color to change from black to red.
```html
div {
background-color: black;
transition-property: background-color;
transition-duration: 100ms;
transition-timing-function: ease-out;
}
.red {
background-color: red;
}
Transition this element
const element = document.querySelector('div');
element.classList.add('red'); // start transition
waitForElementTransition(element).then(() => {
// 100 milliseconds later...
console.log('element background color changed to red!');
});
```
If the element has already transitioned before the `waitForElementTransition()` is called, the `waitForElementTransition()`s
promise will resolve immediately. So you can always guarantee that your code will run, just as it would synchronously.
## Alternatives
### The `transitionend` event
Using the `transitionend` or `animationend` events on an Element will allow you to wait until an Element's transition
has ended, but this approach is limited:
1. The events don't fire in the case where a transition is removed before completion (i.e. display is set to "none" or if
the css property is removed) and
1. The events don't fire when there are no css transition properties specified, which doesn't allow us to run the
same animation-completion logic on elements which may or may not be animated.
### Web Animations API
If done in a supported browser, the same thing in this package can be achieved using the [Web Animations API](https://drafts.csswg.org/web-animations-1/). But consumers of this package may want a less-complex approach.
## Development
Watch source files while developing:
```bash
npm start
```
Run test
```bash
npm test
```