[2.0 rc.14] Docs: what a pending <Loading> subtree computes, commits and runs, so a view can be preloaded by rendering it
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- Medio día
- Aptitud para principiantes
- 32/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- typescript
- Área
- documentation
Línea de trabajo
The request is about the boundaries documentation page, which the issue says covers only when <Loading> shows its fallback. Start by reading that page, then run the issue's reproduction (the gated and plain buttons) to confirm the three behaviours: children keep computing, a pending boundary never commits or runs effects, and a never-settling promise memo keeps it pending. Done means the page either documents those three points as supported with the preloading case as an example, or states which are not guaranteed. The maintainers need to decide which, so check with them before writing the text.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Summary
A view's data can be preloaded without listing what it reads: render it into a detached element inside a <Loading> held pending by a promise that never settles. Every read in its tree then starts, level by level as data arrives, while nothing is committed and no effect runs. This works on rc.14, but the docs don't describe any of the behaviour it depends on, so it may change without notice. This asks for that behaviour to be documented as supported, or for the docs to say it isn't.
Reproduction
A page with a list and one detail per row. run(true) renders it into a detached element behind a never-settling gate; run(false) renders the same tree without the gate, as a control.
import { render } from "@solidjs/web";
import {
createEffect,
createMemo,
For,
getOwner,
Loading,
onSettled,
runWithOwner,
} from "solid-js";
const t0 = performance.now();
const log: string[] = [];
const stamp = (entry: string) => log.push(`${Math.round(performance.now() - t0)}ms ${entry}`);
const delay = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
async function load<T>(name: string, value: T) {
stamp(`load ${name}`);
await delay(100);
return value;
}
function Detail(props: { id: string }) {
const detail = createMemo(() => load(`detail:${props.id}`, `detail ${props.id}`));
return <p ref={() => stamp(`element detail:${props.id}`)}>{detail()}</p>;
}
function Page() {
const list = createMemo(() => load("list", ["a", "b"]));
createEffect(
() => list(),
() => {
stamp("effect ran");
},
);
onSettled(() => {
stamp("onSettled ran");
});
return (
<ul ref={() => stamp("element list")}>
<For each={list()}>
{(id) => (
<li>
<Detail id={id} />
</li>
)}
</For>
</ul>
);
}
function run(gated: boolean) {
log.length = 0;
const host = document.createElement("div");
const dispose = runWithOwner(owner, () =>
render(() => {
const gate = createMemo(() => new Promise<never>(() => {}));
return (
<Loading fallback={null}>
{gated ? gate() : null}
<Page />
</Loading>
);
}, host),
);
setTimeout(() => {
console.log(log, host.innerHTML);
dispose();
}, 600);
}
let owner: ReturnType<typeof getOwner> = null;
export default function App() {
owner = getOwner();
return (
<main>
<h1>preview</h1>
<button type="button" onClick={() => run(true)}>
gated
</button>
<button type="button" onClick={() => run(false)}>
plain
</button>
</main>
);
}
Measured in headless Chromium under vite dev (times from run()):
| Loads started | Elements created (ref ran) |
Committed to the host | createEffect / onSettled |
Console | |
|---|---|---|---|---|---|
| gated | list at 0 ms, detail:a/detail:b at 103 ms |
ul, both p |
no (host empty) | never ran | nothing |
| plain | list at 0 ms, detail:a/detail:b at 105 ms |
ul, both p |
yes | ran at 208 ms | nothing |
What is undocumented
The boundaries page describes only when a <Loading> shows its fallback. The pattern above depends on three things it doesn't say:
- The children of a pending
<Loading>keep computing, and reads discovered as data arrives start too. - A pending boundary never commits its children or runs their effects (
createEffect,onSettled), however long it stays pending. - A memo whose value is a promise that never settles is an acceptable way to keep a boundary pending, without a diagnostic now or later.
Request
Document these three points as supported behaviour, for example on the boundaries page with this preloading use as the example, or say which of them is not guaranteed.
A primitive that does the same without building the DOM is requested in #3975.
(submitted by Claude Opus 5.5 on behalf of rvlzzr)
- Lenguaje dominante
- TypeScript
- Estrellas
- 36.1k
- Forks
- 1.1k
- Merge medio
- 9 h 56 min
- PR fusionados (30 d)
- 336
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de solidjs/solid
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 12/100
solidjs/solid#3975 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 3/5 1-2 días Aptitud para principiantes 52/100
Los mantenedores suelen responder en 1 día
-
hydrate() run mid-parse leaves dead server nodes beside fresh client copies (async entry script)Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 20/100
Los mantenedores suelen responder en 1 día
Todos los issues de solidjs/solid
Issues similares
-
enhancement
Dificultad 1/5 Menos de una hora Aptitud para principiantes 80/100
alunduil/projects-v2-sync#21 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
-
enhancement minor
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
testcontainers/testcontainers-node#1539 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
christopher-buss/eslint-plugin-flawless#72 ·
Los mantenedores suelen responder en 1 día
-
cleanName keeps a state code that's joined to the word before it (SavannahGa → "Savannah Ga")Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
openwatersio/slackwater-database#281 ·
Los mantenedores suelen responder en 1 día