v6.0.0

Compare Source

v6 introduces Soft Navigation support for the Web Vitals metrics when supported by the browser.

[!NOTE] See the upgrading to v6 guide for a complete list of all API changes in version 6.

• [BREAKING] Remove unneeded modules with tsconfig verbatimModuleSyntax (#​741)
• Add source maps (#​771)
• Cap RequestIdleCallback to 1 second to ensure metrics report even when busy (#​755)
• Flip default for includeProcessedEventEntries to false for v6 (#​763)
• Add Soft Navigation support (#​308)
• Add bfcache support for reporting small INP interactions (part of #​308)

v5.3.0

Compare Source

• Remove getFirstHiddenTimePolyfill (#​729)
• Fixed issue where the same configuration object to multiple metric functions can result in errors (#​731)
• Add more robust interactionTarget setting for INP (#​744)

v5.2.0

Compare Source

• Replace filter()[0] with find() for better performance (#​658)
• Use queueMicrotask for microtask scheduling (#​660)
• Simplify the event and LoAF entry clean up logic (#​662)
• Remove obsolete FID polyfill types (#​675)
• Use LargestContentfulPaint.id as fallback when element is removed from DOM (#​676)
• Fix bug for onLCP when attached late (#​697)
• FHandle initially hidden pages and onLCP registered on visibility change (#​698)
• Ensure we clear idle callbacks in whenIdleOrHidden (#​707)
• Limit pending events to conserve memory (#​710)
• Add includeProcessedEventEntries option (#​714)
• Reduce bundle size by refactoring (#​713)

v5.1.0

Compare Source

• Register visibility-change early (#​637)
• Only finalize LCP on user events (isTrusted=true) (#​635)
• Fallback to default getSelector if custom function is null or undefined (#​634)

v5.0.3

Compare Source

• Remove visibilitychange event listeners when no longer required (#​627)

v5.0.2

Compare Source

• Handle layout shifts with no sources (#​623)

v5.0.1

Compare Source

• Fix missing FCP and LCP for prerendered pages (#​621)

v5.0.0

Compare Source

[!NOTE] See the upgrading to v5 guide for a complete list of all API changes in version 5.

• [BREAKING] Remove the deprecated onFID() function (#​519)
• [BREAKING] Change browser support policy to Baseline Widely available (#​525)
• [BREAKING] Sort the classes that appear in attribution selectors to reduce cardinality (#​518)
• Extend INP attribution with extra LoAF information: longest script and buckets (#​592)
• Add support for generating custom targets in the attribution build (#​585)
• Support multiple calls to onINP() with different config options (#​583)
• Use visibility-state performance entries (#​612)
• Ensure idle callbacks don't run twice (#​541) and (#​548)
• Cap nextPaintTime at processingStart (#​540) and (#​546)
• Cap INP breakdowns to INP duration (#​528)
• Cap LCP load duration to LCP time (#​527)

v4.2.4

Compare Source

• Fix memory leak in registering new event listeners on every keydown and click (#​554)

v4.2.3

Compare Source

• Fix missing LoAF entries in INP attribution (#​512)

v4.2.2

Compare Source

• Fix interaction count after bfcache restore (#​505)

v4.2.1

Compare Source

• Fix compatibility issues with TypeScript v5.5 (#​497)

v4.2.0

Compare Source

• Refactor INP attribution code to fix errors on Windows 10 (#​495)

v4.1.1

Compare Source

• Fix pending LoAF cleanup logic (#​493)

v4.1.0

Compare Source

• Move the support check to the top of the onINP() function (#​490)
• Fix missing LoAF attribution when entries are dispatched before event entries (#​487)

v4.0.1

Compare Source

• Add the ReportCallback type back but deprecate it (#​483)

v4.0.0

Compare Source

[!NOTE] See the upgrading to v4 guide for a complete list of all API changes in version 4.

• [BREAKING] Update types to support more generic usage (#​471)
• [BREAKING] Split waitingDuration to make it easier to understand redirect delays (#​458)
• [BREAKING] Rename TTFBAttribution fields from *Time to *Duration (#​453)
• [BREAKING] Rename resourceLoadTime to resourceLoadDuration in LCP attribution (#​450)
• [BREAKING] Add INP breakdown timings and LoAF attribution (#​442)
• [BREAKING] Deprecate onFID() and remove previously deprecated APIs (#​435)
• Expose the target element in INP attribution (#​479)
• Save INP target after interactions to reduce null values when removed from the DOM (#​477)
• Cap TTFB in attribution (#​440)
• Fix reportAllChanges behavior for LCP when library is loaded late (#​468)

v3.5.2

Compare Source

• Pick the first non-null target for INP attribution (#​421)

v3.5.1

Compare Source

• Add extra guard for PerformanceEventTiming not existing (#​403)

v3.5.0

Compare Source

• Run onLCP callback in separate task (#​386)
• Fix INP durationThreshold bug when set to 0 (#​372)
• Prevent FID entries being emitted as INP for non-supporting browsers (#​368)

v3.4.0

Compare Source

• Make bindReporter generic over metric type (#​359)
• Update INP status in README (#​362)
• Fix Metric types for better TypeScript support (#​356)
• Fix selector for SVGs for attribution build (#​354)

v3.3.2

Compare Source

• Fix attribution types (#​348)
• Safe access navigation entry type (#​290)

v3.3.1

Compare Source

• Export metric rating thresholds in attribution build as well.

v3.3.0

Compare Source

• Export metric rating thresholds, add explicit MetricRatingThresholds type (#​323)
• Trim classname selector (#​328)
• Add link to CrUX versus RUM blog post (#​327)
• Prevent LCP being reported for hidden prerendered pages (#​326)
• Add Server Timing information to docs (#​324)
• Fix link in onINP() thresholds comment (#​318)
• Update web.dev link for onINP() (#​307)
• Add a note about when to load the library (#​305)

v3.1.1

Compare Source

• Defer CLS logic until after onFCP() callback (#​297)

v3.1.0

Compare Source

• Add support for 'restore' as a navigationType (#​284)
• Report initial CLS value when reportAllChanges is true (#​283)
• Defer all observers until after activation (#​282)
• Ignore TTFB for loads where responseStart is zero (#​281)
• Defer execution of observer callbacks (#​278)

v3.0.4

Compare Source

• Clamp LCP and FCP to 0 for prerendered pages (#​270)

v3.0.3

Compare Source

• Ensure attribution object is always present in attribution build (#​265)

v3.0.2

Compare Source

• Set an explicit unpkg dist file (#​261)

v3.0.1

Compare Source

• Use the cjs extension for all UMD builds (#​257)

v3.0.0

Compare Source

• [BREAKING] Add a config object param to all metric functions (#​225)
• [BREAKING] Report TTFB after a bfcache restore (#​220)
• [BREAKING] Only include last LCP entry in metric entries (#​218)
• Update the metric ID prefix for v3 (#​251)
• Move the Navigation Timing API polyfill to the base+polyfill build (#​248)
• Add a metric rating property (#​246)
• Add deprecation notices for base+polyfill builds (#​242)
• Add a new attribution build for debugging issues in the field (#​237, #​244)
• Add support for prerendered pages (#​233)
• Rename the ReportHandler type to ReportCallback, with alias for back-compat (#​225, #​227)
• Add support for the new INP metric (#​221, #​232)
• Rename getXXX() functions to onXXX() (#​222)
• Add a navigationType property to the Metric object (#​219)