-
Notifications
You must be signed in to change notification settings - Fork 26.1k
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
Expands next/script
documentation
#31063
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
8f0e14b
updates script optimization doc and includes api reference page for n…
housseindjirdeh 371e270
formatting changes
housseindjirdeh 1f82a87
updates per review comments
housseindjirdeh 1e029a2
Merge branch 'canary' into update-script-docs
leerob 8f28601
Merge branch 'canary' into update-script-docs
kodiakhq[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
description: Optimize loading of third-party scripts with the built-in Script component. | ||
--- | ||
|
||
# next/script | ||
|
||
<details> | ||
<summary><b>Examples</b></summary> | ||
<ul> | ||
<li><a href="https://github.com/vercel/next.js/tree/canary/examples/with-google-tag-manager">Google Tag Manager</a></li> | ||
<li><a href="https://github.com/vercel/next.js/tree/canary/examples/with-google-analytics">Google Analytics</a></li> | ||
<li><a href="https://github.com/vercel/next.js/tree/canary/examples/with-facebook-pixel">Facebook Pixel</a></li> | ||
<li><a href="https://github.com/vercel/next.js/tree/canary/examples/with-clerk">Clerk</a></li> | ||
<li><a href="https://github.com/vercel/next.js/tree/canary/examples/with-segment-analytics">Segment Analytics</a></li> | ||
</ul> | ||
</details> | ||
|
||
<details> | ||
<summary><b>Version History</b></summary> | ||
|
||
| Version | Changes | | ||
| --------- | ------------------------- | | ||
| `v11.0.0` | `next/script` introduced. | | ||
|
||
</details> | ||
|
||
> **Note: This is API documentation for the Script Component. For a feature overview and usage information for scripts in Next.js, please see [Script Optimization](/docs/basic-features/script.md).** | ||
|
||
## Optional Props | ||
|
||
### src | ||
|
||
A path string specifying the URL of an external script. This can be either an absolute external URL or an internal path. | ||
|
||
### strategy | ||
|
||
The loading strategy of the script. | ||
|
||
| `strategy` | **Description** | | ||
| ------------------- | ---------------------------------------------------------- | | ||
| `beforeInteractive` | Load script before the page becomes interactive | | ||
| `afterInteractive` | Load script immediately after the page becomes interactive | | ||
| `lazyOnload` | Load script during browser idle time | | ||
|
||
### onLoad | ||
|
||
A method that returns additional JavaScript that should be executed after the script has finished loading. | ||
|
||
The following is an example of how to use the `onLoad` property: | ||
|
||
```jsx | ||
import { useState } from 'react' | ||
import Script from 'next/script' | ||
|
||
export default function Home() { | ||
const [stripe, setStripe] = useState(null) | ||
|
||
return ( | ||
<> | ||
<Script | ||
id="stripe-js" | ||
src="https://js.stripe.com/v3/" | ||
onLoad={() => { | ||
setStripe({ stripe: window.Stripe('pk_test_12345') }) | ||
}} | ||
/> | ||
</> | ||
) | ||
} | ||
``` |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, thanks for the clearer documentation! Had a question about this removed text. Was the Script component always able to be placed inside of
next/head
or_document.js
? Or was this achieved via a change to the Script component in a recent release?