-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enable SSR #148
Open
smoores-dev
wants to merge
11
commits into
main
Choose a base branch
from
ssr
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Enable SSR #148
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
Also this is not a very big PR, I just thought I needed to update yarn to add a prelease version bump, buuut I think I didn't so I can pull that out into a separate PR. But that's why the diff count is so huge |
This was referenced Dec 18, 2024
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.
I'm not 100% sure about this one. It's... got some hacks. Here's the idea:
A really cool use case for React ProseMirror is rich text editors that can share components between the editor and their reader-facing interface. One very simple way to implement this is to just render your ProseMirror document with React ProseMirror in your reader interface, with editable set to false.
I think this is awesome, and folks like dskrpt.de and moment.dev are already doing this (see https://moment.dev/blog for an example!). It allows dskrpt to easily track the ProseMirror positions for highlights created by readers, for example, so they can be mapped through changes.
One significant disadvantage to this approach, though, is that you can't currently render the
<ProseMirror>
component on the server, because it creates a DOM element in its render function. Even if we got rid of that behavior, it would SSR to an empty document, because the initial construction of the EditorView happens in a layout effect, which doesn't run in SSR.So this PR moves the initial EditorView creation into the render function of the ProseMirror component. In order to do this, we have to construct the EditorView without a mount initially, which ProseMirror handles by creating an empty div. To work around the EditorView constructor accessing
window
anddocument
, we introduce some super dumb stubs for window and document that we set before callingsuper
and then clean up (if we're in SSR).The result is pretty cool -- you can render your ProseMirror document to HTML completely on the server. The only thing we defer is non-React node views, since those use Portals which only work on the client.