beginHold

Starts a Suspense hold: the boundary keeps showing its current content while a transition waits for data. Holds are counted, and the running transitions stay pending (isPending of useTransition, the promise of startTransition) until every hold has ended. For renderers that implement Suspense; each call needs one endHold. Does nothing before the transition machinery exists (no transition has run).

Import#

import { beginHold } from "@shadow-js/core/extend";

Signature#

function beginHold(): void

Examples#

import { beginHold, endHold, wakeSuspended } from "@shadow-js/core/extend";

export function holdUntil(data: Promise<unknown>): void {
  beginHold(); // the boundary keeps its content
  void data.finally(() => {
    wakeSuspended();
    endHold();
  });
}