123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107 |
- Object.defineProperty(exports, '__esModule', { value: true });
- const bindReporter = require('./lib/bindReporter.js');
- const initMetric = require('./lib/initMetric.js');
- const observe = require('./lib/observe.js');
- const onHidden = require('./lib/onHidden.js');
- /*
- * Copyright 2020 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- /**
- * Calculates the [CLS](https://web.dev/cls/) value for the current page and
- * calls the `callback` function once the value is ready to be reported, along
- * with all `layout-shift` performance entries that were used in the metric
- * value calculation. The reported value is a `double` (corresponding to a
- * [layout shift score](https://web.dev/cls/#layout-shift-score)).
- *
- * If the `reportAllChanges` configuration option is set to `true`, the
- * `callback` function will be called as soon as the value is initially
- * determined as well as any time the value changes throughout the page
- * lifespan.
- *
- * _**Important:** CLS should be continually monitored for changes throughout
- * the entire lifespan of a page—including if the user returns to the page after
- * it's been hidden/backgrounded. However, since browsers often [will not fire
- * additional callbacks once the user has backgrounded a
- * page](https://developer.chrome.com/blog/page-lifecycle-api/#advice-hidden),
- * `callback` is always called when the page's visibility state changes to
- * hidden. As a result, the `callback` function might be called multiple times
- * during the same page load._
- */
- const onCLS = (onReport) => {
- const metric = initMetric.initMetric('CLS', 0);
- let report;
- let sessionValue = 0;
- let sessionEntries = [];
- // const handleEntries = (entries: Metric['entries']) => {
- const handleEntries = (entries) => {
- entries.forEach(entry => {
- // Only count layout shifts without recent user input.
- if (!entry.hadRecentInput) {
- const firstSessionEntry = sessionEntries[0];
- const lastSessionEntry = sessionEntries[sessionEntries.length - 1];
- // If the entry occurred less than 1 second after the previous entry and
- // less than 5 seconds after the first entry in the session, include the
- // entry in the current session. Otherwise, start a new session.
- if (
- sessionValue &&
- sessionEntries.length !== 0 &&
- entry.startTime - lastSessionEntry.startTime < 1000 &&
- entry.startTime - firstSessionEntry.startTime < 5000
- ) {
- sessionValue += entry.value;
- sessionEntries.push(entry);
- } else {
- sessionValue = entry.value;
- sessionEntries = [entry];
- }
- // If the current session value is larger than the current CLS value,
- // update CLS and the entries contributing to it.
- if (sessionValue > metric.value) {
- metric.value = sessionValue;
- metric.entries = sessionEntries;
- if (report) {
- report();
- }
- }
- }
- });
- };
- const po = observe.observe('layout-shift', handleEntries);
- if (po) {
- report = bindReporter.bindReporter(onReport, metric);
- const stopListening = () => {
- handleEntries(po.takeRecords() );
- report(true);
- };
- onHidden.onHidden(stopListening);
- return stopListening;
- }
- return;
- };
- exports.onCLS = onCLS;
- //# sourceMappingURL=getCLS.js.map
|