Skip to content

fix(md): let layouts read the page frontmatter with React, Solid and Svelte - #475

Merged
Brooooooklyn merged 1 commit into
mainfrom
fix/layout-frontmatter
Oct 18, 2026
Merged

Brooooooklyn merged 1 commit into
mainfrom
fix/layout-frontmatter

Conversation

@Brooooooklyn

Copy link
Copy Markdown
Member

Fixes #451.

useFrontmatter() in a layout that wraps a .md page returned {} with React, Solid and Svelte. The frontmatter was provided only inside the page component, below its layouts. Vue already provided it at the app root.

before:  Shared > Params > Errors > Layout > [Frontmatter > page]     layout sees {}
after:   Shared > Params > Errors > Frontmatter > Layout > page       layout sees the page's frontmatter
  • React and Solid: contexts match by identity. The adapter now owns FrontmatterContext (next to SharedContext), and the @void/md runtime re-exports it, so useFrontmatter() and the island renderer use the same context. The renderer does not import @void/md, so apps without it are unchanged.
  • Svelte: the island renderer passes the frontmatter to App.svelte, which sets the __void_frontmatter context above the layouts.
  • The page-level providers and the deprecated FrontmatterContext / setFrontmatter() exports of @void/md are unchanged.

Tests

  • One server-render test per adapter (packages/{react,solid,svelte}/test/integration/md-layout-frontmatter.test.ts): a layout prints useFrontmatter().title around index.md. On main it renders <p id="fm"></p>; with the fix, <p id="fm">Hello from frontmatter</p>.
  • Mutation checks: reverting any one adapter's renderer, or making the @void/md runtime create its own context again, fails that adapter's test.
  • Scratch apps for React, Solid, Svelte and Vue, in dev and in build + preview: root, nested and named layouts all show the page's frontmatter. Pages without frontmatter, plain pages and .island pages still render.
  • Unit tests for md and the four adapters, lint, format and typecheck for md, react, solid and svelte pass. The affected-test run passed except browser tests, which cannot launch Chromium on this machine.

Known limits (unchanged by this PR)

  • An island component that calls useFrontmatter() still gets {} in the browser, because islands hydrate without page context.

🤖 Generated with Claude Code

…Svelte

`useFrontmatter()` in a layout that wraps a `.md` page returned `{}`
with React, Solid and Svelte. The frontmatter was provided only inside
the page component, below its layouts.

The island renderer now provides the page's frontmatter above the
layout chain, as Vue already does. React and Solid match contexts by
identity, so the adapter owns `FrontmatterContext` and the `@void/md`
runtime re-exports it. Svelte sets the context in `App.svelte`.

Fixes #451

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-18T08:40:46.396704Z 8723e9c Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@Brooooooklyn

Copy link
Copy Markdown
Member Author

@codex review

@cloudflare-workers-and-pages

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://fix-layout-frontmatter-void-cloud.voidzero-docs.workers.dev (commit 8723e9c)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://61397dd8-void-cloud.voidzero-docs.workers.dev 8723e9c 2026-10-18T08:39:23.403Z Visit the dashboard ↗

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. More of your lovely PRs please.

Reviewed commit: 8723e9c254

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@Brooooooklyn
Brooooooklyn merged commit e868ec4 into main Oct 18, 2026
20 checks passed
@Brooooooklyn
Brooooooklyn deleted the fix/layout-frontmatter branch October 18, 2026 09:06
Brooooooklyn added a commit that referenced this pull request Oct 18, 2026
Follow-up to #475.

Since #475, an island on a Markdown page sees the page frontmatter
through `useFrontmatter()` during server rendering, but `{}` in the
browser. React, Svelte and Vue then report a hydration mismatch and
re-render the island with `{}`. Vue islands had the same gap before
#475.

```
server:   island renders useFrontmatter().title → "Hello"
browser:  island hydrates as its own root, no page context → {} → mismatch, shows "undefined"
```

## Behavior

`useFrontmatter()` now returns the page's frontmatter everywhere on a
Markdown page: layouts, the page, and islands, both on the server and in
the browser.

- A page that renders at least one island and has frontmatter includes
it once: `<script type="application/json" id="__void_frontmatter">`.
Pages without islands or without frontmatter send nothing new.
- `initIslands` reads it and passes it to each adapter's island
hydration, which provides it the same way the server does: React and
Solid `FrontmatterContext`, the Svelte `hydrate()` context, Vue
`provide`.
- React and Solid load `@void/react` / `@void/solid` for this only when
the page has frontmatter.
- The Markdown guide now says islands can read it, and that frontmatter
on pages with islands is visible in the HTML.

### Why send it, instead of giving islands `{}`

Astro, îles and Fresh islands get only their props. Here, though,
`useFrontmatter()` already works in layouts and pages. If islands
silently got `{}`, users would fall into the same trap as #451.
Frontmatter is already public through `@void/md/pages`, and the cost is
one small JSON script on pages with islands.

## Tests

- A browser test per adapter (`md-layout-frontmatter.test.ts` for React,
Solid and Svelte, and the new `md-island-frontmatter.test.ts` for Vue)
uses a shared helper, `test/island-page-browser.ts`. An island layout
loads an island that prints `useFrontmatter().title`. Each test checks
the JSON script is in the server HTML, then that the island still shows
the title after hydration with no hydration warning.
- Mutation checks: removing the browser-side provider for any one
adapter makes its test show `undefined`. Removing the server script
fails all four.
- The #475 layout tests now also check that a page without islands gets
no frontmatter script.
- `islandFrontmatterScript` escapes `</script>` inside frontmatter
values (`deferred-xss.test.ts`).
- Run locally against the installed Chrome, because the Playwright
Chromium download is blocked here. The existing `react-island-hydration`
test still passes. Unit tests for void, md and the four adapters, lint,
format and typecheck all pass.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

useFrontmatter() returns {} in layouts with the React adapter

1 participant