mizchi/crater/x/webvitals

mizchi/crater/x/webvitals does not have a README file

ContentReadiness

pub(all) struct ContentReadiness {
  lcp_ready : Bool
  lcp_time : Double?
  critical_resources_loaded : Bool
  a11y_ready : Bool
}

Overall content readiness state

ContentReadiness::from_lcp_tracker

source

fn ContentReadiness::from_lcp_tracker(tracker : LCPTracker, a11y_ready : Bool) -> ContentReadiness

Create readiness state from LCP tracker

ContentReadiness::is_interaction_ready

source

fn ContentReadiness::is_interaction_ready(self : ContentReadiness) -> Bool

Check if content is ready for interaction

ContentReadiness::new

source

fn ContentReadiness::new() -> ContentReadiness

LCPCandidate

source

pub(all) struct LCPCandidate {
  element_id : String
  element_type : LCPElementType
  size : Double
  x : Double
  y : Double
  width : Double
  height : Double
  resource_loaded : Bool
  render_time : Double?
  load_time : Double?
}

A candidate element for Largest Contentful Paint

LCPCandidate::get_lcp_time

source

fn LCPCandidate::get_lcp_time(self : LCPCandidate) -> Double?

Get the LCP time (load_time for images, render_time for text)

LCPCandidate::is_rendered

source

fn LCPCandidate::is_rendered(self : LCPCandidate) -> Bool

Check if this candidate is fully rendered (resource loaded if applicable)

LCPCandidate::new

source

fn LCPCandidate::new(element_id : String, element_type : LCPElementType, x : Double, y : Double, width : Double, height : Double) -> LCPCandidate

LCPCandidate::with_load_time

source

fn LCPCandidate::with_load_time(self : LCPCandidate, time : Double) -> LCPCandidate

LCPCandidate::with_render_time

source

fn LCPCandidate::with_render_time(self : LCPCandidate, time : Double) -> LCPCandidate

LCPCandidate::with_resource_loaded

source

fn LCPCandidate::with_resource_loaded(self : LCPCandidate, loaded : Bool) -> LCPCandidate

LCPElementType

source

pub(all) enum LCPElementType {
  Image(String)
  BackgroundImage(String)
  Video(String?)
  TextBlock
}

Types of elements that can be LCP candidates Per spec: , inside , poster, element with background-image, text block elements

impl Eq for LCPElementType

impl Show for LCPElementType

LCPTracker

source

pub(all) struct LCPTracker {
  candidates : Array[LCPCandidate]
  current_lcp : LCPCandidate?
  finalized : Bool
  viewport_width : Double
  viewport_height : Double
}

Tracks LCP candidates and determines the final LCP element

LCPTracker::add_candidate

source

fn LCPTracker::add_candidate(self : LCPTracker, candidate : LCPCandidate) -> Unit

Add a new LCP candidate

LCPTracker::finalize

source

fn LCPTracker::finalize(self : LCPTracker) -> Unit

Finalize LCP (called on first user input)

LCPTracker::get_lcp

source

fn LCPTracker::get_lcp(self : LCPTracker) -> LCPCandidate?

Get the current LCP candidate

LCPTracker::get_lcp_time

source

fn LCPTracker::get_lcp_time(self : LCPTracker) -> Double?

Get LCP time in milliseconds

LCPTracker::is_finalized

source

fn LCPTracker::is_finalized(self : LCPTracker) -> Bool

Check if LCP is finalized

LCPTracker::is_lcp_ready

source

fn LCPTracker::is_lcp_ready(self : LCPTracker) -> Bool

Check if LCP is ready (largest element fully rendered)

LCPTracker::new

source

fn LCPTracker::new(viewport_width : Double, viewport_height : Double) -> LCPTracker

LCPTracker::on_element_rendered

source

fn LCPTracker::on_element_rendered(self : LCPTracker, element_id : String, render_time : Double) -> Unit

Update render time for an element

LCPTracker::on_resource_loaded

source

fn LCPTracker::on_resource_loaded(self : LCPTracker, element_id : String, load_time : Double) -> Unit

Update resource load status for an element

LayoutShift

source

pub struct LayoutShift {
  impact_fraction : Double
  distance_fraction : Double
  score : Double
}

Result of CLS calculation

impl Show for LayoutShift

compute_element_shift

source

fn compute_element_shift(before : @mizchi/crater/types.BoundingRect
BoundingRect, after : @mizchi/crater/types.BoundingRect
BoundingRect, viewport : @mizchi/crater/types.Size
Size[Double]) -> LayoutShift

Calculate layout shift between two bounding rects viewport: the viewport size for normalization

compute_total

source

fn compute_total(before : Array[@mizchi/crater/types.BoundingRect
BoundingRect], after : Array[@mizchi/crater/types.BoundingRect
BoundingRect], viewport : @mizchi/crater/types.Size
Size[Double]) -> Double

Calculate total CLS score for multiple elements

extract_lcp_candidates

source

fn extract_lcp_candidates(layout : @mizchi/crater/layout/tree.LayoutTree
LayoutTree, viewport_width : Double, viewport_height : Double) -> Array[LCPCandidate]

Extract LCP candidates from a LayoutTree

Source Files

Site source Report issue Packages Build queue Skills Statistics

#ContentReadiness

#ContentReadiness::from_lcp_tracker

#ContentReadiness::is_interaction_ready

#ContentReadiness::new

#LCPCandidate

#LCPCandidate::get_lcp_time

#LCPCandidate::is_rendered

#LCPCandidate::new

#LCPCandidate::with_load_time

#LCPCandidate::with_render_time

#LCPCandidate::with_resource_loaded

#LCPElementType

#LCPTracker

#LCPTracker::add_candidate

#LCPTracker::finalize

#LCPTracker::get_lcp

#LCPTracker::get_lcp_time

#LCPTracker::is_finalized

#LCPTracker::is_lcp_ready

#LCPTracker::new

#LCPTracker::on_element_rendered

#LCPTracker::on_resource_loaded

#LayoutShift

#compute_element_shift

#compute_total

#extract_lcp_candidates

Source Files

ContentReadiness

ContentReadiness::from_lcp_tracker

ContentReadiness::is_interaction_ready

ContentReadiness::new

LCPCandidate

LCPCandidate::get_lcp_time

LCPCandidate::is_rendered

LCPCandidate::new

LCPCandidate::with_load_time

LCPCandidate::with_render_time

LCPCandidate::with_resource_loaded

LCPElementType

LCPTracker

LCPTracker::add_candidate

LCPTracker::finalize

LCPTracker::get_lcp

LCPTracker::get_lcp_time

LCPTracker::is_finalized

LCPTracker::is_lcp_ready

LCPTracker::new

LCPTracker::on_element_rendered

LCPTracker::on_resource_loaded

LayoutShift

compute_element_shift

compute_total

extract_lcp_candidates