@convex-internal/web-analytics 2.2.2 → 2.3.0

package/README.md

@@ -59,6 +59,8 @@ It returns one of:
 The banner is visible when `consent` is `"undecided"`. It is hidden while
 `consent` is `"unknown"`, `"consented"`, or `"declined"`.
 
+React and Svelte accept an optional `hideBanner` prop, defaulting to `false`.
+
 Theme with `--wa-banner-*` variables on `.wa-banner`:
 
 ```css
@@ -127,6 +129,26 @@ import { WebAnalyticsProvider } from "@convex-internal/web-analytics/react";
 <WebAnalyticsProvider>{children}</WebAnalyticsProvider>;
 ```
 
+For example, hide the banner on `/start` and `/login` redirect pages in Next.js:
+
+```tsx
+"use client";
+
+import { WebAnalyticsProvider } from "@convex-internal/web-analytics/react";
+import { usePathname } from "next/navigation";
+import type { ReactNode } from "react";
+
+export function Analytics({ children }: { children: ReactNode }) {
+  const pathname = usePathname();
+
+  return (
+    <WebAnalyticsProvider hideBanner={["/start", "/login"].includes(pathname)}>
+      {children}
+    </WebAnalyticsProvider>
+  );
+}
+```
+
 ### `Consented`
 
 Renders children only when `consent` is `"consented"`. It renders nothing during
@@ -158,7 +180,7 @@ only when `consent === "consented"`.
 ## Svelte
 
 The Svelte entry exports only `WebAnalytics`. Render it once in the root
-layout. It has no props and no snippet: it starts PostHog and shows the banner.
+layout. It starts PostHog and shows the banner.
 There is no `Consented` wrapper or consent store. Those can be added later;
 nothing using the Svelte entry has needed them yet.
 

package/dist/react/ConsentBanner.d.ts

@@ -1,2 +1,4 @@
 import "../banner.css";
-export declare function ConsentBanner(): import("react").JSX.Element | null;
+export declare function ConsentBanner({ hideBanner, }: {
+    hideBanner?: boolean;
+}): import("react").JSX.Element | null;

package/dist/react/ConsentBanner.js

@@ -6,9 +6,9 @@ import { hasGPC } from "../consent.js";
 import { bannerCopy } from "../strings.js";
 import { useConsent } from "./useConsent.js";
 import "../banner.css";
-export function ConsentBanner() {
+export function ConsentBanner({ hideBanner = false, }) {
     const { consent, setConsent } = useConsent();
-    const shouldShow = consent === "undecided";
+    const shouldShow = consent === "undecided" && !hideBanner;
     const wasShowing = useRef(false);
     const recordedGPCDecision = useRef(false);
     useEffect(() => {

package/dist/react/WebAnalyticsProvider.d.ts

@@ -3,9 +3,11 @@ import { type ConsentStatus } from "../consent.js";
 export type { ConsentStatus };
 export interface WebAnalyticsProviderProps {
     children: ReactNode;
+    /** Hide the banner while keeping consent handling and analytics active. */
+    hideBanner?: boolean;
 }
 export declare const ConsentContext: import("react").Context<{
     consent: ConsentStatus;
     setConsent: (status: "consented" | "declined") => void;
 } | null>;
-export declare function WebAnalyticsProvider({ children }: WebAnalyticsProviderProps): import("react").JSX.Element;
+export declare function WebAnalyticsProvider({ children, hideBanner, }: WebAnalyticsProviderProps): import("react").JSX.Element;

package/dist/react/WebAnalyticsProvider.js

@@ -6,7 +6,7 @@ import { initPostHog, syncPostHogConsent } from "../posthog.js";
 import { ConsentBanner } from "./ConsentBanner.js";
 import { useBooleanCookie } from "./useCookie.js";
 export const ConsentContext = createContext(null);
-export function WebAnalyticsProvider({ children }) {
+export function WebAnalyticsProvider({ children, hideBanner = false, }) {
     const { value, isReady, setValue } = useBooleanCookie(COOKIE_NAME);
     const consent = resolveConsent(isReady, value, hasGPC());
     useEffect(() => {
@@ -20,5 +20,5 @@ export function WebAnalyticsProvider({ children }) {
             setConsent: (status) => {
                 setValue(status === "consented" ? "true" : "false");
             },
-        }, children: [children, _jsx(ConsentBanner, {})] }));
+        }, children: [children, _jsx(ConsentBanner, { hideBanner: hideBanner })] }));
 }

package/dist/svelte/WebAnalytics.svelte

@@ -7,12 +7,14 @@
   import { bannerCopy } from "../strings.js";
   import "../banner.css";
 
+  let { hideBanner = false }: { hideBanner?: boolean } = $props();
+
   let isReady = $state(false);
   let cookieValue = $state<boolean | undefined>(undefined);
   let recordedGPCDecision = false;
 
   const consent = $derived(resolveConsent(isReady, cookieValue, hasGPC()));
-  const shouldShowBanner = $derived(consent === "undecided");
+  const shouldShowBanner = $derived(consent === "undecided" && !hideBanner);
 
   function readCookieValue(): boolean | undefined {
     const raw = getCookie(COOKIE_NAME);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@convex-internal/web-analytics",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "type": "module",
   "exports": {
     ".": {

package/dist/core/index.d.ts

@@ -1,2 +0,0 @@
-export { capture, type CaptureOptions } from "../capture.js";
-export type { ConsentStatus } from "../consent.js";

package/dist/core/index.js

@@ -1 +0,0 @@
-export { capture } from "../capture.js";