web-vitals
@nuxtjs/web-vitals

适用于 Nuxt 的 Web Vitals
1.6 万次下载386 颗星v0.2.7
daliborgogicdaliborgogic
pi0pi0
AtinuxAtinux

Nuxt Web Vitals

Web Vitals：一个健康的 Nuxt 的核心模块

Web Vitals 是 Google 推出的一项倡议，旨在为对在网络上提供卓越用户体验至关重要的质量信号提供统一指导。

此模块将在每次页面浏览时收集这些指标，并使用 Navigator.sendBeacon() 或 fetch() 将它们发送给提供商

安装

npx nuxi@latest module add web-vitals

将 @nuxtjs/web-vitals 添加到 nuxt.config.js 的 modules 部分

export default defineNuxtConfig({
  modules: [
    '@nuxtjs/web-vitals'
  ]
})

⚠️ 如果您使用的是 Nuxt < v2.9，则必须将模块安装为 dependency（不带 --save-dev 或 --dev 标志）。如果您是 Nuxt 2.9+（但不是 Nuxt 3），则应将模块添加到 buildModules 而不是 modules。

选项

export default defineNuxtConfig({
  webVitals: {
    // provider: '', // auto detectd
    debug: false,
    disabled: false
  }
})

提供商

Google Analytics（分析）

向 GA 报告 WebVitals

创建 GA 媒体资源并获取 trackingID

提供 GOOGLE_ANALYTICS_ID 环境变量或在 nuxt.config 中设置

（顶级 googleAnalytics.id 支持向后兼容作为备用）

export default defineNuxtConfig({
  webVitals: {
    ga: { id: 'UA-XXXXXXXX-X' }
  }
})

行为 > 事件 > 概述 > 事件类别 > 事件操作

Events Actions

向 GTM 报告 WebVitals

创建 GTM 媒体资源并将标签管理器添加到您的网站。

export default defineNuxtConfig({
  webVitals: {
    gtm: {}
  }
})

Vercel Analytics

向 Vercel 报告 WebVitals

无需配置即可工作

基本日志记录器

向控制台报告 WebVitals

将指标输出到控制台而不是发送到远程提供商

export default defineNuxtConfig({
  webVitals: {
    provider: 'log',
    debug: true, // debug enable metrics reporting on dev environments
    disabled: false
  }
})

⚠️ 此提供商不通过网络发送 WebVitals，使用此方法无法检测到导航器扩展问题。

记录到自定义 API

向自定义 API 端点报告 WebVitals

export default defineNuxtConfig({
  webVitals: {
    provider: 'api',
    api: { url: '/api/web-vitals' }
    debug: true // debug enable metrics reporting on dev environments
  })

示例正文

export default defineNuxtConfig({
  href: 'https://:3000/',
  name: 'LCP',
  value: 303.599,
  rating: 'good',
  delta: 303.599,
  entries: [
    {
      name: '',
      entryType: 'largest-contentful-paint',
      startTime: 303.599,
      duration: 0,
      size: 5698,
      renderTime: 303.599,
      loadTime: 0,
      firstAnimatedFrameTime: 0,
      id: '',
      url: ''
    }
  ],
  id: 'v3-1669725914225-9792921995831',
  navigationType: 'reload'
})

许可证

MIT