getCLS.js 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. /*
  2. * Copyright 2020 Google LLC
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * https://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. import { initMetric } from './lib/initMetric.js';
  17. import { observe } from './lib/observe.js';
  18. import { onHidden } from './lib/onHidden.js';
  19. import { onBFCacheRestore } from './lib/onBFCacheRestore.js';
  20. import { bindReporter } from './lib/bindReporter.js';
  21. export const getCLS = (onReport, reportAllChanges) => {
  22. let metric = initMetric('CLS', 0);
  23. let report;
  24. const entryHandler = (entry) => {
  25. // Only count layout shifts without recent user input.
  26. if (!entry.hadRecentInput) {
  27. metric.value += entry.value;
  28. metric.entries.push(entry);
  29. report();
  30. }
  31. };
  32. const po = observe('layout-shift', entryHandler);
  33. if (po) {
  34. report = bindReporter(onReport, metric, reportAllChanges);
  35. onHidden(() => {
  36. po.takeRecords().map(entryHandler);
  37. report();
  38. });
  39. onBFCacheRestore(() => {
  40. metric = initMetric('CLS', 0);
  41. report = bindReporter(onReport, metric, reportAllChanges);
  42. });
  43. }
  44. };