Use SSR-compatible slot implementation in PageLayout #3036
Merged
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: 5dcc159 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
size-limit report 📦
|
colebemis
requested review from
joshblack and
siddharthkp
and removed request for
josepmartins
joshblack
approved these changes
Mar 15, 2023
colebemis
had a problem deploying
to
github-pages
GitHub Actions
Failure
|
Hi! Just leaving it here in case we need it: In case this change isn't backward compatible with instances of PageLayout in gh/gh, we can unblock this team by putting this in drafts/experimental first. |
Merged
10 tasks
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.
Problem
PageLayout.HeaderandPageLayout.Footerdon't render server-side because PageLayout uses an SSR-incompatible approach to implement its slots API (issue).Screen.Recording.2023-03-14.at.2.58.43.PM.mov
Notice that the layout shifts because the header appears after the page loads.
Slack discussion for context
Solution
This PR updates PageLayout to use an SSR-compatible slots implementation.
Tradeoff
In this new implementation,
PageLayout.HeaderandPageLayout.Footermust be direct children ofPageLayout. This feels like a reasonable tradeoff becausePageLayout.HeaderandPageLayout.Footeraren't used often, and when they are used, they're almost always a direct child ofPageLayout.PageLayout.Headerin 3 places. In 2 of 3 usages,PageLayout.Headeris a direct child ofPageLayout. In the 3rd case,PageLayout.Headercan easily be refactored to be direct child ofPageLayout.PageLayout.Footer.Merge checklist
Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.