Add canvas property to context that can be implemented by addons such…

… as @storybook/test
ComponentDriven · Jun 26, 2024 · d6ab1d5 · d6ab1d5
1 parent b13ced2
commit d6ab1d5
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/story.ts b/src/story.ts
@@ -260,6 +260,8 @@ export type BeforeEach<TRenderer extends Renderer = Renderer, TArgs = Args> = (
   context: StoryContext<TRenderer, TArgs>
 ) => Awaitable<CleanupCallback | void>;
 
+export interface Canvas {}
+
 export interface StoryContext<TRenderer extends Renderer = Renderer, TArgs = Args>
   extends StoryContextForEnhancers<TRenderer, TArgs>,
     Required<StoryContextUpdate<TArgs>> {
@@ -271,6 +273,7 @@ export interface StoryContext<TRenderer extends Renderer = Renderer, TArgs = Arg
   viewMode: ViewMode;
   step: StepFunction<TRenderer, TArgs>;
   context: this;
+  canvas: Canvas;
 }
 
 /** @deprecated Use {@link StoryContext} instead. */