Merge pull request #25497 from nkabrown/csfv3-story-object

CSF: Fix type hint for StoryObj type
storybookjs · Jan 8, 2024 · 6302cc6 · 6302cc6
2 parents 4335bf3 + 164c68c
commit 6302cc6
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 8 deletions.
diff --git a/code/frameworks/angular/src/client/public-types.ts b/code/frameworks/angular/src/client/public-types.ts
@@ -31,7 +31,7 @@ export type Meta<TArgs = Args> = ComponentAnnotations<AngularRenderer, Transform
 export type StoryFn<TArgs = Args> = AnnotatedStoryFn<AngularRenderer, TransformEventType<TArgs>>;
 
 /**
- * Story function that represents a CSFv3 component example.
+ * Story object that represents a CSFv3 component example.
  *
  * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
  */

diff --git a/code/renderers/html/src/public-types.ts b/code/renderers/html/src/public-types.ts
@@ -29,7 +29,7 @@ export type Meta<TArgs = Args> = ComponentAnnotations<HtmlRenderer, TArgs>;
 export type StoryFn<TArgs = Args> = AnnotatedStoryFn<HtmlRenderer, TArgs>;
 
 /**
- * Story function that represents a CSFv3 component example.
+ * Story object that represents a CSFv3 component example.
  *
  * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
  */

diff --git a/code/renderers/preact/src/public-types.ts b/code/renderers/preact/src/public-types.ts
@@ -29,7 +29,7 @@ export type Meta<TArgs = Args> = ComponentAnnotations<PreactRenderer, TArgs>;
 export type StoryFn<TArgs = Args> = AnnotatedStoryFn<PreactRenderer, TArgs>;
 
 /**
- * Story function that represents a CSFv3 component example.
+ * Story object that represents a CSFv3 component example.
  *
  * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
  */

diff --git a/code/renderers/react/src/public-types.ts b/code/renderers/react/src/public-types.ts
@@ -37,7 +37,7 @@ export type StoryFn<TCmpOrArgs = Args> = [TCmpOrArgs] extends [ComponentType<any
   : AnnotatedStoryFn<ReactRenderer, TCmpOrArgs>;
 
 /**
- * Story function that represents a CSFv3 component example.
+ * Story object that represents a CSFv3 component example.
  *
  * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
  */

diff --git a/code/renderers/server/src/public-types.ts b/code/renderers/server/src/public-types.ts
@@ -28,7 +28,7 @@ export type Meta<TArgs = Args> = ComponentAnnotations<ServerRenderer, TArgs>;
 export type StoryFn<TArgs = Args> = AnnotatedStoryFn<ServerRenderer, TArgs>;
 
 /**
- * Story function that represents a CSFv3 component example.
+ * Story object that represents a CSFv3 component example.
  *
  * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
  */

diff --git a/code/renderers/svelte/src/public-types.ts b/code/renderers/svelte/src/public-types.ts
@@ -36,7 +36,7 @@ export type StoryFn<TCmpOrArgs = Args> = TCmpOrArgs extends SvelteComponentTyped
   : AnnotatedStoryFn<SvelteRenderer, TCmpOrArgs>;
 
 /**
- * Story function that represents a CSFv3 component example.
+ * Story object that represents a CSFv3 component example.
  *
  * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
  */

diff --git a/code/renderers/vue3/src/public-types.ts b/code/renderers/vue3/src/public-types.ts
@@ -40,7 +40,7 @@ export type StoryFn<TCmpOrArgs = Args> = AnnotatedStoryFn<
 >;
 
 /**
- * Story function that represents a CSFv3 component example.
+ * Story object that represents a CSFv3 component example.
  *
  * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
  */

diff --git a/code/renderers/web-components/src/public-types.ts b/code/renderers/web-components/src/public-types.ts
@@ -29,7 +29,7 @@ export type Meta<TArgs = Args> = ComponentAnnotations<WebComponentsRenderer, TAr
 export type StoryFn<TArgs = Args> = AnnotatedStoryFn<WebComponentsRenderer, TArgs>;
 
 /**
- * Story function that represents a CSFv3 component example.
+ * Story object that represents a CSFv3 component example.
  *
  * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -40,7 +40,7 @@ export type StoryFn<TCmpOrArgs = Args> = AnnotatedStoryFn< @@
     >;
     /**
-     * Story function that represents a CSFv3 component example.
+     * Story object that represents a CSFv3 component example.
      *
      * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
      */
@@ Expand Down @@