https://github.com/GoogleChromeLabs/first-input-delay

A JavaScript library for measuring First Input Delay (FID) in the browser.
https://github.com/GoogleChromeLabs/first-input-delay

Last synced: about 5 hours ago
JSON representation

A JavaScript library for measuring First Input Delay (FID) in the browser.

• Host: GitHub
• URL: https://github.com/GoogleChromeLabs/first-input-delay
• Owner: GoogleChromeLabs
• License: apache-2.0
• Archived: true
• Created: 2018-01-26T16:17:00.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-11-17T16:47:20.000Z (almost 4 years ago)
• Last Synced: 2024-07-23T13:57:44.057Z (3 months ago)
• Language: JavaScript
• Homepage: https://developers.google.com/web/updates/2018/05/first-input-delay
• Size: 40 KB
• Stars: 349
• Watchers: 14
• Forks: 63
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-pagespeed-metrics - Polyfill - FID

README

        
## ⚠️ This polyfill has moved. It is now part of the [web-vitals](https://github.com/GoogleChrome/web-vitals#load-the-library) library. ⚠️

**All issues or feature requests should be submitted there. This repo will continue to exist for reference, but it is now archived.**

# First Input Delay

A JavaScript library for measuring [First Input Delay (FID)](https://developers.google.com/web/updates/2018/05/first-input-delay) in the browser. See [the article](https://developers.google.com/web/updates/2018/05/first-input-delay) for a detailed metric description and explanation.

## Installation

You can install this library from npm by running:

```sh

npm install --save-dev first-input-delay

```

## Usage

To use this library to measure FID on your web site or application, you must do two things.

**1) Add the minified code in [`dist/first-input-delay.js`](/dist/first-input-delay.min.js) to the `` of your document.**

The code in this file adds the necessary event listeners to detect the first user input, and since user input on a page can happen at any time, it's critical that this code runs as early as possible.

Since it's less than 400 bytes (gzipped), we recommended you inline it directly into your document `` to avoid a blocking request.

**2) Register a callback to run when FID is detected.**

The code in step (1) above exposes the global method `perfMetrics.onFirstInputDelay()`, which takes a function that is invoked with the delay value in milliseconds as well as the `Event` object from the first input.

For example, to detect FID and report it as an event to Google Analytics, you could use the following code:

```js

// The perfMetrics object is created by the code that goes in .

perfMetrics.onFirstInputDelay(function(delay, evt) {

  ga('send', 'event', {

    eventCategory: 'Perf Metrics',

    eventAction: 'first-input-delay',

    eventLabel: evt.type,

    // Event values must be an integer.

    eventValue: Math.round(delay),

    // Exclude this event from bounce rate calculations.

    nonInteraction: true,

  });

});

```

## Browser support

This code has been tested and known to work in all major browsers as well as Internet Explorer back to version 9.