feat: return clientEntrypoint from getContainerRenderer
#14715
Merged
+48
−59
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.
Changes
Adds
clientEntrypointto the object returned bygetContainerRenderer()in framework integrations. This makes the return value anAstroRenderer, so this also deprecates theContainerRenderertype in favour of that. In several integrations there is already agetRendererfunction that returns this, but this isn't standardised, and some need arguments. This PR tries to wrap or re-export these where appropriate.It seems we were already specifying
AstroRendereras the type passed toloadRenderers, so this doesn't need changing.The reason to do this is to support client hydration in
getContainerRenderer(). The objects returned from these can be used with theloadRenderershelper in a Vite environment, instead of needing users to manually load the correct renderer entrypoints. Previously this didn't return the client entrypoint value, so it required users to manually callcontainer.addClientRenderer()with the appropriate client renderer entrypoint to support hydration.Testing
Our tests don't use Vitest so we can't test this directly. Instead, I added this to
examples/container-with-vitestand tested that.Docs
The docs don't currently state that client-side hydration is unsupported when using
getContainerRenderer, so this doesn't need changing.