-
Notifications
You must be signed in to change notification settings - Fork 26.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'canary' into webpack/upgrade
- Loading branch information
Showing
92 changed files
with
1,351 additions
and
589 deletions.
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
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
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
Oops, something went wrong.