Skip to content

A custom elements wrapper around the web-vitals lib.

License

Notifications You must be signed in to change notification settings

mathiasbynens/web-vitals-element

 
 

Repository files navigation

web-vitals-element

Bring web vitals quickly into your page using custom elements

web-vitals-element in styled and unstyled version

See it in action on CodePen.

Basic usage

<!-- Include the custom element script -->

<!-- Unstyled (installed locally) -->
<script src="node_modules/web-vitals-element/dist/web-vitals-element.min.js"></script>
<!-- Unstyled from unpkg.com -->
<script src="https://unpkg.com/[email protected]/dist/web-vitals-element.min.js"></script>

<!-- Styled (installed locally) -->
<script src="node_modules/web-vitals-element/dist/web-vitals-element.styled.min.js"></script>
<!-- Styled from unpkg.com -->
<script src="https://unpkg.com/[email protected]/dist/web-vitals-element.styled.min.js"></script>

The element does not render shadow DOM. You can style it like any other element in your HTML page.

After loading the element script, use the web-vitals element in your HTML.

<!-- Basic usage -->
<web-vitals />

<!-- Define the metrics you care about -->
<web-vitals cls fcp fid lcp ttfb />

<!-- Show message about not support metrics -->
<web-vitals show-unsupported />

Currently supported metrics: cls, fcp, fid, lcp, ttfb. Read more about these in the web-vitals documentation.

Contributing

I'd love to see more themes for the web vitals element box. If you're interested in contributing some fancy looks, please open an issue.

Code of conduct

This project underlies a code of conduct.

License

This project is released under MIT license.

About

A custom elements wrapper around the web-vitals lib.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 77.1%
  • CSS 11.6%
  • HTML 11.3%