@base-ui-components/react/esm/utils/useAnimationsFinished.js

Base UI is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.

'use client';

import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { useEventCallback } from './useEventCallback.js';

/**
 * Executes a function once all animations have finished on the provided element.
 * @ignore - internal hook.
 */
export function useAnimationsFinished(ref) {
  const frameRef = React.useRef(-1);
  const cancelFrames = useEventCallback(() => {
    cancelAnimationFrame(frameRef.current);
  });
  React.useEffect(() => cancelFrames, [cancelFrames]);
  return useEventCallback(fnToExecute => {
    cancelFrames();
    const element = ref.current;
    if (!element) {
      return;
    }
    if (typeof element.getAnimations !== 'function' || globalThis.BASE_UI_ANIMATIONS_DISABLED) {
      fnToExecute();
    } else {
      frameRef.current = requestAnimationFrame(() => {
        Promise.allSettled(element.getAnimations().map(anim => anim.finished)).then(() => {
          // Synchronously flush the unmounting of the component so that the browser doesn't
          // paint: https://github.com/mui/base-ui/issues/979
          ReactDOM.flushSync(fnToExecute);
        });
      });
    }
  });
}