@astrojs/web-vitals

v3.0.1 GitHub npm Changelog

Introduction

This Astro integration enables tracking real-world website performance and storing the data in Astro DB. That data will be used in the StudioCMS dashboard to show the performance metrics of your website from the real world over time.

Installation

Astro Method
Manual Method

Install the package and add to your astro config using the following command:
- npm
- pnpm
- yarn
Terminal window
npx astro add @astrojs/web-vitals
Terminal window
pnpm astro add @astrojs/web-vitals
Terminal window
yarn astro add @astrojs/web-vitals
Push the new configuration to your remote database:
- npm
- pnpm
- yarn
Terminal window
npx astro db push
Terminal window
pnpm astro db push
Terminal window
yarn astro db push

Install the package using the following command:
- npm
- pnpm
- yarn
Terminal window
npm i @astrojs/web-vitals
Terminal window
pnpm add @astrojs/web-vitals
Terminal window
yarn add @astrojs/web-vitals

Add @astrojs/web-vitals to your astro config file:

import 
function node(userOptions: UserOptions): AstroIntegration
node from '@astrojs/node';
import 
const studioCMS: (options?: {
    dbStartPage?: boolean | undefined;
    rendererConfig?: {
        studiocms?: false | {
            callouts?: false | {
                theme?: "github" | "obsidian" | "vitepress" | undefined;
            } | undefined;
            autoLinkHeadings?: boolean | undefined;
            discordSubtext?: boolean | undefined;
            sanitize?: {
                allowElements?: string[] | undefined;
                blockElements?: string[] | undefined;
                dropElements?: string[] | undefined;
                allowAttributes?: Record<string, string[]> | undefined;
                dropAttributes?: Record<string, string[]> | undefined;
                allowComponents?: boolean | undefined;
                allowCustomElements?: boolean | undefined;
                allowComments?: boolean | undefined;
            } | undefined;
        } | undefined;
        renderer?: "studiocms" | CustomRenderer | "astro" | "markdoc" | "mdx" | undefined;
        markdocConfig?: {
            renderType?: "html" | MarkdocRenderer | "react-static" | undefined;
            argParse?: {
                file?: string | undefined;
                slots?: boolean | undefined;
                location?: boolean | undefined;
            } | undefined;
            transformConfig?: {
                tags?: Record<string, {}> | undefined;
                validation?: {
                    parents?: any[] | undefined;
                    validateFunctions?: boolean | undefined;
                    environment?: string | undefined;
                } | undefined;
                nodes ...
StudioCMS Integration
A CMS built for Astro by the Astro Community for the Astro Community.
@see ― The GitHub Repo: withstudiocms/studiocms for more information on how to contribute to StudioCMS.
@see ― The StudioCMS Docs for more information on how to use StudioCMS.
studioCMS from 'studiocms';
import 
function db(): AstroIntegration[]
db from '@astrojs/db';
import 
function webVitals({ deprecated }?: {
    deprecated?: boolean;
}): AstroIntegration
webVitals from '@astrojs/web-vitals';
import { 
function defineConfig<const TLocales extends Locales = never, const TDriver extends SessionDriverName = never>(config: AstroUserConfig<TLocales, TDriver>): AstroUserConfig<TLocales, TDriver>
See the full Astro Configuration API Documentation
https://astro.build/config
defineConfig } from 'astro/config';

export default 
defineConfig<never, never>(config: AstroUserConfig<never, never>): AstroUserConfig<never, never>
See the full Astro Configuration API Documentation
https://astro.build/config
defineConfig({
   
AstroUserConfig<TLocales extends Locales = never, TSession extends SessionDriverName = never>.site?: string@name ― site
@type ― {string}
@description 
Your final, deployed URL. Astro uses this full URL to generate your sitemap and canonical URLs in your final build. It is strongly recommended that you set this configuration to get the most out of Astro.
{
  site: 'https://www.my-site.dev'
}
site: 'https://demo.studiocms.dev/',
   
AstroUserConfig<TLocales extends Locales = never, TSession extends SessionDriverName = never>.output?: "server" | "static"@name ― output
@type ― {('static' | 'server')}
@default ― 'static'
@see ― adapter *
@description 
Specifies the output target for builds.

'static' - Prerender all your pages by default, outputting a completely static site if none of your pages opt out of prerendering.
'server' - Use server-side rendering (SSR) for all pages by default, always outputting a server-rendered site.

import { defineConfig } from 'astro/config';

export default defineConfig({
  output: 'static'
})
output: 'server',
   
AstroUserConfig<TLocales extends Locales = never, TSession extends SessionDriverName = never>.adapter?: AstroIntegration@name ― adapter
@see ― output *
@description 
Deploy to your favorite server, serverless, or edge host with build adapters. Import one of our first-party adapters for Netlify, Vercel, and more to engage Astro SSR.
See our On-demand Rendering guide for more on SSR, and our deployment guides for a complete list of hosts.
import netlify from '@astrojs/netlify';
{
  // Example: Build for Netlify serverless deployment
  adapter: netlify(),
}
adapter: 
function node(userOptions: UserOptions): AstroIntegration
node({ 
UserOptions.mode: "standalone" | "middleware"
Specifies the mode that the adapter builds to.

'middleware' - Build to middleware, to be used within another Node.js server, such as Express.
'standalone' - Build to a standalone server. The server starts up just by running the built script.
mode: "standalone" }),
   
AstroUserConfig<TLocales extends Locales = never, TSession extends SessionDriverName = never>.integrations?: (false | AstroIntegration | (false | AstroIntegration | null | undefined)[] | null | undefined)[]@name ― integrations
@description 
Extend Astro with custom integrations. Integrations are your one-stop-shop for adding framework support (like Solid.js), new features (like sitemaps), and new libraries (like Partytown).
Read our Integrations Guide for help getting started with Astro Integrations.
import react from '@astrojs/react';
import mdx from '@astrojs/mdx';
{
  // Example: Add React + MDX support to Astro
  integrations: [react(), mdx()]
}
integrations: [
       
function db(): AstroIntegration[]
db(), // REQUIRED
       
function webVitals({ deprecated }?: {
    deprecated?: boolean;
}): AstroIntegration
webVitals(),
       
function studioCMS(options?: {
    dbStartPage?: boolean | undefined;
    rendererConfig?: {
        studiocms?: false | {
            callouts?: false | {
                theme?: "github" | "obsidian" | "vitepress" | undefined;
            } | undefined;
            autoLinkHeadings?: boolean | undefined;
            discordSubtext?: boolean | undefined;
            sanitize?: {
                allowElements?: string[] | undefined;
                blockElements?: string[] | undefined;
                dropElements?: string[] | undefined;
                allowAttributes?: Record<string, string[]> | undefined;
                dropAttributes?: Record<string, string[]> | undefined;
                allowComponents?: boolean | undefined;
                allowCustomElements?: boolean | undefined;
                allowComments?: boolean | undefined;
            } | undefined;
        } | undefined;
        renderer?: "studiocms" | CustomRenderer | "astro" | "markdoc" | "mdx" | undefined;
        markdocConfig?: {
            renderType?: "html" | MarkdocRenderer | "react-static" | undefined;
            argParse?: {
                file?: string | undefined;
                slots?: boolean | undefined;
                location?: boolean | undefined;
            } | undefined;
            transformConfig?: {
                tags?: Record<string, {}> | undefined;
                validation?: {
                    parents?: any[] | undefined;
                    validateFunctions?: boolean | undefined;
                    environment?: string | undefined;
                } | undefined;
                nodes ...
StudioCMS Integration
A CMS built for Astro by the Astro Community for the Astro Community.
@see ― The GitHub Repo: withstudiocms/studiocms for more information on how to contribute to StudioCMS.
@see ― The StudioCMS Docs for more information on how to use StudioCMS.
studioCMS(),
   ],
});

npm i @astrojs/web-vitals

pnpm add @astrojs/web-vitals

yarn add @astrojs/web-vitals

Push the new configuration to your remote database:
- npm
- pnpm
- yarn
Terminal window
npx astro db push
Terminal window
pnpm astro db push
Terminal window
yarn astro db push