diff --git a/MIGRATION.md b/MIGRATION.md index 995cd649dc84..a965c419e597 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -34,6 +34,7 @@ - [props from WithTooltipComponent from @storybook/components](#props-from-withtooltipcomponent-from-storybookcomponents) - [LinkTo direct import from addon-links](#linkto-direct-import-from-addon-links) - [DecoratorFn, Story, ComponentStory, ComponentStoryObj, ComponentStoryFn and ComponentMeta TypeScript types](#decoratorfn-story-componentstory-componentstoryobj-componentstoryfn-and-componentmeta-typescript-types) + - ["Framework" TypeScript types](#framework-typescript-types) - [From version 7.5.0 to 7.6.0](#from-version-750-to-760) - [CommonJS with Vite is deprecated](#commonjs-with-vite-is-deprecated) - [Using implicit actions during rendering is deprecated](#using-implicit-actions-during-rendering-is-deprecated) @@ -628,6 +629,10 @@ The `DecoratorFn` type is now removed in favor of `Decorator`. [More info](#rena For React, the `ComponentStory`, `ComponentStoryObj`, `ComponentStoryFn` and `ComponentMeta` types are now removed in favor of `StoryFn`, `StoryObj` and `Meta`. [More info](#componentstory-componentstoryobj-componentstoryfn-and-componentmeta-types-are-deprecated). +#### "Framework" TypeScript types + +The Framework types such as `ReactFramework` are now removed in favor of Renderer types such as `ReactRenderer`. This affects all frameworks. [More info](#renamed-xframework-to-xrenderer). + ## From version 7.5.0 to 7.6.0 #### CommonJS with Vite is deprecated diff --git a/code/frameworks/angular/src/client/types.ts b/code/frameworks/angular/src/client/types.ts index ef3c4428c21e..100b3e912312 100644 --- a/code/frameworks/angular/src/client/types.ts +++ b/code/frameworks/angular/src/client/types.ts @@ -37,10 +37,6 @@ export interface StoryFnAngularReturnType { userDefinedTemplate?: boolean; } -/** - * @deprecated Use `AngularRenderer` instead. - */ -export type AngularFramework = AngularRenderer; export interface AngularRenderer extends WebRenderer { component: any; storyResult: StoryFnAngularReturnType; diff --git a/code/frameworks/ember/src/client/preview/types.ts b/code/frameworks/ember/src/client/preview/types.ts index 5df0b2632aa5..147f4928f240 100644 --- a/code/frameworks/ember/src/client/preview/types.ts +++ b/code/frameworks/ember/src/client/preview/types.ts @@ -13,10 +13,6 @@ export interface OptionsArgs { element: any; } -/** - * @deprecated Use `EmberRenderer` instead. - */ -export type EmberFramework = EmberRenderer; export interface EmberRenderer extends WebRenderer { component: any; storyResult: OptionsArgs; diff --git a/code/renderers/html/src/types.ts b/code/renderers/html/src/types.ts index e8f264aed808..c6152653b11b 100644 --- a/code/renderers/html/src/types.ts +++ b/code/renderers/html/src/types.ts @@ -14,10 +14,6 @@ export interface ShowErrorArgs { description: string; } -/** - * @deprecated Use `HtmlRenderer` instead. - */ -export type HtmlFramework = HtmlRenderer; export interface HtmlRenderer extends WebRenderer { component: string | HTMLElement | ArgsStoryFn; storyResult: StoryFnHtmlReturnType; diff --git a/code/renderers/preact/src/types.ts b/code/renderers/preact/src/types.ts index 233528349a1e..1a8e545c8540 100644 --- a/code/renderers/preact/src/types.ts +++ b/code/renderers/preact/src/types.ts @@ -10,13 +10,6 @@ export interface ShowErrorArgs { description: string; } -/** - * @dep - */ -/** - * @deprecated Use `PreactRenderer` instead. - */ -export type PreactFramework = PreactRenderer; export interface PreactRenderer extends WebRenderer { component: AnyComponent; storyResult: StoryFnPreactReturnType; diff --git a/code/renderers/react/src/types.ts b/code/renderers/react/src/types.ts index 637f1b5a5ebc..b90766013de5 100644 --- a/code/renderers/react/src/types.ts +++ b/code/renderers/react/src/types.ts @@ -3,10 +3,6 @@ import type { WebRenderer } from '@storybook/types'; export type { RenderContext, StoryContext } from '@storybook/types'; -/** - * @deprecated Use `ReactRenderer` instead. - */ -export type ReactFramework = ReactRenderer; export interface ReactRenderer extends WebRenderer { component: ComponentType; storyResult: StoryFnReactReturnType; diff --git a/code/renderers/server/src/types.ts b/code/renderers/server/src/types.ts index 4b562f771fb7..c386ec965df0 100644 --- a/code/renderers/server/src/types.ts +++ b/code/renderers/server/src/types.ts @@ -5,10 +5,6 @@ export type { RenderContext } from '@storybook/types'; export type StoryFnServerReturnType = any; export type StoryContext = StoryContextBase; -/** - * @deprecated Use `ServerRenderer` instead. - */ -export type ServerFramework = ServerRenderer; export interface ServerRenderer extends WebRenderer { component: string; storyResult: StoryFnServerReturnType; diff --git a/code/renderers/vue3/src/types.ts b/code/renderers/vue3/src/types.ts index 1094f6780625..dfa6bed7870c 100644 --- a/code/renderers/vue3/src/types.ts +++ b/code/renderers/vue3/src/types.ts @@ -16,10 +16,6 @@ export type StoryContext = StoryContextBase; export type StorybookVueApp = { vueApp: App; storyContext: StoryContext }; -/** - * @deprecated Use `VueRenderer` instead. - */ -export type VueFramework = VueRenderer; export interface VueRenderer extends WebRenderer { // We are omitting props, as we don't use it internally, and more importantly, it completely changes the assignability of meta.component. // Try not omitting, and check the type errros in the test file, if you want to learn more. diff --git a/code/renderers/web-components/src/types.ts b/code/renderers/web-components/src/types.ts index 32cbce64c690..f58e7eaa01f4 100644 --- a/code/renderers/web-components/src/types.ts +++ b/code/renderers/web-components/src/types.ts @@ -10,10 +10,6 @@ export type StoryFnHtmlReturnType = export type StoryContext = StoryContextBase; -/** - * @deprecated Use `WebComponentsRenderer` instead. - */ -export type WebComponentsFramework = WebComponentsRenderer; export interface WebComponentsRenderer extends WebRenderer { component: string; storyResult: StoryFnHtmlReturnType;