@elu-labs/analytics-browser 1.410.3 → 1.410.4

package/README.md

@@ -88,7 +88,7 @@ than creating one on every render or mount. The NPM client does not create
 | `autocapture`              | `true`                                                           | Enables automatic interaction capture, subject to site policy and consent.                                                                                                          |
 | `capture_exceptions`       | `false`                                                          | Set `true` for unhandled errors and promise rejections. Manual `captureException()` remains available.                                                                              |
 | `capture_network_requests` | `true`                                                           | Set `false` to stop reporting fetch/XHR requests. Each report carries method, status, timing and a scrubbed path only — never query strings, headers or bodies. Up to 200 per page. |
-| `capture_performance`      | Off unless enabled in ELU                                        | `true` enables memory and long-task samples; `false` disables both. An object overrides individual settings; see below.                                                             |
+| `capture_performance`      | Web Vitals on; samples off unless enabled in ELU                 | `false` disables Web Vitals and the memory and long-task samples; `true` enables the samples. An object sets `web_vitals`, `memory`, `long_tasks` individually; see below.          |
 | `loaded(client)`           | None                                                             | Runs after local startup and before the initial automatic pageview. It does not mean configuration, flags or delivery have completed. An async callback is not awaited.             |
 
 The script loader chooses its startup options; changing NPM options does not
@@ -96,7 +96,14 @@ configure a script installation. Replay and privacy settings come from ELU.
 There is no public `startSessionRecording()`, `stopSessionRecording()`,
 `set_config()` or per-request endpoint override on this client.
 
-## Optional performance samples
+## Web Vitals and optional performance samples
+
+Each page reports its Core Web Vitals (LCP, FCP, CLS and INP) as one or more
+`$web_vitals` events carrying the values, their ratings and the page location
+only. Metrics that settle early are sent together after a short delay; the rest
+are sent once the page is hidden. A page that first paints while hidden reports
+no paint timings. Pass `capture_performance: { web_vitals: false }` to turn this
+off; `web_vitals` stays on only when omitted or `true`.
 
 Performance sampling is off when neither your ELU site configuration nor local
 initialization options enable it. For the NPM client, you can opt in explicitly:
@@ -113,7 +120,9 @@ const elu = createEluClient('YOUR_SITE_KEY', {
 
 The TypeScript options type is `PerformanceCaptureConfig`. Each local setting
 overrides its remote counterpart; `true` enables both metrics and `false`
-disables both. The interval defaults to 30 seconds, with a five-second minimum.
+disables both, along with Web Vitals. A `capture_performance` value that is
+neither a boolean nor an object is treated as `false`. The interval defaults to
+30 seconds, with a five-second minimum.
 If a renewed site configuration omits performance settings, previous remote
 opt-ins end; explicit local overrides still require valid capture authority.