feat(consent-manager): Add shouldLoad to custom services (#951)

* Add custom scripts wrapper component * Create fuzzy-pandas-fly.md * add hide to service * chore: delete unused component and update type name * chore: update comment * Update .changeset/fuzzy-pandas-fly.md Co-authored-by: Bryce Kalow <bkalow@hashicorp.com> --------- Co-authored-by: Bryce Kalow <bkalow@hashicorp.com>
hashicorp · May 3, 2023 · cb32ea4 · cb32ea4 · vercel · May 3, 2023
1 parent 32cf8a0
commit cb32ea4
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/.changeset/fuzzy-pandas-fly.md b/.changeset/fuzzy-pandas-fly.md
@@ -0,0 +1,5 @@
+---
+"@hashicorp/react-consent-manager": minor
+---
+
+feat(consent-manager): Add custom scripts wrapper component
diff --git a/packages/consent-manager/scripts/custom.tsx b/packages/consent-manager/scripts/custom.tsx
@@ -25,6 +25,10 @@ function CustomScript({ service }: CustomScriptProps) {
   const strategy =
     service.strategy ?? service.async ? 'afterInteractive' : 'beforeInteractive'
 
+  if (service.shouldLoad !== undefined && !service.shouldLoad()) {
+    return null
+  }
+
   return (
     <Script
       src={service.url}

diff --git a/packages/consent-manager/types.ts b/packages/consent-manager/types.ts
@@ -13,6 +13,12 @@ export interface ConsentManagerService {
   name: string
   url?: string
   dataAttrs?: { name: string; value: string }[]
+  /**
+   * Optional function that determines whether
+   * or not the script will load on the page.
+   * If left undefined, script will load as usual.
+   */
+  shouldLoad?: () => boolean
 }
 
 export interface ConsentManagerPreset {