Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 2.74 KB

README.md

File metadata and controls

56 lines (37 loc) · 2.74 KB

proper-on-transition-end

NPM version Downloads Build Status Coverage Status Dependency status Dev Dependency status Greenkeeper badge

Cross-browser transitionend event listener.

This module is based on on-transition-end, which no longer seems to be maintained and is not working properly. Also, it automatically infers the timeout based on the transition duration.

Installation

$ npm install proper-on-transition-end

Usage

import onTransitionEnd from 'proper-on-transition-end';
// or
const onTransitionEnd = window.onTransitionEnd;

const cancelOnTransitionEnd = onTransitionEnd(element, [options,] callback)
  • element: The element that is transitioning.
  • options: You can pass a few options here:
    • timeout: This is automatically calculated for you, based on the longest transition of the element, using longest-transition. Still, you can override that and pass the timeout in milliseconds.
    • gracePeriod: There is an implicit grace period of 100 milliseconds before the event times out, but you can tweak it using this option.
  • callback: The callback that is called when the transition ends.

Calling cancelOnTransitionEnd will remove the listener and cleanup the timers.

Tests

$ npm test
$ npm test-cov to get coverage report

License

Released under the MIT License.