@kntnt/engagement-metrics-overlay
v1.0.0
Published
Real-time visual overlay add-on for @kntnt/engagement-metrics.
Maintainers
Readme
@kntnt/engagement-metrics-overlay
Real-time visual overlay add-on for @kntnt/engagement-metrics. Colour-codes each tracked element by reading state and displays a live metrics panel — useful for debugging, demos, and experimenting with measurement parameters.
Installation
npm install @kntnt/engagement-metrics @kntnt/engagement-metrics-overlayUsage
ESM (bundler)
import { createMeasurer } from '@kntnt/engagement-metrics'
import { registerOverlay } from '@kntnt/engagement-metrics-overlay'
const measurer = createMeasurer({ selector: 'article p' })
registerOverlay(measurer)
measurer.start()IIFE (script tag)
<script src="https://unpkg.com/@kntnt/engagement-metrics/dist/kntnt-engagement-metrics.min.js"></script>
<script src="https://unpkg.com/@kntnt/engagement-metrics-overlay/dist/kntnt-engagement-metrics-overlay.min.js"></script>
<script>
KntntEngagementMetrics.measurer = KntntEngagementMetrics.start({ selector: 'article p' })
KntntEngagementMetrics.overlay.register()
</script>Toggle the overlay with Ctrl+Shift+D.
Documentation
See the main repository for full documentation.
License
MIT — Copyright (c) 2026 Kntnt Sweden AB
