Skip to content

browser.traceView Experimental 5.0.0+

  • Type: boolean | { enabled?: boolean; snapshot?: 'always' | 'on-failure'; 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,
        snapshot: 'always',
        inlineImages: true,
        recordCanvas: true,
      },
    },
  },
})
OptionDefaultDescription
enabledfalseEnables Vitest trace-view artifact collection.
snapshot'always'Controls when DOM snapshots are captured for trace-view entries.
inlineImagesfalseInlines loaded <img> pixels into snapshots for more portable replay, useful in the HTML reporter.
recordCanvasfalseCaptures canvas pixels in snapshots.

browser.traceView.enabled

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

Enables Vitest trace-view artifact collection.

browser.traceView.snapshot

  • Type: 'always' | 'on-failure'
  • Default: 'always'
  • CLI: --browser.traceView.snapshot <policy>

Controls when DOM snapshots are captured for trace-view entries.

browser.traceView.inlineImages

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

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

browser.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.