Unverified Commit ca41952d authored by Houssein Djirdeh's avatar Houssein Djirdeh Committed by GitHub

Expands `next/script` documentation (#31063)

This PR does the following to partially address #31062:

- Expands the [Script Component](https://nextjs.org/docs/basic-features/script) page in the core documentation
- Adds a `next/script` API reference page
parent bc888316
---
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 diff is collapsed.
...@@ -288,6 +288,10 @@ ...@@ -288,6 +288,10 @@
"title": "next/image", "title": "next/image",
"path": "/docs/api-reference/next/image.md" "path": "/docs/api-reference/next/image.md"
}, },
{
"title": "next/script",
"path": "/docs/api-reference/next/script.md"
},
{ {
"title": "next/head", "title": "next/head",
"path": "/docs/api-reference/next/head.md" "path": "/docs/api-reference/next/head.md"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment