0.4.0 • Published 5 months ago

@washingtonpost/storybook-addon-web-vitals v0.4.0

Weekly downloads
196
License
MIT
Repository
github
Last release
5 months ago

Storybook Addon Web Vitals

Storybook Addon Web Vitals can be used for instant feedback on loading, interactivity, and layout shift metric for each story. We use the web-vitals.

We report on INP, CLS, and LCP.

React Storybook Screenshot

Getting Started

Requires Storybook 8

First, install the addon

npm i -D @washingtonpost/storybook-addon-web-vitals

Then, add following content to .storybook/main.js:

module.exports = {
  addons: ["@washingtonpost/storybook-addon-web-vitals"],
};

Usage

See toolbar for feedback on INP, CLS and LCP

CLS changes will highlight offending elements based on results from web-vitals

New results are logged to the console as they come in to provide the full data object from web-vitals