[{"data":1,"prerenderedAt":297},["ShallowReactive",2],{"doc:en:getting-started\u002Fusage":3,"doc-nav:en":269},{"id":4,"title":5,"body":6,"description":261,"extension":262,"meta":263,"navigation":69,"order":66,"path":264,"reviewed":69,"seo":265,"stem":266,"__hash__":267,"fallback":268},"docs\u002Fdocs\u002Fen\u002Fgetting-started\u002Fusage.md","Usage",{"type":7,"value":8,"toc":255},"minimark",[9,13,22,27,87,91,100,188,192,195,220,223,234,238,251],[10,11,5],"h1",{"id":12},"usage",[14,15,16,17,21],"p",{},"The plugin adds a single command to your tests, ",[18,19,20],"code",{},"matchImage",".",[23,24,26],"h2",{"id":25},"compare-an-element-or-the-page","Compare an element or the page",[28,29,34],"pre",{"className":30,"code":31,"language":32,"meta":33,"style":33},"language-ts shiki shiki-themes github-light-high-contrast github-dark-high-contrast","cy.get('.an-element-of-your-choice').matchImage();\n\n\u002F\u002F or the whole document\ncy.matchImage();\n","ts","",[18,35,36,64,71,78],{"__ignoreMap":33},[37,38,41,45,49,52,56,59,61],"span",{"class":39,"line":40},"line",1,[37,42,44],{"class":43},"suds8","cy.",[37,46,48],{"class":47},"sKwhi","get",[37,50,51],{"class":43},"(",[37,53,55],{"class":54},"sT6z2","'.an-element-of-your-choice'",[37,57,58],{"class":43},").",[37,60,20],{"class":47},[37,62,63],{"class":43},"();\n",[37,65,67],{"class":39,"line":66},2,[37,68,70],{"emptyLinePlaceholder":69},true,"\n",[37,72,74],{"class":39,"line":73},3,[37,75,77],{"class":76},"sLBg1","\u002F\u002F or the whole document\n",[37,79,81,83,85],{"class":39,"line":80},4,[37,82,44],{"class":43},[37,84,20],{"class":47},[37,86,63],{"class":43},[23,88,90],{"id":89},"configure-a-comparison","Configure a comparison",[14,92,93,94,99],{},"Options go in per call. The full list, with defaults, is on the ",[95,96,98],"a",{"href":97},"\u002Fdocs\u002Freference\u002Fconfiguration","Configuration"," page. These are the ones people reach for first:",[28,101,103],{"className":30,"code":102,"language":32,"meta":33,"style":33},"cy.matchImage({\n  \u002F\u002F forwarded to the Cypress screenshot API\n  screenshotConfig: { blackout: ['.element-to-be-blackouted'] },\n  \u002F\u002F pixelmatch options\n  diffConfig: { threshold: 0.01 },\n  \u002F\u002F create baselines that do not exist yet (default: true)\n  createMissingImages: false,\n  \u002F\u002F overwrite baselines: true | 'failures-only' | false (default: false)\n  updateImages: false,\n});\n",[18,104,105,114,119,130,135,148,154,166,172,182],{"__ignoreMap":33},[37,106,107,109,111],{"class":39,"line":40},[37,108,44],{"class":43},[37,110,20],{"class":47},[37,112,113],{"class":43},"({\n",[37,115,116],{"class":39,"line":66},[37,117,118],{"class":76},"  \u002F\u002F forwarded to the Cypress screenshot API\n",[37,120,121,124,127],{"class":39,"line":73},[37,122,123],{"class":43},"  screenshotConfig: { blackout: [",[37,125,126],{"class":54},"'.element-to-be-blackouted'",[37,128,129],{"class":43},"] },\n",[37,131,132],{"class":39,"line":80},[37,133,134],{"class":76},"  \u002F\u002F pixelmatch options\n",[37,136,138,141,145],{"class":39,"line":137},5,[37,139,140],{"class":43},"  diffConfig: { threshold: ",[37,142,144],{"class":143},"s-5SL","0.01",[37,146,147],{"class":43}," },\n",[37,149,151],{"class":39,"line":150},6,[37,152,153],{"class":76},"  \u002F\u002F create baselines that do not exist yet (default: true)\n",[37,155,157,160,163],{"class":39,"line":156},7,[37,158,159],{"class":43},"  createMissingImages: ",[37,161,162],{"class":143},"false",[37,164,165],{"class":43},",\n",[37,167,169],{"class":39,"line":168},8,[37,170,171],{"class":76},"  \u002F\u002F overwrite baselines: true | 'failures-only' | false (default: false)\n",[37,173,175,178,180],{"class":39,"line":174},9,[37,176,177],{"class":43},"  updateImages: ",[37,179,162],{"class":143},[37,181,165],{"class":43},[37,183,185],{"class":39,"line":184},10,[37,186,187],{"class":43},"});\n",[23,189,191],{"id":190},"clean-up-unused-images","Clean up unused images",[14,193,194],{},"Baselines pile up when tests get renamed or deleted. This run removes every plugin image that no test touched:",[28,196,200],{"className":197,"code":198,"language":199,"meta":33,"style":33},"language-bash shiki shiki-themes github-light-high-contrast github-dark-high-contrast","npx cypress run --expose \"pluginVisualRegressionCleanupUnusedImages=true\"\n","bash",[18,201,202],{"__ignoreMap":33},[37,203,204,208,211,214,217],{"class":39,"line":40},[37,205,207],{"class":206},"soyes","npx",[37,209,210],{"class":54}," cypress",[37,212,213],{"class":54}," run",[37,215,216],{"class":143}," --expose",[37,218,219],{"class":54}," \"pluginVisualRegressionCleanupUnusedImages=true\"\n",[14,221,222],{},"Run the full suite when you do this. If you filter to a few specs, the baselines of the specs you skipped count as unused too.",[14,224,225,226,229,230,233],{},"On Cypress older than 15.10 there is no ",[18,227,228],{},"--expose"," yet. Pass the same key with ",[18,231,232],{},"--env"," instead.",[23,235,237],{"id":236},"more","More",[14,239,240,241,243,244,250],{},"Everything else is on the ",[95,242,98],{"href":97}," page. If something is unclear or you've got an idea, ",[95,245,249],{"href":246,"rel":247},"https:\u002F\u002Fgithub.com\u002Fpixsame\u002Fpixsame\u002Fdiscussions",[248],"nofollow","GitHub discussions"," is where we talk about it.",[252,253,254],"style",{},"html pre.shiki code .suds8, html code.shiki .suds8{--shiki-default:#0E1116;--shiki-dark:#F0F3F6}html pre.shiki code .sKwhi, html code.shiki .sKwhi{--shiki-default:#622CBC;--shiki-dark:#DBB7FF}html pre.shiki code .sT6z2, html code.shiki .sT6z2{--shiki-default:#032563;--shiki-dark:#ADDCFF}html pre.shiki code .sLBg1, html code.shiki .sLBg1{--shiki-default:#66707B;--shiki-dark:#BDC4CC}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s-5SL, html code.shiki .s-5SL{--shiki-default:#023B95;--shiki-dark:#91CBFF}html pre.shiki code .soyes, html code.shiki .soyes{--shiki-default:#702C00;--shiki-dark:#FFB757}",{"title":33,"searchDepth":66,"depth":66,"links":256},[257,258,259,260],{"id":25,"depth":66,"text":26},{"id":89,"depth":66,"text":90},{"id":190,"depth":66,"text":191},{"id":236,"depth":66,"text":237},"Configure matchImage and keep your baselines tidy.","md",{},"\u002Fdocs\u002Fen\u002Fgetting-started\u002Fusage",{"title":5,"description":261},"docs\u002Fen\u002Fgetting-started\u002Fusage","vZuRglOBAYJ9AU-QhHkM8eptJ7qChtFVlX10aG2mQ2M",false,[270,274,278,280,282,285,288,291,294],{"path":271,"title":272,"group":273},"\u002Fdocs\u002Fgetting-started\u002Finstall","Install","getting-started",{"path":275,"title":276,"group":277},"\u002Fdocs\u002Fintegrations\u002Fcypress-plugin","Cypress plugin","integrations",{"path":97,"title":98,"group":279},"reference",{"path":281,"title":5,"group":273},"\u002Fdocs\u002Fgetting-started\u002Fusage",{"path":283,"title":284,"group":277},"\u002Fdocs\u002Fintegrations\u002Fgithub-app","GitHub App",{"path":286,"title":287,"group":279},"\u002Fdocs\u002Freference\u002Fmanifest","Manifest schema",{"path":289,"title":290,"group":273},"\u002Fdocs\u002Fgetting-started\u002Fmigrate-from-frsource","Migrate from @frsource",{"path":292,"title":293,"group":277},"\u002Fdocs\u002Fintegrations\u002Fplaywright-reporter","Playwright plugin",{"path":295,"title":296,"group":277},"\u002Fdocs\u002Fintegrations\u002Fvitest","Vitest plugin",1794530807668]