Repository navigation
fix(md): give islands the page frontmatter when they hydrate - #476
Merged
Merged
Conversation
Since #475, an island on a Markdown page saw the page frontmatter through `useFrontmatter()` during server rendering but `{}` in the browser, so frameworks reported a hydration mismatch and re-rendered it. A page that renders islands now includes its frontmatter once as a JSON script. `initIslands` reads it and passes it to each adapter's island hydration, which provides it the same way the server renderer does (React and Solid context, Svelte hydrate context, Vue provide). Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Member
Author
|
@codex review |
🚀 Deploying Preview to Cloudflare 🚀Preview URL: https://fix-island-frontmatter-void-cloud.voidzero-docs.workers.dev (commit 2bc7aa8)This URL reflects your latest Preview deploymentPreview Deployments by commit
|
|
Codex Review: Didn't find any major issues. You're on a roll. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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". |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.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.<script type="application/json" id="__void_frontmatter">. Pages without islands or without frontmatter send nothing new.initIslandsreads it and passes it to each adapter's island hydration, which provides it the same way the server does: React and SolidFrontmatterContext, the Sveltehydrate()context, Vueprovide.@void/react/@void/solidfor this only when the page has frontmatter.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
md-layout-frontmatter.test.tsfor React, Solid and Svelte, and the newmd-island-frontmatter.test.tsfor Vue) uses a shared helper,test/island-page-browser.ts. An island layout loads an island that printsuseFrontmatter().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.undefined. Removing the server script fails all four.islandFrontmatterScriptescapes</script>inside frontmatter values (deferred-xss.test.ts).react-island-hydrationtest still passes. Unit tests for void, md and the four adapters, lint, format and typecheck all pass.🤖 Generated with Claude Code