|
| 1 | +# React Google Tag Manager Hook |
| 2 | + |
| 3 | +With this custom hook, you can easily use the Google Tag Manager with 0 config, you just have to pass the **container ID**! |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +- [Installation](#installation) |
| 8 | +- [How to use](#how-to-use) |
| 9 | +- [License](#license) |
| 10 | + |
| 11 | +## Installation |
| 12 | + |
| 13 | +```bash |
| 14 | +$ pnpm add react-gtm-hook |
| 15 | +# or |
| 16 | +$ yarn add react-gtm-hook |
| 17 | +# or |
| 18 | +$ npm install react-gtm-hook |
| 19 | +``` |
| 20 | + |
| 21 | +## How to use |
| 22 | + |
| 23 | +### Basic |
| 24 | + |
| 25 | +```jsx |
| 26 | +import { GTMProvider } from "react-gtm-hook"; |
| 27 | + |
| 28 | +const App = () => { |
| 29 | + const gtmConfig = { id: "GTM-ID" }; |
| 30 | + |
| 31 | + return ( |
| 32 | + <GTMProvider config={gtmConfig}> |
| 33 | + <div>My awesome app</div> |
| 34 | + </GTMProvider> |
| 35 | + ); |
| 36 | +} |
| 37 | +``` |
| 38 | + |
| 39 | +### With custom DataLayer Name |
| 40 | + |
| 41 | +```jsx |
| 42 | +import { GTMProvider } from "react-gtm-hook"; |
| 43 | + |
| 44 | +const App = () => { |
| 45 | + const gtmConfig = { |
| 46 | + id: "GTM-ID", |
| 47 | + dataLayerName: "customDataLayerName", |
| 48 | + }; |
| 49 | + |
| 50 | + return ( |
| 51 | + <GTMProvider config={gtmConfig}> |
| 52 | + <div>My awesome app</div> |
| 53 | + </GTMProvider> |
| 54 | + ); |
| 55 | +}; |
| 56 | +``` |
| 57 | + |
| 58 | +### With custom DataLayer name and initial values |
| 59 | + |
| 60 | +```jsx |
| 61 | +import { GTMProvider } from "react-gtm-hook"; |
| 62 | + |
| 63 | +const App = () => { |
| 64 | + const gtmConfig = { |
| 65 | + id: 'GTM-ID', |
| 66 | + dataLayer: { |
| 67 | + "my-custom-value": "value", |
| 68 | + "my-awesome-value": "awesome", |
| 69 | + }, |
| 70 | + dataLayerName: "customDataLayerName", |
| 71 | + }; |
| 72 | + |
| 73 | + return ( |
| 74 | + <GTMProvider config={gtmConfig}> |
| 75 | + <div>My awesome app</div> |
| 76 | + </GTMProvider> |
| 77 | + ); |
| 78 | +}; |
| 79 | +``` |
| 80 | + |
| 81 | +### Use a GTM custom environment |
| 82 | + |
| 83 | +```jsx |
| 84 | +import { GTMProvider } from "react-gtm-hook"; |
| 85 | + |
| 86 | +const App = () => { |
| 87 | + const gtmConfig = { |
| 88 | + id: "GTM-ID", |
| 89 | + environment: { |
| 90 | + gtm_auth: "my-auth-token", |
| 91 | + gtm_preview: "preview-id", |
| 92 | + }, |
| 93 | + }; |
| 94 | + |
| 95 | + return ( |
| 96 | + <GTMProvider config={gtmConfig}> |
| 97 | + <div>My awesome app</div> |
| 98 | + </GTMProvider> |
| 99 | + ); |
| 100 | +}; |
| 101 | +``` |
| 102 | + |
| 103 | +_To find the `gtm_auth` and `gtm_preview` values for your custom GTM environment, go to Admin > Your Container > Environments > Your Environment > Actions > Get Snippet in your Google Tag Manager console. You will find the values you need embedded in the snippet._ |
| 104 | + |
| 105 | +### Sending data to GTM |
| 106 | + |
| 107 | +```jsx |
| 108 | +import { GTMProvider, useGTMDispatch } from "react-gtm-hook"; |
| 109 | + |
| 110 | +const App = () => { |
| 111 | + const gtmConfig = { |
| 112 | + id: "GTM-ID", |
| 113 | + dataLayerName: "customDataLayerName", |
| 114 | + }; |
| 115 | + |
| 116 | + return ( |
| 117 | + <GTMProvider config={gtmConfig}> |
| 118 | + <div> |
| 119 | + <div>Acme Store</div> |
| 120 | + <ProductCard /> |
| 121 | + </div> |
| 122 | + </GTMProvider> |
| 123 | + ); |
| 124 | +}; |
| 125 | + |
| 126 | +const ProductCard = () => { |
| 127 | + const send = useGTMDispatch(); |
| 128 | + |
| 129 | + const handleClick = () => send({ event: "buy", product: "product-123" }); |
| 130 | + |
| 131 | + return ( |
| 132 | + <div> |
| 133 | + <div>Product Name</div> |
| 134 | + <button onClick={handleClick}>Buy</button> |
| 135 | + </div> |
| 136 | + ); |
| 137 | +} |
| 138 | +``` |
| 139 | + |
| 140 | +## License |
| 141 | + |
| 142 | +MIT |
0 commit comments