@stacksjs/stx/dist/story/visual-testing.d.ts

A performant UI Framework. Powered by Bun.

import type { StoryContext } from './types';
/**
 * Run visual regression tests
 */
export declare function runScreenshotTests(ctx: StoryContext, options?: VisualTestOptions): Promise<VisualTestResult>;
/**
 * Generate visual test report HTML
 */
export declare function generateVisualTestReport(result: VisualTestResult): string;
/**
 * Visual test options
 */
export declare interface VisualTestOptions {
  update?: boolean
  threshold?: number
  snapshotDir?: string
  width?: number
  height?: number
  deviceScaleFactor?: number
  filter?: string[]
}
/**
 * Visual test result
 */
export declare interface VisualTestResult {
  total: number
  passed: number
  failed: number
  new: number
  failures: VisualTestFailure[]
  duration: number
}
/**
 * Visual test failure
 */
export declare interface VisualTestFailure {
  storyId: string
  variantId: string
  component: string
  message: string
  baselinePath?: string
  actualPath?: string
  diffPath?: string
  diffPercentage?: number
}