@mui/internal-docs-infra/useCoordinated/useSettleGate.mjs

MUI Infra - internal documentation creation tools.

'use client';

import * as React from 'react';
import { pageSettleGate } from "./pageSettleGate.mjs";

/**
 * Register the calling component as a source on a settle gate and release it
 * once `settled` is `true`. Generalizes `useCoordinatedLazy`: registration
 * happens on mount and the release is idempotent, so a component that unmounts
 * before settling can't hold the gate open. Defaults to the page-global
 * {@link pageSettleGate}; pass `null` to opt out of registration entirely (used
 * when a swap conditionally registers with a controller gate that may be
 * absent).
 */
export function useSettleGate(settled, gate = pageSettleGate) {
  const settleRef = React.useRef(null);
  React.useEffect(() => {
    if (!gate) {
      return undefined;
    }
    settleRef.current = gate.register();
    return () => {
      // Idempotent - doubles as a release when the component unmounts before it
      // ever settled, so it can't hold the gate open for the rest of the page.
      settleRef.current?.();
      settleRef.current = null;
    };
  }, [gate]);
  React.useEffect(() => {
    if (settled) {
      settleRef.current?.();
    }
  }, [settled]);
}