SuspenseListProps
Props of SuspenseList.
Props of SuspenseList.
Import#
ts
import type { SuspenseListProps } from "@shadow-js/web";
Signature#
ts
interface SuspenseListProps {
/**
* `"forwards"`: boundaries reveal in order, each after the ones before it. `"backwards"`: the
* same from the last one. `"together"`: all at once, when the last one is ready. Without it each
* boundary reveals on its own. Read reactively.
* @default undefined (each boundary reveals as soon as its own data is ready)
*/
readonly revealOrder?: "forwards" | "backwards" | "together" | undefined;
/**
* What the boundaries that are still waiting show: `"collapsed"` only the next fallback in
* order, `"hidden"` none. Applies to `forwards` and `backwards`; the default shows every fallback.
* @default undefined (every waiting boundary shows its fallback)
*/
readonly tail?: "collapsed" | "hidden" | undefined;
/**
* The content, with the `<Suspense>` boundaries to coordinate anywhere below it.
* @default undefined (renders nothing)
*/
readonly children?: unknown;
}
Members#
| Name | Type | Description |
|---|---|---|
revealOrder? |
readonly revealOrder?: "forwards" | "backwards" | "together" | undefined |
"forwards": boundaries reveal in order, each after the ones before it. "backwards": the same from the last one. "together": all at once, when the last one is ready. Without it each boundary reveals on its own. Read reactively. |
tail? |
readonly tail?: "collapsed" | "hidden" | undefined |
What the boundaries that are still waiting show: "collapsed" only the next fallback in order, "hidden" none. Applies to forwards and backwards; the default shows every fallback. |
children? |
readonly children?: unknown |
The content, with the <Suspense> boundaries to coordinate anywhere below it. |