Back to Vitest

browser.traceView | Config

docs/config/browser/traceview.md

5.0.01.9 KB
Original Source

browser.traceView <Badge type="warning" text="Experimental" /> <Version>5.0.0</Version>

  • Type: boolean | { enabled?: boolean; recordCanvas?: boolean; inlineImages?: boolean }
  • CLI: --browser.traceView
  • Default: false

Enable trace-view collection for browser tests. Vitest captures DOM snapshots for browser interactions and can show them in the browser UI, Vitest UI, or HTML reporter when those surfaces are enabled — no external tools required.

ts
export default defineConfig({
  test: {
    browser: {
      traceView: true,
    },
  },
})

Use the object form to enable additional snapshot fidelity options:

ts
export default defineConfig({
  test: {
    browser: {
      traceView: {
        enabled: true,
        inlineImages: true,
        recordCanvas: true,
      },
    },
  },
})
OptionDefaultDescription
enabledfalseEnables Vitest trace-view artifact collection.
inlineImagesfalseInlines loaded `` pixels into snapshots for more portable replay, useful in the HTML reporter.
recordCanvasfalseCaptures canvas pixels in snapshots.

browser.traceView.enabled {#traceview-enabled}

  • Type: boolean
  • Default: false
  • CLI: --browser.traceView.enabled

Enables Vitest trace-view artifact collection.

browser.traceView.inlineImages {#traceview-inlineimages}

  • Type: boolean
  • Default: false
  • CLI: --browser.traceView.inlineImages

Inlines loaded `` pixels into snapshots for more portable replay, useful in the HTML reporter.

browser.traceView.recordCanvas {#traceview-recordcanvas}

  • Type: boolean
  • Default: false
  • CLI: --browser.traceView.recordCanvas

Captures canvas pixels in snapshots. This enables a weaker replay iframe sandbox because rrweb needs scripts to redraw canvas data.

See Trace View for full documentation.