pauseOwner
Pauses owner and everything below it (Activity hidden).
Pauses owner and everything below it (Activity hidden). User effects run their cleanups and wait.
DOM bindings (render effects) wait without a cleanup, so their nodes stay as they are. Memos keep their
last value, and effects created below are parked until the owner resumes. Pauses nest: each
pauseOwner needs one resumeOwner. Use it to hide a subtree while keeping its state.
Import#
ts
import { pauseOwner } from "@shadow-js/core/extend";
Signature#
ts
function pauseOwner(owner: Owner): void
Parameters#
| Name | Description |
|---|---|
owner |
The owner to pause, with its whole subtree. |
Examples#
ts
import { createOwner, pauseOwner, resumeOwner } from "@shadow-js/core/extend";
const hidden = createOwner(null);
pauseOwner(hidden); // its effects stop; its memos keep their values
resumeOwner(hidden); // its user effects run again with the latest values