Merge pull request #334 from mellm0/add-param-key

Add `paramKey: "chromatic"` to allow disabling the VTA panel through story parameters
chromaui · Aug 29, 2024 · 97ad164 · 97ad164
2 parents a6ddf15 + ca3d66e
commit 97ad164
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/src/constants.ts b/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 CONFIG_OVERRIDES = {
   // Local changes should never be auto-accepted

diff --git a/src/manager.tsx b/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} />,
   });