Merge pull request #92 from ComponentDriven/shilman/initial-globals

Add project initialGlobals & component/story globals, deprecate project globals
ComponentDriven · Jun 3, 2024 · fa77c25 · fa77c25
2 parents 81a58c9 + 6fb63cd
commit fa77c25
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/src/story.ts b/src/story.ts
@@ -390,7 +390,11 @@ export type ProjectAnnotations<
 > = BaseAnnotations<TRenderer, TArgs> & {
   argsEnhancers?: ArgsEnhancer<TRenderer, Args>[];
   argTypesEnhancers?: ArgTypesEnhancer<TRenderer, Args>[];
+  /**
+   * @deprecated Project `globals` renamed to `initiaGlobals`
+   */
   globals?: Globals;
+  initialGlobals?: Globals;
   globalTypes?: GlobalTypes;
   applyDecorators?: DecoratorApplicator<TRenderer, Args>;
   runStep?: StepRunner<TRenderer, TArgs>;
@@ -490,6 +494,11 @@ export interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TAr
    * Function that is executed after the story is rendered.
    */
   play?: PlayFunction<TRenderer, TArgs>;
+
+  /**
+   * Override the globals values for all stories in this component
+   */
+  globals?: Globals;
 }
 
 export type StoryAnnotations<
@@ -512,6 +521,11 @@ export type StoryAnnotations<
    */
   play?: PlayFunction<TRenderer, TArgs>;
 
+  /**
+   * Override the globals values for this story
+   */
+  globals?: Globals;
+
   /** @deprecated */
   story?: Omit<StoryAnnotations<TRenderer, TArgs>, 'story'>;
   // eslint-disable-next-line @typescript-eslint/ban-types