MDN self-hosted library · e01.org

LayoutShiftAttribution

Performance API

Performance API

The LayoutShiftAttribution interface provides debugging information about elements which have shifted.

Instances of LayoutShiftAttribution are returned in an array by calling LayoutShift.sources.

Instance properties

  • LayoutShiftAttribution.node
  • : Returns the element that has shifted (null if it has been removed).
  • LayoutShiftAttribution.previousRect
  • : Returns a DOMRectReadOnly object representing the position of the element before the shift.
  • LayoutShiftAttribution.currentRect
  • : Returns a DOMRectReadOnly object representing the position of the element after the shift.

Instance methods

  • LayoutShiftAttribution.toJSON()
  • : Returns a JSON-serializable plain object representing the LayoutShiftAttribution object. Automatically called by JSON.stringify().

Examples

The following example observes layout shifts and identifies the most impactful element. The sources array is sorted by impact area, in descending order — so the first element (sources[0]) represents the element that contributed most to the layout shift. For more detail on that, see Debug Web Vitals in the field.

const observer = new PerformanceObserver((list) => {
  for (const entry of list.getEntries()) {
    if (!entry.sources || entry.sources.length === 0) continue;

    const mostImpactfulSource = entry.sources[0];
    console.log("Layout shift score:", entry.value);
    console.log("Most impactful element:", mostImpactfulSource.node);
    console.log("Previous position:", mostImpactfulSource.previousRect);
    console.log("Current position:", mostImpactfulSource.currentRect);
  }
});

observer.observe({ type: "layout-shift", buffered: true });

Specifications

Browser compatibility

See also