Merge branch 'main' into 312-api-channel-proxy

CHANGELOG.md

@@ -1,3 +1,15 @@
+# v1.8.0 (Thu Aug 29 2024)
+
+#### 🚀 Enhancement
+
+- Add `paramKey: "chromatic"` to allow disabling the VTA panel through story parameters [#334](https://github.com/chromaui/addon-visual-tests/pull/334) ([@mellm0](https://github.com/mellm0))
+
+#### Authors: 1
+
+- Mell ([@mellm0](https://github.com/mellm0))
+
+---
+
 # v1.7.0 (Tue Aug 20 2024)
 
 #### 🚀 Enhancement

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chromatic-com/storybook",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Catch unexpected visual changes & UI bugs in your stories",
   "keywords": [
     "storybook-addons",

src/constants.ts

@@ -27,6 +27,7 @@ export const SELECTED_BROWSER_ID = `${ADDON_ID}/selectedBrowserId`;
 export const TELEMETRY = `${ADDON_ID}/telemetry`;
 export const ENABLE_FILTER = `${ADDON_ID}/enableFilter`;
 export const REMOVE_ADDON = `${ADDON_ID}/removeAddon`;
+export const PARAM_KEY = "chromatic";
 
 export const FETCH_ABORTED = `${ADDON_ID}/ChannelFetch/aborted`;
 export const FETCH_REQUEST = `${ADDON_ID}ChannelFetch/request`;

src/manager.tsx

@@ -6,7 +6,7 @@ import React from "react";
 
 import { SidebarBottom } from "./components/SidebarBottom";
 import { SidebarTop } from "./components/SidebarTop";
-import { ADDON_ID, PANEL_ID, SIDEBAR_BOTTOM_ID, SIDEBAR_TOP_ID } from "./constants";
+import { ADDON_ID, PANEL_ID, PARAM_KEY, SIDEBAR_BOTTOM_ID, SIDEBAR_TOP_ID } from "./constants";
 import { Panel } from "./Panel";
 
 let heartbeatTimeout: NodeJS.Timeout;
@@ -18,6 +18,7 @@ addons.register(ADDON_ID, (api) => {
   addons.add(PANEL_ID, {
     type: Addon_TypesEnum.PANEL,
     title: "Visual Tests",
+    paramKey: PARAM_KEY,
     match: ({ viewMode }) => viewMode === "story",
     render: ({ active }) => <Panel active={!!active} api={api} />,
   });