examples: Adds with-google-tag-manager example that uses `@next/thi…

…rd-parties` (vercel#57364)
saltcod · Aug 15, 2024 · f87cf5c · f87cf5c
1 parent 327bd94
commit f87cf5c
Show file tree

Hide file tree

Showing 7 changed files with 122 additions and 0 deletions.
diff --git a/examples/with-google-tag-manager/.env.local.example b/examples/with-google-tag-manager/.env.local.example
@@ -0,0 +1 @@
+NEXT_PUBLIC_GOOGLE_TAG_MANAGER_ID=
diff --git a/examples/with-google-tag-manager/.gitignore b/examples/with-google-tag-manager/.gitignore
@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
diff --git a/examples/with-google-tag-manager/README.md b/examples/with-google-tag-manager/README.md
@@ -0,0 +1,35 @@
+## Example app using Google Tag Manager
+
+This example shows how to include Google Tag Manager in a Next.js application using `@next/third-parties`. The GTM container is instantiated in `layout.js` and the `sendGTMEvent` function is fired in the `EventButton` client component.
+
+## Deploy your own
+
+Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-google-tag-manager&project-name=with-google-tag-manager&repository-name=with-google-tag-manager)
+
+## How to use
+
+Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
+
+```bash
+npx create-next-app --example with-google-tag-manager with-google-tag-manager-app
+```
+
+```bash
+yarn create next-app --example with-google-tag-manager with-google-tag-manager-app
+```
+
+```bash
+pnpm create next-app --example with-google-tag-manager with-google-tag-manager-app
+```
+
+Next, copy the `.env.local.example` file in this directory to `.env.local` (which will be ignored by Git):
+
+```bash
+cp .env.local.example .env.local
+```
+
+Set the `NEXT_PUBLIC_GOOGLE_TAG_MANAGER_ID` variable in `.env.local` to match your Google Tag Manager ID.
+
+Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
diff --git a/examples/with-google-tag-manager/app/components/EventButton.js b/examples/with-google-tag-manager/app/components/EventButton.js
@@ -0,0 +1,15 @@
+'use client'
+
+import { sendGTMEvent } from '@next/third-parties/google'
+
+export function EventButton() {
+  return (
+    <div>
+      <button
+        onClick={() => sendGTMEvent({ event: 'buttonClicked', value: 'xyz' })}
+      >
+        Send Event
+      </button>
+    </div>
+  )
+}
diff --git a/examples/with-google-tag-manager/app/layout.js b/examples/with-google-tag-manager/app/layout.js
@@ -0,0 +1,12 @@
+import { GoogleTagManager } from '@next/third-parties/google'
+
+const GTM_ID = process.env.NEXT_PUBLIC_GOOGLE_TAG_MANAGER_ID
+
+export default function RootLayout({ children }) {
+  return (
+    <html lang="en">
+      <body>{children}</body>
+      <GoogleTagManager gtmId={GTM_ID} />
+    </html>
+  )
+}
diff --git a/examples/with-google-tag-manager/app/page.js b/examples/with-google-tag-manager/app/page.js
@@ -0,0 +1,9 @@
+import { EventButton } from './components/EventButton'
+
+export default function Page() {
+  return (
+    <div>
+      <EventButton />
+    </div>
+  )
+}
diff --git a/examples/with-google-tag-manager/package.json b/examples/with-google-tag-manager/package.json
@@ -0,0 +1,14 @@
+{
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start"
+  },
+  "dependencies": {
+    "next": "latest",
+    "@next/third-parties": "latest",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  }
+}