@nexly/react-web 0.13.0 → 0.15.0

package/README.md

@@ -43,7 +43,17 @@ function App() {
 
 - **`appId`**, **`ingestKey`** — required strings (`ingestKey` is the ingest API token; not named `key` because that is reserved in React).
 - **`autoPageView`** (default `false`) — when a client exists, send one pageview on mount.
-- **`autoEngagement`** (default `false`) — when **`true`** and a client exists (all three strings non-empty after trim), attach engagement listeners; otherwise no-op. Cleanup on unmount or when the client or flag changes.
+- **`autoEngagement`** (default `false`) — when **`true`** and a client exists (all three strings non-empty after trim), attach engagement listeners; otherwise no-op. Cleanup on unmount or when the client or flag changes. The underlying `startEngagement()` is idempotent, so double-mounts (StrictMode, HMR) don't produce duplicate listeners.
+
+### Opting elements out of auto-capture
+
+Mark any element with `data-nexly-ignore` to skip auto-`click` and auto-`input_focus` events for it (and its descendants). Use it on elements where you already emit your own `event(...)` to avoid semantic duplicates:
+
+```tsx
+<button data-nexly-ignore onClick={() => client?.event({ name: 'signup_clicked', type: 'custom' })}>
+  Sign up
+</button>
+```
 
 ### `useNexlyClient()`
 

package/dist/nexly-provider.d.ts

@@ -19,9 +19,16 @@ export type NexlyProviderProps = {
     autoPageView?: boolean;
     /** When true and a client exists, attach engagement listeners (scroll, click, visibility, …). Cleaned up on change/unmount. */
     autoEngagement?: boolean;
+    /**
+     * When true and a client exists, auto-track clicks on `<a>` elements that
+     * navigate away: external `http(s)` links, file downloads (by `download`
+     * attr or known extension), `mailto:` and `tel:` links. Cleaned up on
+     * change/unmount.
+     */
+    autoOutboundLinks?: boolean;
     children: ReactNode;
 };
-export declare function NexlyProvider({ collectUrl, appId, ingestKey, autoPageView, autoEngagement, children, }: NexlyProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function NexlyProvider({ collectUrl, appId, ingestKey, autoPageView, autoEngagement, autoOutboundLinks, children, }: NexlyProviderProps): import("react/jsx-runtime").JSX.Element;
 /** Returns the configured {@link Nexly} client, or `null` if credentials are incomplete. Must be used under {@link NexlyProvider}. */
 export declare function useNexlyClient(): Nexly | null;
 //# sourceMappingURL=nexly-provider.d.ts.map

package/dist/nexly-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nexly-provider.d.ts","sourceRoot":"","sources":["../src/nexly-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAiD,KAAK,SAAS,EAAE,MAAM,OAAO,CAAA;AAIrF;;;;;;GAMG;AAEH,eAAO,MAAM,2BAA2B,sCAAgD,CAAA;AAExF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,8FAA8F;IAC9F,SAAS,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,+HAA+H;IAC/H,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,EAAE,SAAS,CAAA;CACpB,CAAA;AAED,wBAAgB,aAAa,CAAC,EAC5B,UAAU,EACV,KAAK,EACL,SAAS,EACT,YAAoB,EACpB,cAAsB,EACtB,QAAQ,GACT,EAAE,kBAAkB,2CA2BpB;AAED,sIAAsI;AACtI,wBAAgB,cAAc,IAAI,KAAK,GAAG,IAAI,CAE7C"}
+{"version":3,"file":"nexly-provider.d.ts","sourceRoot":"","sources":["../src/nexly-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAiD,KAAK,SAAS,EAAE,MAAM,OAAO,CAAA;AAIrF;;;;;;GAMG;AAEH,eAAO,MAAM,2BAA2B,sCAAgD,CAAA;AAExF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,8FAA8F;IAC9F,SAAS,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,+HAA+H;IAC/H,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,QAAQ,EAAE,SAAS,CAAA;CACpB,CAAA;AAED,wBAAgB,aAAa,CAAC,EAC5B,UAAU,EACV,KAAK,EACL,SAAS,EACT,YAAoB,EACpB,cAAsB,EACtB,iBAAyB,EACzB,QAAQ,GACT,EAAE,kBAAkB,2CAkCpB;AAED,sIAAsI;AACtI,wBAAgB,cAAc,IAAI,KAAK,GAAG,IAAI,CAE7C"}

package/dist/nexly-provider.js

@@ -12,7 +12,7 @@ const NexlyClientContext = createContext(null);
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const _NexlyClientIdentityContext = createContext(NexlyClient.React);
-export function NexlyProvider({ collectUrl, appId, ingestKey, autoPageView = false, autoEngagement = false, children, }) {
+export function NexlyProvider({ collectUrl, appId, ingestKey, autoPageView = false, autoEngagement = false, autoOutboundLinks = false, children, }) {
     const clientId = useContext(_NexlyClientIdentityContext);
     const nexly = useMemo(() => {
         const id = (appId ?? '').trim();
@@ -37,6 +37,12 @@ export function NexlyProvider({ collectUrl, appId, ingestKey, autoPageView = fal
         }
         return nexly.startEngagement();
     }, [autoEngagement, nexly]);
+    useEffect(() => {
+        if (!autoOutboundLinks || !nexly) {
+            return;
+        }
+        return nexly.startOutboundLinks();
+    }, [autoOutboundLinks, nexly]);
     return _jsx(NexlyClientContext.Provider, { value: nexly, children: children });
 }
 /** Returns the configured {@link Nexly} client, or `null` if credentials are incomplete. Must be used under {@link NexlyProvider}. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexly/react-web",
-  "version": "0.13.0",
+  "version": "0.15.0",
   "description": "React bindings for Nexly (@nexly/web): provider, client hook, engagement, optional auto pageview",
   "license": "MIT",
   "keywords": [
@@ -39,7 +39,7 @@
     "react": "^18.0.0 || ^19.0.0"
   },
   "dependencies": {
-    "@nexly/web": "0.13.0"
+    "@nexly/web": "0.15.0"
   },
   "devDependencies": {
     "@types/react": "^19.2.14",