GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-06 06:21:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Adopt T prefix for generics in all renderers

Browse Source
This commit is contained in:
Kasper Peulen 2022-10-26 11:40:15 +02:00
parent 0d3b8280d5
commit eed8bdcdf4
8 changed files with 36 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
code/frameworks/angular/src/client/public-types.ts
View File

@ -30,7 +30,8 @@ export type StoryFn<TArgs = Args> = AnnotatedStoryFn<AngularFramework, TArgs>;
export type StoryObj<TArgs = Args> = StoryAnnotations<AngularFramework, TArgs>;
/**
* @deprecated Use `StoryFn` instead. Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* @deprecated Use `StoryFn` instead.
* Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* You can read more about the CSF3 format here: https://storybook.js.org/blog/component-story-format-3-0/
*
* Story function that represents a CSFv2 component example.

3
code/renderers/html/src/public-types.ts
View File

@ -30,7 +30,8 @@ export type StoryFn<TArgs = Args> = AnnotatedStoryFn<HtmlFramework, TArgs>;
export type StoryObj<TArgs = Args> = StoryAnnotations<HtmlFramework, TArgs>;
/**
* @deprecated Use `StoryFn` instead. Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* @deprecated Use `StoryFn` instead.
* Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* You can read more about the CSF3 format here: https://storybook.js.org/blog/component-story-format-3-0/
*
* Story function that represents a CSFv2 component example.

3
code/renderers/preact/src/public-types.ts
View File

@ -30,7 +30,8 @@ export type StoryFn<TArgs = Args> = AnnotatedStoryFn<PreactFramework, TArgs>;
export type StoryObj<TArgs = Args> = StoryAnnotations<PreactFramework, TArgs>;
/**
* @deprecated Use `StoryFn` instead. Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* @deprecated Use `StoryFn` instead.
* Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* You can read more about the CSF3 format here: https://storybook.js.org/blog/component-story-format-3-0/
*
* Story function that represents a CSFv2 component example.

3
code/renderers/react/src/public-types.ts
View File

@ -102,7 +102,8 @@ export type ComponentStoryFn<T extends JSXElement> = StoryFn<ComponentProps<T>>;
export type ComponentStoryObj<T extends JSXElement> = StoryObj<ComponentProps<T>>;
/**
* @deprecated Use `StoryFn` instead. Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* @deprecated Use `StoryFn` instead.
* Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* You can read more about the CSF3 format here: https://storybook.js.org/blog/component-story-format-3-0/
*
* Story function that represents a CSFv2 component example.

3
code/renderers/server/src/public-types.ts
View File

@ -30,7 +30,8 @@ export type StoryFn<TArgs = Args> = AnnotatedStoryFn<ServerFramework, TArgs>;
export type StoryObj<TArgs = Args> = StoryAnnotations<ServerFramework, TArgs>;
/**
* @deprecated Use `StoryFn` instead. Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* @deprecated Use `StoryFn` instead.
* Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* You can read more about the CSF3 format here: https://storybook.js.org/blog/component-story-format-3-0/
*
* Story function that represents a CSFv2 component example.

23
code/renderers/vue/src/public-types.ts
View File

@ -19,12 +19,12 @@ export type { Args, ArgTypes, Parameters, StoryContext } from '@storybook/types'
*
* @see [Default export](https://storybook.js.org/docs/formats/component-story-format/#default-export)
*/
export type Meta<CmpOrArgs = Args> = CmpOrArgs extends Component<any>
export type Meta<TCmpOrArgs = Args> = TCmpOrArgs extends Component<any>
? ComponentAnnotations<
VueFramework,
unknown extends ComponentProps<CmpOrArgs> ? CmpOrArgs : ComponentProps<CmpOrArgs>
unknown extends ComponentProps<TCmpOrArgs> ? TCmpOrArgs : ComponentProps<TCmpOrArgs>
>
: ComponentAnnotations<VueFramework, CmpOrArgs>;
: ComponentAnnotations<VueFramework, TCmpOrArgs>;
/**
* Story function that represents a CSFv2 component example.
@ -38,23 +38,23 @@ export type StoryFn<TArgs = Args> = AnnotatedStoryFn<VueFramework, TArgs>;
*
* @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
*/
export type StoryObj<MetaOrCmpOrArgs = Args> = MetaOrCmpOrArgs extends {
export type StoryObj<TMetaOrCmpOrArgs = Args> = TMetaOrCmpOrArgs extends {
render?: ArgsStoryFn<VueFramework, any>;
component?: infer C;
args?: infer DefaultArgs;
}
? MetaOrCmpOrArgs extends Component<any>
? StoryAnnotations<VueFramework, ComponentProps<MetaOrCmpOrArgs>>
: Simplify<ComponentProps<C> & ArgsFromMeta<VueFramework, MetaOrCmpOrArgs>> extends infer TArgs
? TMetaOrCmpOrArgs extends Component<any>
? StoryAnnotations<VueFramework, ComponentProps<TMetaOrCmpOrArgs>>
: Simplify<ComponentProps<C> & ArgsFromMeta<VueFramework, TMetaOrCmpOrArgs>> extends infer TArgs
? StoryAnnotations<
VueFramework,
TArgs,
SetOptional<TArgs, Extract<keyof TArgs, keyof DefaultArgs>>
>
: never
: MetaOrCmpOrArgs extends Component<any>
? StoryAnnotations<VueFramework, ComponentProps<MetaOrCmpOrArgs>>
: StoryAnnotations<VueFramework, MetaOrCmpOrArgs>;
: TMetaOrCmpOrArgs extends Component<any>
? StoryAnnotations<VueFramework, ComponentProps<TMetaOrCmpOrArgs>>
: StoryAnnotations<VueFramework, TMetaOrCmpOrArgs>;
type ComponentProps<C> = C extends ExtendedVue<any, any, any, any, infer P>
? P
@ -63,7 +63,8 @@ type ComponentProps<C> = C extends ExtendedVue<any, any, any, any, infer P>
: unknown;
/**
* @deprecated Use `StoryFn` instead. Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* @deprecated Use `StoryFn` instead.
* Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* You can read more about the CSF3 format here: https://storybook.js.org/blog/component-story-format-3-0/
*
* Story function that represents a CSFv2 component example.

23
code/renderers/vue3/src/public-types.ts
View File

@ -17,9 +17,9 @@ import type { VueFramework } from './types';
*
* @see [Default export](https://storybook.js.org/docs/formats/component-story-format/#default-export)
*/
export type Meta<CmpOrArgs = Args> = CmpOrArgs extends ComponentOptions<infer Props>
? ComponentAnnotations<VueFramework, unknown extends Props ? CmpOrArgs : Props>
: ComponentAnnotations<VueFramework, CmpOrArgs>;
export type Meta<TCmpOrArgs = Args> = TCmpOrArgs extends ComponentOptions<infer Props>
? ComponentAnnotations<VueFramework, unknown extends Props ? TCmpOrArgs : Props>
: ComponentAnnotations<VueFramework, TCmpOrArgs>;
/**
* Story function that represents a CSFv2 component example.
@ -33,13 +33,13 @@ export type StoryFn<TArgs = Args> = AnnotatedStoryFn<VueFramework, TArgs>;
*
* @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
*/
export type StoryObj<MetaOrCmpOrArgs = Args> = MetaOrCmpOrArgs extends {
export type StoryObj<TMetaOrCmpOrArgs = Args> = TMetaOrCmpOrArgs extends {
render?: ArgsStoryFn<VueFramework, any>;
component?: infer Component;
args?: infer DefaultArgs;
}
? Simplify<
ComponentProps<Component> & ArgsFromMeta<VueFramework, MetaOrCmpOrArgs>
ComponentProps<Component> & ArgsFromMeta<VueFramework, TMetaOrCmpOrArgs>
> extends infer TArgs
? StoryAnnotations<
VueFramework,
@ -47,17 +47,18 @@ export type StoryObj<MetaOrCmpOrArgs = Args> = MetaOrCmpOrArgs extends {
SetOptional<TArgs, Extract<keyof TArgs, keyof DefaultArgs>>
>
: never
: MetaOrCmpOrArgs extends ConcreteComponent<any>
? StoryAnnotations<VueFramework, ComponentProps<MetaOrCmpOrArgs>>
: StoryAnnotations<VueFramework, MetaOrCmpOrArgs>;
: TMetaOrCmpOrArgs extends ConcreteComponent<any>
? StoryAnnotations<VueFramework, ComponentProps<TMetaOrCmpOrArgs>>
: StoryAnnotations<VueFramework, TMetaOrCmpOrArgs>;
type ComponentProps<Component> = Component extends ComponentOptions<infer P>
type ComponentProps<C> = C extends ComponentOptions<infer P>
? P
: Component extends FunctionalComponent<infer P>
: C extends FunctionalComponent<infer P>
? P
: unknown;
/**
* @deprecated Use `StoryFn` instead. Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* @deprecated Use `StoryFn` instead.
* Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* You can read more about the CSF3 format here: https://storybook.js.org/blog/component-story-format-3-0/
*
* Story function that represents a CSFv2 component example.

3
code/renderers/web-components/src/public-types.ts
View File

@ -28,7 +28,8 @@ export type StoryFn<TArgs = Args> = AnnotatedStoryFn<WebComponentsFramework, TAr
export type StoryObj<TArgs = Args> = StoryAnnotations<WebComponentsFramework, TArgs>;
/**
* @deprecated Use `StoryFn` instead. Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* @deprecated Use `StoryFn` instead.
* Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
* You can read more about the CSF3 format here: https://storybook.js.org/blog/component-story-format-3-0/
*
* Story function that represents a CSFv2 component example.