vitest.dev / vitest
[READ-ONLY] Mirror of https://github.com/vitest-dev/vitest. Next generation testing framework powered by Vite. vitest.dev
test testing-tools vite
Star
Fork 0
Watch
vitest docs config browser traceview.md
2.3 kB
Markdown
at attempts-api-prototype

title: browser.traceView | Config outline: deep #

browser.traceView 5.0.0 #

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

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

Use the object form to enable additional snapshot fidelity options:

export default defineConfig({
  test: {
    browser: {
      traceView: {
        enabled: true,
        inlineImages: true,
        recordCanvas: true,
      },
    },
  },
})
Option Default Description
enabled false Enables Vitest trace-view artifact collection.
inlineImages false Inlines loaded <img> pixels into snapshots for more portable replay, useful in the HTML reporter.
recordCanvas false Captures 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 <img> 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.