From d1bde59cc892c02e34ff4c21c1a169c37c39c4d7 Mon Sep 17 00:00:00 2001 From: Budy K Date: Sat, 2 Nov 2024 17:02:37 +0700 Subject: [PATCH 1/3] feat: add example --- facebook-pixel/README.md | 20 ++++++++++++++ facebook-pixel/app/root.tsx | 29 +++++++++++++++++++ facebook-pixel/app/routes/_index.tsx | 7 +++++ facebook-pixel/package.json | 40 +++++++++++++++++++++++++++ facebook-pixel/public/favicon.ico | Bin 0 -> 16958 bytes facebook-pixel/sandbox.config.json | 7 +++++ facebook-pixel/tsconfig.json | 32 +++++++++++++++++++++ facebook-pixel/vite.config.ts | 16 +++++++++++ 8 files changed, 151 insertions(+) create mode 100644 facebook-pixel/README.md create mode 100644 facebook-pixel/app/root.tsx create mode 100644 facebook-pixel/app/routes/_index.tsx create mode 100644 facebook-pixel/package.json create mode 100644 facebook-pixel/public/favicon.ico create mode 100644 facebook-pixel/sandbox.config.json create mode 100644 facebook-pixel/tsconfig.json create mode 100644 facebook-pixel/vite.config.ts diff --git a/facebook-pixel/README.md b/facebook-pixel/README.md new file mode 100644 index 00000000..902a734e --- /dev/null +++ b/facebook-pixel/README.md @@ -0,0 +1,20 @@ +# TODO: Title of Example + +TODO: Describe the use case here + +## Preview + +Open this example on [CodeSandbox](https://codesandbox.com): + + + +[![Open in CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/remix-run/examples/tree/main/__template) + +## Example + +Describe the example and how it demonstrates solving the problem. Reference any relevant files/dependencies if needed. +If your example needs to modify the `entry.client.tsx` or `entry.server.tsx` files, use `npx remix reveal` to reveal them. + +## Related Links + +Link to documentation or other related examples. diff --git a/facebook-pixel/app/root.tsx b/facebook-pixel/app/root.tsx new file mode 100644 index 00000000..e82f26fd --- /dev/null +++ b/facebook-pixel/app/root.tsx @@ -0,0 +1,29 @@ +import { + Links, + Meta, + Outlet, + Scripts, + ScrollRestoration, +} from "@remix-run/react"; + +export function Layout({ children }: { children: React.ReactNode }) { + return ( + + + + + + + + + {children} + + + + + ); +} + +export default function App() { + return ; +} diff --git a/facebook-pixel/app/routes/_index.tsx b/facebook-pixel/app/routes/_index.tsx new file mode 100644 index 00000000..58245323 --- /dev/null +++ b/facebook-pixel/app/routes/_index.tsx @@ -0,0 +1,7 @@ +export default function Index() { + return ( +
+

Welcome to Remix

+
+ ); +} diff --git a/facebook-pixel/package.json b/facebook-pixel/package.json new file mode 100644 index 00000000..ff7abadc --- /dev/null +++ b/facebook-pixel/package.json @@ -0,0 +1,40 @@ +{ + "name": "template", + "private": true, + "sideEffects": false, + "type": "module", + "scripts": { + "build": "remix vite:build", + "dev": "remix vite:dev", + "lint": "eslint --ignore-path .gitignore --cache --cache-location ./node_modules/.cache/eslint .", + "start": "remix-serve ./build/server/index.js", + "typecheck": "tsc" + }, + "dependencies": { + "@remix-run/node": "^2.9.2", + "@remix-run/react": "^2.9.2", + "@remix-run/serve": "^2.9.2", + "isbot": "^4.1.0", + "react": "^18.2.0", + "react-dom": "^18.2.0" + }, + "devDependencies": { + "@remix-run/dev": "^2.9.2", + "@types/react": "^18.2.20", + "@types/react-dom": "^18.2.7", + "@typescript-eslint/eslint-plugin": "^6.7.4", + "@typescript-eslint/parser": "^6.7.4", + "eslint": "^8.38.0", + "eslint-import-resolver-typescript": "^3.6.1", + "eslint-plugin-import": "^2.28.1", + "eslint-plugin-jsx-a11y": "^6.7.1", + "eslint-plugin-react": "^7.33.2", + "eslint-plugin-react-hooks": "^4.6.0", + "typescript": "^5.1.6", + "vite": "^5.1.0", + "vite-tsconfig-paths": "^4.2.1" + }, + "engines": { + "node": ">=20.0.0" + } +} diff --git a/facebook-pixel/public/favicon.ico b/facebook-pixel/public/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..8830cf6821b354114848e6354889b8ecf6d2bc61 GIT binary patch literal 16958 zcmeI3+jCXb9mnJN2h^uNlXH@jlam{_a8F3W{T}Wih>9YJpaf7TUbu)A5fv|h7OMfR zR;q$lr&D!wv|c)`wcw1?>4QT1(&|jdsrI2h`Rn)dTW5t$8pz=s3_5L?#oBxAowe8R z_WfPfN?F+@`q$D@rvC?(W!uWieppskmQ~YG*>*L?{img@tWpnYXZslxeh#TSUS3{q z1Ju6JcfQSbQuORq69@YK(X-3c9vC2c2a2z~zw=F=50@pm0PUiCAm!bAT?2jpM`(^b zC|2&Ngngt^<>oCv#?P(AZ`5_84x#QBPulix)TpkIAUp=(KgGo4CVS~Sxt zVoR4>r5g9%bDh7hi0|v$={zr>CHd`?-l4^Ld(Z9PNz9piFY+llUw_x4ou7Vf-q%$g z)&)J4>6Ft~RZ(uV>dJD|`nxI1^x{X@Z5S<=vf;V3w_(*O-7}W<=e$=}CB9_R;)m9)d7`d_xx+nl^Bg|%ew=?uoKO8w zeQU7h;~8s!@9-k>7Cx}1SDQ7m(&miH zs8!l*wOJ!GHbdh)pD--&W3+w`9YJ=;m^FtMY=`mTq8pyV!-@L6smwp3(q?G>=_4v^ zn(ikLue7!y70#2uhqUVpb7fp!=xu2{aM^1P^pts#+feZv8d~)2sf`sjXLQCEj;pdI z%~f`JOO;*KnziMv^i_6+?mL?^wrE_&=IT9o1i!}Sd4Sx4O@w~1bi1)8(sXvYR-1?7~Zr<=SJ1Cw!i~yfi=4h6o3O~(-Sb2Ilwq%g$+V` z>(C&N1!FV5rWF&iwt8~b)=jIn4b!XbrWrZgIHTISrdHcpjjx=TwJXI7_%Ks4oFLl9 zNT;!%!P4~xH85njXdfqgnIxIFOOKW`W$fxU%{{5wZkVF^G=JB$oUNU5dQSL&ZnR1s z*ckJ$R`eCUJsWL>j6*+|2S1TL_J|Fl&kt=~XZF=+=iT0Xq1*KU-NuH%NAQff$LJp3 zU_*a;@7I0K{mqwux87~vwsp<}@P>KNDb}3U+6$rcZ114|QTMUSk+rhPA(b{$>pQTc zIQri{+U>GMzsCy0Mo4BfWXJlkk;RhfpWpAB{=Rtr*d1MNC+H3Oi5+3D$gUI&AjV-1 z=0ZOox+bGyHe=yk-yu%=+{~&46C$ut^ZN+ysx$NH}*F43)3bKkMsxGyIl#>7Yb8W zO{}&LUO8Ow{7>!bvSq?X{15&Y|4}0w2=o_^0ZzYgB+4HhZ4>s*mW&?RQ6&AY|CPcx z$*LjftNS|H)ePYnIKNg{ck*|y7EJ&Co0ho0K`!{ENPkASeKy-JWE}dF_%}j)Z5a&q zXAI2gPu6`s-@baW=*+keiE$ALIs5G6_X_6kgKK8n3jH2-H9`6bo)Qn1 zZ2x)xPt1=`9V|bE4*;j9$X20+xQCc$rEK|9OwH-O+Q*k`ZNw}K##SkY z3u}aCV%V|j@!gL5(*5fuWo>JFjeU9Qqk`$bdwH8(qZovE2tA7WUpoCE=VKm^eZ|vZ z(k<+j*mGJVah>8CkAsMD6#I$RtF;#57Wi`c_^k5?+KCmX$;Ky2*6|Q^bJ8+s%2MB}OH-g$Ev^ zO3uqfGjuN%CZiu<`aCuKCh{kK!dDZ+CcwgIeU2dsDfz+V>V3BDb~)~ zO!2l!_)m;ZepR~sL+-~sHS7;5ZB|~uUM&&5vDda2b z)CW8S6GI*oF><|ZeY5D^+Mcsri)!tmrM33qvwI4r9o@(GlW!u2R>>sB|E#%W`c*@5 z|0iA|`{6aA7D4Q?vc1{vT-#yytn07`H!QIO^1+X7?zG3%y0gPdIPUJ#s*DNAwd}m1_IMN1^T&be~+E z_z%1W^9~dl|Me9U6+3oNyuMDkF*z_;dOG(Baa*yq;TRiw{EO~O_S6>e*L(+Cdu(TM z@o%xTCV%hi&p)x3_inIF!b|W4|AF5p?y1j)cr9RG@v%QVaN8&LaorC-kJz_ExfVHB za!mtuee#Vb?dh&bwrfGHYAiX&&|v$}U*UBM;#F!N=x>x|G5s0zOa9{(`=k4v^6iK3 z8d&=O@xhDs{;v7JQ%eO;!Bt`&*MH&d zp^K#dkq;jnJz%%bsqwlaKA5?fy zS5JDbO#BgSAdi8NM zDo2SifX6^Z;vn>cBh-?~r_n9qYvP|3ihrnqq6deS-#>l#dV4mX|G%L8|EL;$U+w69 z;rTK3FW$ewUfH|R-Z;3;jvpfiDm?Fvyu9PeR>wi|E8>&j2Z@2h`U}|$>2d`BPV3pz#ViIzH8v6pP^L-p!GbLv<;(p>}_6u&E6XO5- zJ8JEvJ1)0>{iSd|kOQn#?0rTYL=KSmgMHCf$Qbm;7|8d(goD&T-~oCDuZf57iP#_Y zmxaoOSjQsm*^u+m$L9AMqwi=6bpdiAY6k3akjGN{xOZ`_J<~Puyzpi7yhhKrLmXV; z@ftONPy;Uw1F#{_fyGbk04yLE01v=i_5`RqQP+SUH0nb=O?l!J)qCSTdsbmjFJrTm zx4^ef@qt{B+TV_OHOhtR?XT}1Etm(f21;#qyyW6FpnM+S7*M1iME?9fe8d-`Q#InN z?^y{C_|8bxgUE@!o+Z72C)BrS&5D`gb-X8kq*1G7Uld-z19V}HY~mK#!o9MC-*#^+ znEsdc-|jj0+%cgBMy(cEkq4IQ1D*b;17Lyp>Utnsz%LRTfjQKL*vo(yJxwtw^)l|! z7jhIDdtLB}mpkOIG&4@F+9cYkS5r%%jz}I0R#F4oBMf-|Jmmk* zk^OEzF%}%5{a~kGYbFjV1n>HKC+a`;&-n*v_kD2DPP~n5(QE3C;30L<32GB*qV2z$ zWR1Kh=^1-q)P37WS6YWKlUSDe=eD^u_CV+P)q!3^{=$#b^auGS7m8zFfFS<>(e~)TG z&uwWhSoetoe!1^%)O}=6{SUcw-UQmw+i8lokRASPsbT=H|4D|( zk^P7>TUEFho!3qXSWn$m2{lHXw zD>eN6-;wwq9(?@f^F4L2Ny5_6!d~iiA^s~(|B*lbZir-$&%)l>%Q(36yOIAu|326K ztmBWz|MLA{Kj(H_{w2gd*nZ6a@ma(w==~EHIscEk|C=NGJa%Ruh4_+~f|%rt{I5v* zIX@F?|KJID56-ivb+PLo(9hn_CdK{irOcL15>JNQFY112^$+}JPyI{uQ~$&E*=ri; z`d^fH?4f=8vKHT4!p9O*fX(brB75Y9?e>T9=X#Fc@V#%@5^)~#zu5I(=>LQA-EGTS zecy*#6gG+8lapch#Hh%vl(+}J;Q!hC1OKoo;#h3#V%5Js)tQ)|>pTT@1ojd+F9Gey zg`B)zm`|Mo%tH31s4=<+`Pu|B3orXwNyIcNN>;fBkIj^X8P}RXhF= zXQK1u5RLN7k#_Q(KznJrALtMM13!vhfr025ar?@-%{l|uWt@NEd<$~n>RQL{ z+o;->n)+~0tt(u|o_9h!T`%M8%)w2awpV9b*xz9Pl-daUJm3y-HT%xg`^mFd6LBeL z!0~s;zEr)Bn9x)I(wx`;JVwvRcc^io2XX(Nn3vr3dgbrr@YJ?K3w18P*52^ieBCQP z=Up1V$N2~5ppJHRTeY8QfM(7Yv&RG7oWJAyv?c3g(29)P)u;_o&w|&)HGDIinXT~p z3;S|e$=&Tek9Wn!`cdY+d-w@o`37}x{(hl>ykB|%9yB$CGdIcl7Z?d&lJ%}QHck77 zJPR%C+s2w1_Dl_pxu6$Zi!`HmoD-%7OD@7%lKLL^Ixd9VlRSW*o&$^iQ2z+}hTgH) z#91TO#+jH<`w4L}XWOt(`gqM*uTUcky`O(mEyU|4dJoy6*UZJ7%*}ajuos%~>&P2j zk23f5<@GeV?(?`l=ih+D8t`d72xrUjv0wsg;%s1@*2p?TQ;n2$pV7h?_T%sL>iL@w zZ{lmc<|B7!e&o!zs6RW+u8+aDyUdG>ZS(v&rT$QVymB7sEC@VsK1dg^3F@K90-wYB zX!we79qx`(6LA>F$~{{xE8-3Wzyfe`+Lsce(?uj{k@lb97YTJt#>l*Z&LyKX@zjmu?UJC9w~;|NsB{%7G}y*uNDBxirfC EKbET!0{{R3 literal 0 HcmV?d00001 diff --git a/facebook-pixel/sandbox.config.json b/facebook-pixel/sandbox.config.json new file mode 100644 index 00000000..f92e0250 --- /dev/null +++ b/facebook-pixel/sandbox.config.json @@ -0,0 +1,7 @@ +{ + "hardReloadOnChange": true, + "template": "remix", + "container": { + "port": 3000 + } +} diff --git a/facebook-pixel/tsconfig.json b/facebook-pixel/tsconfig.json new file mode 100644 index 00000000..9d87dd37 --- /dev/null +++ b/facebook-pixel/tsconfig.json @@ -0,0 +1,32 @@ +{ + "include": [ + "**/*.ts", + "**/*.tsx", + "**/.server/**/*.ts", + "**/.server/**/*.tsx", + "**/.client/**/*.ts", + "**/.client/**/*.tsx" + ], + "compilerOptions": { + "lib": ["DOM", "DOM.Iterable", "ES2022"], + "types": ["@remix-run/node", "vite/client"], + "isolatedModules": true, + "esModuleInterop": true, + "jsx": "react-jsx", + "module": "ESNext", + "moduleResolution": "Bundler", + "resolveJsonModule": true, + "target": "ES2022", + "strict": true, + "allowJs": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true, + "baseUrl": ".", + "paths": { + "~/*": ["./app/*"] + }, + + // Vite takes care of building everything, not tsc. + "noEmit": true + } +} diff --git a/facebook-pixel/vite.config.ts b/facebook-pixel/vite.config.ts new file mode 100644 index 00000000..54066fb7 --- /dev/null +++ b/facebook-pixel/vite.config.ts @@ -0,0 +1,16 @@ +import { vitePlugin as remix } from "@remix-run/dev"; +import { defineConfig } from "vite"; +import tsconfigPaths from "vite-tsconfig-paths"; + +export default defineConfig({ + plugins: [ + remix({ + future: { + v3_fetcherPersist: true, + v3_relativeSplatPath: true, + v3_throwAbortReason: true, + }, + }), + tsconfigPaths(), + ], +}); From 8263de27582ca974401e6b18c86df3a9807f4051 Mon Sep 17 00:00:00 2001 From: Budy K Date: Mon, 4 Nov 2024 21:20:37 +0700 Subject: [PATCH 2/3] feat: add example --- facebook-pixel/.gitignore | 4 ++ facebook-pixel/README.md | 17 +++++-- facebook-pixel/app/root.tsx | 55 ++++++++++++++++++++++ facebook-pixel/app/routes/_index.tsx | 17 ++++++- facebook-pixel/app/routes/custom-event.tsx | 39 +++++++++++++++ facebook-pixel/app/routes/view-content.tsx | 30 ++++++++++++ facebook-pixel/app/utils/pixel.client.ts | 54 +++++++++++++++++++++ 7 files changed, 211 insertions(+), 5 deletions(-) create mode 100644 facebook-pixel/.gitignore create mode 100644 facebook-pixel/app/routes/custom-event.tsx create mode 100644 facebook-pixel/app/routes/view-content.tsx create mode 100644 facebook-pixel/app/utils/pixel.client.ts diff --git a/facebook-pixel/.gitignore b/facebook-pixel/.gitignore new file mode 100644 index 00000000..bb514fd1 --- /dev/null +++ b/facebook-pixel/.gitignore @@ -0,0 +1,4 @@ +node_modules + +/.cache +.env diff --git a/facebook-pixel/README.md b/facebook-pixel/README.md index 902a734e..17581bbf 100644 --- a/facebook-pixel/README.md +++ b/facebook-pixel/README.md @@ -1,6 +1,8 @@ # TODO: Title of Example -TODO: Describe the use case here +Setup Facebook Pixel with Remix. Inspired by the ```google-analytics``` example, we will do some adjustments to make sending Pixel events work with Remix. + + ## Preview @@ -12,9 +14,16 @@ Open this example on [CodeSandbox](https://codesandbox.com): ## Example -Describe the example and how it demonstrates solving the problem. Reference any relevant files/dependencies if needed. -If your example needs to modify the `entry.client.tsx` or `entry.server.tsx` files, use `npx remix reveal` to reveal them. +- Check ```app/utils/pixel.client.ts```. its a simple wrapper for the pixel's ```fbq``` function. + +- Check [app/root.tsx](./app/root.tsx) to see how the Facebook Pixel script is added. + + We use ```root.stx``` to fire initial events and the default ```PageView``` event. Every url visited in the app will fire a ```PageView``` event. + +- Check [app/routes/contact.tsx](./app/routes/contact.tsx) to see how to send specific events using a Button to trigger / send the event. + + You can follow and replicate the example in ```contact.tsx``` to any routes / components in your app. ## Related Links -Link to documentation or other related examples. +[Facebook Pixel Events Specification](https://developers.facebook.com/docs/meta-pixel/reference) diff --git a/facebook-pixel/app/root.tsx b/facebook-pixel/app/root.tsx index e82f26fd..6a575030 100644 --- a/facebook-pixel/app/root.tsx +++ b/facebook-pixel/app/root.tsx @@ -4,14 +4,69 @@ import { Outlet, Scripts, ScrollRestoration, + json, + useLoaderData, + useLocation, } from "@remix-run/react"; +// import the pixel client helper +import * as pixel from "./utils/pixel.client"; +import { useEffect } from "react"; + +/** + * put the Your Pixel ID in the loader. + * Sure you can also put it in the .env + * @returns Lets + */ +export let loader = async () => { + return json({ + PIXEL_ID: 'YOUR_PIXEL_ID_HERE', + }); +}; + export function Layout({ children }: { children: React.ReactNode }) { + + const location = useLocation(); + + // get the pixel id + const { PIXEL_ID } = useLoaderData(); + + // fire pixel init and the default pageview event here + // we use location as the depency index. so everytime the route changes, the pixel will fire + useEffect(() => { + pixel.init(PIXEL_ID); + pixel.pageView(); + }, [location, PIXEL_ID]); + return ( + + {/* + Facebook Pixel script injection. lets only activate it on Production only + + You will also notice that I split script injection into 2 parts as seen below. After several atempts and trial, puting it as a single script tag as Facebook suggested did not work. It rise a hydation error in Production. + + You should try it yourself and see it. + */} + {process.env.NODE_ENV === "development" ? null : ( + <> +