The VWO SmartCode Next.js package enables seamless integration of VWO SmartCode into Next.js applications. This component is designed to work with both Page Router and App Router, allowing developers to integrate VWO SmartCode efficiently.
Install the package using npm or yarn:
# via npm
npm install vwo-smartcode-nextjs
# via yarn
yarn add vwo-smartcode-nextjsFor applications using the Page Router, add the VWOScript component inside _document.js (or _document.tsx if using TypeScript) to include it in the <head> of your HTML document.
// pages/_document.js
import Document, { Html, Head, Main, NextScript } from 'next/document';
import { VWOScript } from 'vwo-smartcode-nextjs';
class MyDocument extends Document {
render() {
return (
<Html>
<Head>
<VWOScript accountId="YOUR_ACCOUNT_ID" />
</Head>
<body>
<Main />
<NextScript />
</body>
</Html>
);
}
}
export default MyDocument;For applications using the App Router, include the VWOScript component in layout.tsx to ensure it loads correctly within the <head> of your HTML document.
// app/layout.tsx
import { VWOScript } from 'vwo-smartcode-nextjs';
export default function RootLayout({ children }: { children: React.ReactNode }) {
return (
<html lang="en">
<head>
<VWOScript accountId="YOUR_ACCOUNT_ID" />
</head>
<body>{children}</body>
</html>
);
}To add a nonce attribute for Content Security Policy:
<VWOScript
accountId="YOUR_ACCOUNT_ID"
scriptAttributes={{
nonce: 'your-nonce-value',
}}
/>The VWOScript component accepts the following props:
| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
accountId |
string |
✅ Yes | null |
Your VWO account ID |
version |
2.2 | 3.0 |
No | 2.2 |
SmartCode version to load |
type |
'ASYNC' | 'SYNC' |
No | 'ASYNC' for version 2.2, 'SYNC' for version 3.0 |
Type of VWO script loading |
settingsTimeout |
number |
No | 2000 |
Timeout for settings initialization |
hideElement |
string |
No | 'body' |
CSS selector for the element to be hidden |
hideElementStyle |
string |
No | 'opacity:0 !important;filter:alpha(opacity=0) !important;background:white !important;transition:none !important;' |
CSS styles applied to the hidden element |
backgroundColor |
string |
No | 'white' |
Background color used when hiding body element |
scriptAttributes |
Record<string, string> |
No | {} |
Additional attributes to be added to the script tag. Note: id will be overridden and referrerPolicy will be overridden in case of SYNC SmartCode |
linkAttributes |
Record<string, string> |
No | {} |
Additional attributes to be added to the link tag. |
Warning: SmartCode version
3.0will only work if it is enabled and reflected on your VWO dashboard. If you do not see version3.0in your dashboard, please contact your CSM or VWO Support to have it enabled.
yarn installyarn buildWe welcome contributions to improve this package! Please read our contributing guidelines before submitting a PR.
Our Code of Conduct outlines expectations for all contributors and maintainers.
© 2025 Wingify Software Pvt. Ltd.