Skip to content

adobe/helix-rum-enhancer

Helix RUM Enhancer

Add advanced functionality to Helix RUM Collection (client-side)

Status

codecov GitHub Actions GitHub license GitHub issues semantic-release

Usage

This library is meant to be used in conjunction with and loaded by the sampleRUM function found in Helix Project Boilerplate or Helix RUM JS.

It will add following new checkpoints:

  • cwv: Core Web Vitals Collection
  • pagesviewed: number that helps to estimate how many pages are seen in average by a user.
  • click: A click anywhere in the document
  • viewblock: A Helix block has been scrolled into the viewport
  • viewmedia: An image or video hosted by Helix Media Bus has been scrolled into the viewport
  • reload, navigate, enter: depending on how the current page was accessed
  • formsubmit: when a form is submitted
  • leave: when the user leaves the page

Development

Build

$ npm install

Test

$ npm test

Lint

$ npm run lint