Re-add Partytown custom configuration to Script component documentation
#68946
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
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
|
@guisehn Let's wrap the new section with |
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.
What?
Add documentation about Partytown configuration on the
Scriptdocumentation page.Why?
The
Scriptcomponent with thestrategyprop set toworkeruses Partytown under the hood.Users may need to customize Partytown options such as
forward,loadScriptsOnMainThread, andresolveUrl, to allow for third party scripts such as Segment and Google Tag Manager to work properly.This used to be documented on
docs/basic-features/script.md, as you can see on the pull request that originally introduced theworkerstrategy, but this doc page was removed (potentially unintendedly) on #50701, and there's no longer mention of Partytown configuration in Next.js docs.How?
Adding back the documentation text originally written by @housseindjirdeh in his pull request #34244
Fixes #68943