chore(docs): Gatsby script component #35647
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
tyhopp
added
the
type: documentation
gatsbot
bot
added
the
status: triage needed
tyhopp
added
status: blocked
This was referenced May 13, 2022
tyhopp
force-pushed
the
docs-script-component
branch
from
b118d3c to
4239079
Compare
Khaledgarbaya
previously requested changes
May 23, 2022
| <Script src="https://my-example-script" strategy="off-main-thread" /> | ||
| ``` | ||
|
|
||
| Additionally, Gatsby exports a `ScriptStrategy` enum that you can use in TSX files if you prefer: |
There was a problem hiding this comment.
Do we need to state the 2 approaches here? I would recommend showing only the ScriptStrategy as it is less error-prone but I don't have strong feelings about it
There was a problem hiding this comment.
JavaScript users will get code completion for string literals so I think it's useful to document both. It was also a point of feedback in the RFC
|
|
||
| #### Forward collection | ||
|
|
||
| Gatsby will collect all `off-main-thread` scripts on a page, and automatically merge any [Partytown forwarded events](https://partytown.builder.io/forwarding-events) defined via the `forward` property into a single configuration for each page: |
There was a problem hiding this comment.
should we be more explicit here and mention that this is only working on Gatsby Cloud?
There was a problem hiding this comment.
Forward collection happens during SSR in the build process, so this works on any hosting service since it's in the output HTML
pieh
reviewed
May 23, 2022
pieh
approved these changes
May 24, 2022
pieh
removed
the
status: blocked
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.
Description
Documentation for the Gatsby script component.
Documentation
Pages added:
Pages modified:
Related issues
[sc-48161]