Deprecate key in addon render function as it is not available anymore

storybookjs · Aug 10, 2023 · d4ca02a · d4ca02a
1 parent 354d1ba
commit d4ca02a
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/code/lib/types/src/modules/addons.ts b/code/lib/types/src/modules/addons.ts
@@ -307,7 +307,11 @@ export type BaseStory<TArgs, StoryFnReturnType> =
 
 export interface Addon_RenderOptions {
   active: boolean;
-  key: string;
+  /**
+   * @deprecated You should not use key anymore as of Storybook 7.2 this render method is invoked as a React component.
+   * This property will be removed in 8.0.
+   * */
+  key?: unknown;
 }
 
 /**