Upgrading @storybook/react 5 to 6
Breaking5.3.21 → 6.5.16Security6Platform4Deprecated2New76Changed75Fixed277Other98
BreakingUpgrade verdict
4 platform requirement changes and 6 security fixes.
In plain terms
- Installing the CLI no longer requires or warns about a jest peer dependency.
- This version changes which versions of React and React DOM it says it works with, to include React 18.
- Storybook's peer dependency ranges now allow Angular 13 projects.
- Projects using Storybook with Web Components now need Lit 2 stable installed to satisfy the peer dependency.
Must act Top 5 of 12 that need code or config changes
Node.js requirement changed in 6.2.0-alpha.19: >=8.0.0 → >=10.13.0.
Adds @pmmmwh/react-refresh-webpack-plugin ^0.5.3, @storybook/client-logger 6.5.16, @storybook/core-common 6.5.16, @storybook/csf 0.0.2--canary.4566f4d.1, @storybook/docs-tools 6.5.16, @storybook/react-docgen-typescript-plugin 1.0.2-canary.6.9d540b91e815f8fc2f8829189deb00553559ff63.0, @storybook/semver ^7.3.2, @storybook/store 6.5.16, @types/estree ^0.0.51, @types/node ^14.14.20 || ^16.0.0, acorn ^7.4.1, acorn-jsx ^5.3.1, acorn-walk ^7.2.0, escodegen ^2.0.0, fs-extra ^9.0.1, html-tags ^3.1.0, react-element-to-jsx-string ^14.3.4, react-refresh ^0.11.0, read-pkg-up ^7.0.1, util-deprecate ^1.0.2.
Drops @babel/plugin-transform-react-constant-elements, @svgr/webpack, babel-plugin-named-asset-import, mini-css-extract-plugin, react-dev-utils, semver.
Installs 1447 packages in all (was 1360).
Also installs @babel/plugin-proposal-decorators, @babel/plugin-proposal-export-default-from, @babel/plugin-proposal-nullish-coalescing-operator, @babel/plugin-proposal-optional-chaining, @babel/plugin-proposal-private-methods, @babel/plugin-syntax-decorators, @babel/plugin-syntax-nullish-coalescing-operator, @babel/plugin-syntax-optional-chaining, @babel/plugin-syntax-private-property-in-object, @babel/plugin-syntax-typescript, @babel/plugin-transform-typescript, @babel/preset-typescript, @babel/register, @base2/pretty-print-object, @colors/colors and 181 more.
No longer installs @babel/highlight, @emotion/cache, @emotion/core, @emotion/css, @emotion/hash, @emotion/is-prop-valid, @emotion/memoize, @emotion/serialize, @emotion/sheet, @emotion/styled, @emotion/styled-base, @emotion/stylis, @emotion/unitless, @emotion/utils, @emotion/weak-memoize and 194 more.
Moves @babel/code-frame 7.29.7, 7.5.5 → 7.29.7, @babel/core 7.29.7 → 7.12.9, 7.29.7, @babel/helper-define-polyfill-provider 0.6.8 → 0.1.5, 0.6.8, @babel/helper-plugin-utils 7.29.7 → 7.10.4, 7.29.7, @babel/plugin-proposal-object-rest-spread 7.20.7 → 7.12.1, 7.20.7, @babel/plugin-proposal-private-property-in-object 7.21.0-placeholder-for-preset-env.2 → 7.21.0-placeholder-for-preset-env.2, 7.21.11, @babel/plugin-syntax-jsx 7.29.7 → 7.12.1, 7.29.7, @nodelib/fs.stat 1.1.3 → 1.1.3, 2.0.5, @storybook/csf 0.0.1 → 0.0.2--canary.4566f4d.1, @types/node 26.6.6 → 16.18.126, @webassemblyjs/ast 1.9.0 → 1.14.1, 1.9.0, @webassemblyjs/floating-point-hex-parser 1.9.0 → 1.13.2, 1.9.0, @webassemblyjs/helper-api-error 1.9.0 → 1.13.2, 1.9.0, @webassemblyjs/helper-buffer 1.9.0 → 1.14.1, 1.9.0, @webassemblyjs/helper-wasm-bytecode 1.9.0 → 1.13.2, 1.9.0 and 125 more. Your build may pick other versions.
13 packages of its own release move with it.
What you must change
Security6
Upgrades the json5 dependency for security.
json5Reverts the security update to x-default-browser.
x-default-browserUpdates the x-default-browser dependency as a security update.
x-default-browserUpdates react-syntax-highlighter to fix a transitive vulnerability.
react-syntax-highlighterUpgrades react-syntax-highlighter to pick up a security patch upstream in highlight.js.
react-syntax-highlighterhighlight.jsFixes an ansi-html vulnerability in dependencies.
ansi-htmlPlatform4
Removes jest from the CLI package peerDependencies.
jestUpdates react and react-dom peerDeps for React 18.
reactreact-domUpdates peer dependencies to support Angular 13.
Updates the WebComponents Lit peer dependency to the stable Lit 2 version.
litDeprecations to plan for
Deprecated2
Replaces references to themes.normal with themes.light in Theming.
themes.normalthemes.lightDeprecates isToolshown and renames it to showToolbar.
isToolshownshowToolbarAPI changes
Generated by DepDelta from published .d.ts files. Not mixed with prose notes.
- removed:
export { DecoratorFn } from './preview' - removed:
export { addDecorator } from './preview' - removed:
export { addParameters } from './preview' - removed:
export { configure } from './preview' - removed:
export { forceReRender } from './preview' - removed:
export { getStorybook } from './preview' - removed:
export { raw } from './preview' - removed:
export { setAddon } from './preview' - removed:
export { storiesOf } from './preview'
- removed:
const addDecorator: ClientApi['addDecorator'] - removed:
const addParameters: ClientApi['addParameters'] - removed:
const clearDecorators: ClientApi['clearDecorators'] - removed:
const configure: ClientApi['configure'] - removed:
const forceReRender: ClientApi['forceReRender'] - removed:
const getStorybook: ClientApi['getStorybook'] - removed:
const raw: ClientApi['raw'] - removed:
const setAddon: ClientApi['setAddon'] - removed:
const storiesOf: ClientApi['storiesOf'] - removed:
type DecoratorFn = Parameters<typeof addDecorator>[0]
- removed:
default function renderMain({ storyFn: StoryFn, showMain, showException, forceRender }: RenderMainArgs): Promise<void>
- removed:
interface IStorybookSection - removed:
interface IStorybookStory - removed:
interface RenderMainArgs - removed:
interface ShowErrorArgs - removed:
property IStorybookSection.kind: string - removed:
property IStorybookSection.stories: IStorybookStory[] - removed:
property IStorybookStory.name: string - removed:
property IStorybookStory.render: () => any - removed:
property RenderMainArgs.forceRender: boolean - removed:
property RenderMainArgs.selectedKind: string - removed:
property RenderMainArgs.selectedStory: string - removed:
property RenderMainArgs.showError: (args: ShowErrorArgs) => void - removed:
property RenderMainArgs.showException: (err: Error) => void - removed:
property RenderMainArgs.showMain: () => void - removed:
property RenderMainArgs.storyFn: FunctionComponent<any> - removed:
property ShowErrorArgs.description: string - removed:
property ShowErrorArgs.title: string - removed:
type StoryFnReactReturnType = ReactElement<unknown>
- removed:
const Button: FunctionComponent<Props> - removed:
default Button
- removed:
const default: FunctionComponent<WelcomeProps>
- removed:
const getRules: (extensions: string[]) => (rules: RuleSetRule[]) => RuleSetRule[] - removed:
const getTypeScriptRules: (webpackConfigRules: RuleSetRule[], configDir: string) => RuleSetRule[] - removed:
function applyCRAWebpackConfig(baseConfig: Configuration, configDir: string): Configuration - removed:
function getCraWebpackConfig(mode: 'development' | 'production' | 'none'): any - removed:
function getReactScriptsPath({ noCache }?: { noCache?: boolean }): string - removed:
function isReactScriptsInstalled(requiredVersion?: string): boolean
- removed:
function babelDefault(config: Configuration, { presetsList }: { presetsList: Preset[] }): Configuration | { presets: string[]; plugins: (string | { loaderMap: { svg: { ReactComponent: string } } })[][]; mode?: 'none' | 'development' | 'production'; name?: string; context?: string; entry?: string | string[] | import('webpack').Entry | import('webpack').EntryFunc; devtool?: import('webpack').Option… - removed:
function managerWebpack(config: Configuration, { presetsList }: { presetsList: Preset[] }): Configuration - removed:
function webpackFinal(config: Configuration, { presetsList, configDir }: { presetsList: Preset[]; configDir: string }): Configuration
- removed:
function babelDefault(config: TransformOptions): { presets: (string | object)[]; plugins: (string | object)[]; ast?: boolean; auxiliaryCommentAfter?: string; auxiliaryCommentBefore?: string; root?: string; rootMode?: 'root' | 'upward' | 'upward-optional'; configFile?: string | false; babelrc?: boolean; babelrcRoots?: string | true | string[]; envName?: string; code?: boolean; comments?: boolean;…
- removed:
function babel(config: TransformOptions): { plugins: any[]; ast?: boolean; auxiliaryCommentAfter?: string; auxiliaryCommentBefore?: string; root?: string; rootMode?: 'root' | 'upward' | 'upward-optional'; configFile?: string | false; babelrc?: boolean; babelrcRoots?: string | true | string[]; envName?: string; code?: boolean; comments?: boolean; compact?: boolean | 'auto'; cwd?: string; caller?:…
- removed:
const _default: { packageJson: any; framework: string; frameworkPresets: string[] } - removed:
default _default
- added:
const argTypesEnhancers: (<TFramework extends import('@storybook/csf').AnyFramework>(context: import('@storybook/csf').StoryContextForEnhancers<TFramework, import('@storybook/csf').Arg… - added:
const decorators: ((storyFn: PartialStoryFn<ReactFramework, import('@storybook/csf').Args>, context: import('@storybook/csf').StoryContext<ReactFramework, import('@storybook/csf… - added:
const parameters: { docs: { inlineStories: boolean; prepareForInline: (storyFn: PartialStoryFn<ReactFramework>) => import('../preview/types').StoryFnReactReturnType; extractArgT…
- added:
const extractArgTypes: ArgTypesExtractor
- added:
const extractProps: PropsExtractor - added:
index PropDefMap[p: string]: PropDef - added:
interface PropDefMap
- added:
const jsxDecorator: (storyFn: PartialStoryFn<ReactFramework>, context: StoryContext<ReactFramework>) => import('../preview/types').StoryFnReactReturnType - added:
const renderJsx: (code: React.ReactElement, options: JSXOptions) => string - added:
const skipJsxRender: (context: StoryContext<ReactFramework>) => any
- added:
const ARRAY_CAPTION = 'array' - added:
const CLASS_CAPTION = 'class' - added:
const CUSTOM_CAPTION = 'custom' - added:
const ELEMENT_CAPTION = 'element' - added:
const FUNCTION_CAPTION = 'func' - added:
const OBJECT_CAPTION = 'object'
- added:
const isForwardRef: (component: any) => boolean - added:
const isMemo: (component: any) => boolean
- added:
function createDefaultValue(defaultValue: string): PropDefaultValue
- added:
function createDefaultValueFromRawDefaultProp(rawDefaultProp: any, propDef: PropDef, typeResolvers?: TypeResolvers): PropDefaultValue - added:
function createTypeResolvers(customResolvers?: Partial<TypeResolvers>): TypeResolvers - added:
function extractFunctionName(func: Function, propName: string): string - added:
interface TypeResolvers - added:
property TypeResolvers.default: TypeResolver - added:
property TypeResolvers.function: TypeResolver - added:
property TypeResolvers.object: TypeResolver - added:
property TypeResolvers.string: TypeResolver - added:
type TypeResolver = (rawDefaultProp: any, propDef: PropDef) => PropDefaultValue
- added:
function generateArray({ inferredType, ast }: InspectionResult): PropDefaultValue
- added:
function generateObject({ inferredType, ast }: InspectionResult): PropDefaultValue
- added:
export * from './createDefaultValue' - added:
export * from './createFromRawDefaultProp'
- added:
function getPrettyElementIdentifier(identifier: string): string - added:
function getPrettyFuncIdentifier(identifier: string, hasArguments: boolean): string - added:
function getPrettyIdentifier(inferredType: InspectionIdentifiableInferedType): string
- added:
function generateArrayCode(ast: any, compact?: boolean): string - added:
function generateCode(ast: any, compact?: boolean): string - added:
function generateObjectCode(ast: any, compact?: boolean): string
- added:
export * from './captions' - added:
export * from './componentTypes' - added:
export * from './generateCode' - added:
export * from './isHtmlTag'
- added:
function parse(value: string): ParsingResult<InspectionInferedType>
- added:
export * from './inspectValue' - added:
export * from './types'
- added:
function inspectValue(value: string): InspectionResult
- added:
enum InspectionType - added:
interface InspectionArray extends InspectionInferedType - added:
interface InspectionClass extends InspectionInferedType - added:
interface InspectionElement extends InspectionInferedType - added:
interface InspectionFunction extends InspectionInferedType - added:
interface InspectionIdentifier extends InspectionInferedType - added:
interface InspectionInferedType - added:
interface InspectionLiteral extends InspectionInferedType - added:
interface InspectionObject extends InspectionInferedType - added:
interface InspectionResult - added:
interface InspectionUnknown extends InspectionInferedType - added:
member InspectionType.ARRAY = 'Array' - added:
member InspectionType.CLASS = 'Class' - added:
member InspectionType.ELEMENT = 'Element' - added:
member InspectionType.FUNCTION = 'Function' - added:
member InspectionType.IDENTIFIER = 'Identifier' - added:
member InspectionType.LITERAL = 'Literal' - added:
member InspectionType.OBJECT = 'Object' - added:
member InspectionType.UNKNOWN = 'Unknown' - added:
property InspectionArray.depth: number - added:
property InspectionArray.type: InspectionType.ARRAY - added:
property InspectionClass.identifier: string - added:
property InspectionClass.type: InspectionType.CLASS - added:
property InspectionElement.identifier?: string - added:
property InspectionElement.type: InspectionType.ELEMENT - added:
property InspectionFunction.hasParams: boolean - added:
property InspectionFunction.identifier?: string - added:
property InspectionFunction.params: any[] - added:
property InspectionFunction.type: InspectionType.FUNCTION - added:
property InspectionIdentifier.identifier: string - added:
property InspectionIdentifier.type: InspectionType.IDENTIFIER - added:
property InspectionInferedType.type: InspectionType - added:
property InspectionLiteral.type: InspectionType.LITERAL - added:
property InspectionObject.depth: number - added:
property InspectionObject.type: InspectionType.OBJECT - added:
property InspectionResult.ast?: any - added:
property InspectionResult.inferredType: InspectionInferedType - added:
property InspectionUnknown.type: InspectionType.UNKNOWN - added:
type InspectionIdentifiableInferedType = InspectionIdentifier | InspectionClass | InspectionFunction | InspectionElement
- added:
function isHtmlTag(tagName: string): boolean
- added:
function createType(extractedProp: ExtractedProp): PropType
- added:
function generateFuncSignature(params: ExtractedJsDocParam[], returns: ExtractedJsDocReturns): string - added:
function generateShortFuncSignature(params: ExtractedJsDocParam[], returns: ExtractedJsDocReturns): string - added:
function toMultilineSignature(signature: string): string
- added:
function enhancePropTypesProp(extractedProp: ExtractedProp, rawDefaultProp?: any): PropDef - added:
function enhancePropTypesProps(extractedProps: ExtractedProp[], component: Component): PropDef[]
- added:
const rawDefaultPropTypeResolvers: import('../lib/defaultValues').TypeResolvers
- added:
function keepOriginalDefinitionOrder(extractedProps: PropDef[], component: Component): PropDef[]
- added:
function enhanceTypeScriptProp(extractedProp: ExtractedProp, rawDefaultProp?: any): PropDef - added:
function enhanceTypeScriptProps(extractedProps: ExtractedProp[]): PropDef[]
- added:
export * from './preview/types-6-3' - added:
export * from './testing' - added:
export { DecoratorFn } from './preview' - added:
export { addDecorator } from './preview' - added:
export { addParameters } from './preview' - added:
export { configure } from './preview' - added:
export { forceReRender } from './preview' - added:
export { getStorybook } from './preview' - added:
export { raw } from './preview' - added:
export { setAddon } from './preview' - added:
export { storiesOf } from './preview'
- added:
const parameters: { framework: string } - added:
export { render } from './render' - added:
export { renderToDOM } from './render'
- added:
const addDecorator: ClientApi['addDecorator'] - added:
const addParameters: ClientApi['addParameters'] - added:
const clearDecorators: ClientApi['clearDecorators'] - added:
const configure: ClientApi['configure'] - added:
const forceReRender: ClientApi['forceReRender'] - added:
const getStorybook: ClientApi['getStorybook'] - added:
const raw: ClientApi['raw'] - added:
const setAddon: ClientApi['setAddon'] - added:
const storiesOf: ClientApi['storiesOf'] - added:
type DecoratorFn = Parameters<typeof addDecorator>[0]
- added:
const render: ArgsStoryFn<ReactFramework> - added:
function renderToDOM({ storyContext, unboundStoryFn, showMain, showException, forceRemount }: RenderContext<ReactFramework>, domElement: HTMLElement): Promise<void>
- added:
export { RenderContext } from '@storybook/store' - added:
export { StoryContext } from '@storybook/csf' - added:
interface IStorybookSection - added:
interface IStorybookStory - added:
interface ShowErrorArgs - added:
property IStorybookSection.kind: string - added:
property IStorybookSection.stories: IStorybookStory[] - added:
property IStorybookStory.name: string - added:
property IStorybookStory.render: (context: any) => any - added:
property ShowErrorArgs.description: string - added:
property ShowErrorArgs.title: string - added:
type StoryFnReactReturnType = ReactElement<unknown>
- added:
export { ArgTypes } from '@storybook/csf' - added:
export { Args } from '@storybook/csf' - added:
export { Parameters } from '@storybook/csf' - added:
export { StoryContext } from '@storybook/csf' - added:
type Meta<TArgs = Args> = ComponentAnnotations<ReactFramework, TArgs> - added:
type ReactFramework = { component: ComponentType<any>; storyResult: StoryFnReactReturnType } - added:
type Story<TArgs = Args> = StoryFn<TArgs> - added:
type StoryFn<TArgs = Args> = AnnotatedStoryFn<ReactFramework, TArgs> - added:
type StoryObj<TArgs = Args> = StoryAnnotations<ReactFramework, TArgs>
- added:
export * from './types-6-0' - added:
type ComponentMeta<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = Meta<ComponentProps<T>> - added:
type ComponentStory<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = Story<ComponentProps<T>> - added:
type ComponentStoryFn<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = StoryFn<ComponentProps<T>> - added:
type ComponentStoryObj<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = StoryObj<ComponentProps<T>>
- added:
export { ComponentMeta } from './types-6-3' - added:
export { ComponentStoryFn } from './types-6-3' - added:
export { ComponentStoryObj } from './types-6-3' - added:
export { Meta } from './types-6-0' - added:
export { StoryFn } from './types-6-0' - added:
export { StoryObj } from './types-6-0' - added:
type ComponentStory<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = ComponentStoryObj<T> - added:
type Story<TArgs = Args> = StoryObj<TArgs>
- added:
function composeStories<TModule extends CSFExports<ReactFramework>>(csfExports: TModule, projectAnnotations?: ProjectAnnotations<ReactFramework>): Pick<StoriesWithPartialProps<ReactFramework, TModule>, Exclude<keyof TModule, 'default' | '__esModule' | '__namedExportsOrder'>> - added:
function composeStory<TArgs = Args>(story: ComposedStory<ReactFramework, TArgs>, componentAnnotations: Meta<TArgs | any>, projectAnnotations?: ProjectAnnotations<ReactFramework>, exportsName?: string): { (extraArgs: Partial<TArgs>): import('../preview/types').StoryFnReactReturnType; storyName: string; args: Args; play: import('@storybook/store').ComposedStoryPlayFn; parameters: import('@storybook… - added:
function setGlobalConfig(projectAnnotations: ProjectAnnotations<ReactFramework> | ProjectAnnotations<ReactFramework>[]): void - added:
function setProjectAnnotations(projectAnnotations: ProjectAnnotations<ReactFramework> | ProjectAnnotations<ReactFramework>[]): void
- added:
const Button: FunctionComponent<Props> - added:
default Button
- added:
const default: FunctionComponent<WelcomeProps>
- added:
function getReactScriptsPath({ noCache }?: { noCache?: boolean }): string - added:
function isReactScriptsInstalled(requiredVersion?: string): boolean
- added:
function webpackFinal(config: Configuration, { presetsList }: Options): Configuration
- added:
function babel(config: TransformOptions, options: Options): Promise<TransformOptions> - added:
function babelDefault(config: TransformOptions): Promise<TransformOptions> - added:
function webpackFinal(config: Configuration, options: Options): Promise<Configuration>
- added:
const previewAnnotations: StorybookConfig['previewAnnotations'] - added:
function babel(config: TransformOptions, options: Options): Promise<TransformOptions> - added:
function webpackFinal(config: Configuration, options: Options): Promise<Configuration>
- added:
function webpackFinal(config: Configuration): Promise<{ plugins: import('webpack').Plugin[]; mode?: 'none' | 'production' | 'development'; name?: string; context?: string; entry?: string | string[] | import('webpack').Entry | import('webpack').EntryFunc; devtool?: string | boolean; output?: import('webpack').Output; module?: import('webpack').Module; resolve?: import('webpack').Resolve; resolveLo…
- added:
const _default: LoadOptions - added:
default _default
- added:
const addons: StorybookConfig['addons'] - added:
const previewAnnotations: StorybookConfig['previewAnnotations']
- added:
const argTypesEnhancers: (<TFramework extends import('@storybook/csf').AnyFramework>(context: import('@storybook/csf').StoryContextForEnhancers<TFramework, import('@storybook/csf').Arg… - added:
const decorators: ((storyFn: PartialStoryFn<ReactFramework, import('@storybook/csf').Args>, context: import('@storybook/csf').StoryContext<ReactFramework, import('@storybook/csf… - added:
const parameters: { docs: { inlineStories: boolean; prepareForInline: (storyFn: PartialStoryFn<ReactFramework>) => import('../preview/types').StoryFnReactReturnType; extractArgT…
- added:
const extractArgTypes: ArgTypesExtractor
- added:
const extractProps: PropsExtractor - added:
index PropDefMap[p: string]: PropDef - added:
interface PropDefMap
- added:
const jsxDecorator: (storyFn: PartialStoryFn<ReactFramework>, context: StoryContext<ReactFramework>) => import('../preview/types').StoryFnReactReturnType - added:
const renderJsx: (code: React.ReactElement, options: JSXOptions) => string - added:
const skipJsxRender: (context: StoryContext<ReactFramework>) => any
- added:
const ARRAY_CAPTION = 'array' - added:
const CLASS_CAPTION = 'class' - added:
const CUSTOM_CAPTION = 'custom' - added:
const ELEMENT_CAPTION = 'element' - added:
const FUNCTION_CAPTION = 'func' - added:
const OBJECT_CAPTION = 'object'
- added:
const isForwardRef: (component: any) => boolean - added:
const isMemo: (component: any) => boolean
- added:
function createDefaultValue(defaultValue: string): PropDefaultValue
- added:
function createDefaultValueFromRawDefaultProp(rawDefaultProp: any, propDef: PropDef, typeResolvers?: TypeResolvers): PropDefaultValue - added:
function createTypeResolvers(customResolvers?: Partial<TypeResolvers>): TypeResolvers - added:
function extractFunctionName(func: Function, propName: string): string - added:
interface TypeResolvers - added:
property TypeResolvers.default: TypeResolver - added:
property TypeResolvers.function: TypeResolver - added:
property TypeResolvers.object: TypeResolver - added:
property TypeResolvers.string: TypeResolver - added:
type TypeResolver = (rawDefaultProp: any, propDef: PropDef) => PropDefaultValue
- added:
function generateArray({ inferredType, ast }: InspectionResult): PropDefaultValue
- added:
function generateObject({ inferredType, ast }: InspectionResult): PropDefaultValue
- added:
export * from './createDefaultValue' - added:
export * from './createFromRawDefaultProp'
- added:
function getPrettyElementIdentifier(identifier: string): string - added:
function getPrettyFuncIdentifier(identifier: string, hasArguments: boolean): string - added:
function getPrettyIdentifier(inferredType: InspectionIdentifiableInferedType): string
- added:
function generateArrayCode(ast: any, compact?: boolean): string - added:
function generateCode(ast: any, compact?: boolean): string - added:
function generateObjectCode(ast: any, compact?: boolean): string
- added:
export * from './captions' - added:
export * from './componentTypes' - added:
export * from './generateCode' - added:
export * from './isHtmlTag'
- added:
function parse(value: string): ParsingResult<InspectionInferedType>
- added:
export * from './inspectValue' - added:
export * from './types'
- added:
function inspectValue(value: string): InspectionResult
- added:
enum InspectionType - added:
interface InspectionArray extends InspectionInferedType - added:
interface InspectionClass extends InspectionInferedType - added:
interface InspectionElement extends InspectionInferedType - added:
interface InspectionFunction extends InspectionInferedType - added:
interface InspectionIdentifier extends InspectionInferedType - added:
interface InspectionInferedType - added:
interface InspectionLiteral extends InspectionInferedType - added:
interface InspectionObject extends InspectionInferedType - added:
interface InspectionResult - added:
interface InspectionUnknown extends InspectionInferedType - added:
member InspectionType.ARRAY = 'Array' - added:
member InspectionType.CLASS = 'Class' - added:
member InspectionType.ELEMENT = 'Element' - added:
member InspectionType.FUNCTION = 'Function' - added:
member InspectionType.IDENTIFIER = 'Identifier' - added:
member InspectionType.LITERAL = 'Literal' - added:
member InspectionType.OBJECT = 'Object' - added:
member InspectionType.UNKNOWN = 'Unknown' - added:
property InspectionArray.depth: number - added:
property InspectionArray.type: InspectionType.ARRAY - added:
property InspectionClass.identifier: string - added:
property InspectionClass.type: InspectionType.CLASS - added:
property InspectionElement.identifier?: string - added:
property InspectionElement.type: InspectionType.ELEMENT - added:
property InspectionFunction.hasParams: boolean - added:
property InspectionFunction.identifier?: string - added:
property InspectionFunction.params: any[] - added:
property InspectionFunction.type: InspectionType.FUNCTION - added:
property InspectionIdentifier.identifier: string - added:
property InspectionIdentifier.type: InspectionType.IDENTIFIER - added:
property InspectionInferedType.type: InspectionType - added:
property InspectionLiteral.type: InspectionType.LITERAL - added:
property InspectionObject.depth: number - added:
property InspectionObject.type: InspectionType.OBJECT - added:
property InspectionResult.ast?: any - added:
property InspectionResult.inferredType: InspectionInferedType - added:
property InspectionUnknown.type: InspectionType.UNKNOWN - added:
type InspectionIdentifiableInferedType = InspectionIdentifier | InspectionClass | InspectionFunction | InspectionElement
- added:
function isHtmlTag(tagName: string): boolean
- added:
function createType(extractedProp: ExtractedProp): PropType
- added:
function generateFuncSignature(params: ExtractedJsDocParam[], returns: ExtractedJsDocReturns): string - added:
function generateShortFuncSignature(params: ExtractedJsDocParam[], returns: ExtractedJsDocReturns): string - added:
function toMultilineSignature(signature: string): string
- added:
function enhancePropTypesProp(extractedProp: ExtractedProp, rawDefaultProp?: any): PropDef - added:
function enhancePropTypesProps(extractedProps: ExtractedProp[], component: Component): PropDef[]
- added:
const rawDefaultPropTypeResolvers: import('../lib/defaultValues').TypeResolvers
- added:
function keepOriginalDefinitionOrder(extractedProps: PropDef[], component: Component): PropDef[]
- added:
function enhanceTypeScriptProp(extractedProp: ExtractedProp, rawDefaultProp?: any): PropDef - added:
function enhanceTypeScriptProps(extractedProps: ExtractedProp[]): PropDef[]
- added:
export * from './preview/types-6-3' - added:
export * from './testing' - added:
export { DecoratorFn } from './preview' - added:
export { addDecorator } from './preview' - added:
export { addParameters } from './preview' - added:
export { configure } from './preview' - added:
export { forceReRender } from './preview' - added:
export { getStorybook } from './preview' - added:
export { raw } from './preview' - added:
export { setAddon } from './preview' - added:
export { storiesOf } from './preview'
- added:
const parameters: { framework: string } - added:
export { render } from './render' - added:
export { renderToDOM } from './render'
- added:
const addDecorator: ClientApi['addDecorator'] - added:
const addParameters: ClientApi['addParameters'] - added:
const clearDecorators: ClientApi['clearDecorators'] - added:
const configure: ClientApi['configure'] - added:
const forceReRender: ClientApi['forceReRender'] - added:
const getStorybook: ClientApi['getStorybook'] - added:
const raw: ClientApi['raw'] - added:
const setAddon: ClientApi['setAddon'] - added:
const storiesOf: ClientApi['storiesOf'] - added:
type DecoratorFn = Parameters<typeof addDecorator>[0]
- added:
const render: ArgsStoryFn<ReactFramework> - added:
function renderToDOM({ storyContext, unboundStoryFn, showMain, showException, forceRemount }: RenderContext<ReactFramework>, domElement: HTMLElement): Promise<void>
- added:
export { RenderContext } from '@storybook/store' - added:
export { StoryContext } from '@storybook/csf' - added:
interface IStorybookSection - added:
interface IStorybookStory - added:
interface ShowErrorArgs - added:
property IStorybookSection.kind: string - added:
property IStorybookSection.stories: IStorybookStory[] - added:
property IStorybookStory.name: string - added:
property IStorybookStory.render: (context: any) => any - added:
property ShowErrorArgs.description: string - added:
property ShowErrorArgs.title: string - added:
type StoryFnReactReturnType = ReactElement<unknown>
- added:
export { ArgTypes } from '@storybook/csf' - added:
export { Args } from '@storybook/csf' - added:
export { Parameters } from '@storybook/csf' - added:
export { StoryContext } from '@storybook/csf' - added:
type Meta<TArgs = Args> = ComponentAnnotations<ReactFramework, TArgs> - added:
type ReactFramework = { component: ComponentType<any>; storyResult: StoryFnReactReturnType } - added:
type Story<TArgs = Args> = StoryFn<TArgs> - added:
type StoryFn<TArgs = Args> = AnnotatedStoryFn<ReactFramework, TArgs> - added:
type StoryObj<TArgs = Args> = StoryAnnotations<ReactFramework, TArgs>
- added:
export * from './types-6-0' - added:
type ComponentMeta<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = Meta<ComponentProps<T>> - added:
type ComponentStory<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = Story<ComponentProps<T>> - added:
type ComponentStoryFn<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = StoryFn<ComponentProps<T>> - added:
type ComponentStoryObj<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = StoryObj<ComponentProps<T>>
- added:
export { ComponentMeta } from './types-6-3' - added:
export { ComponentStoryFn } from './types-6-3' - added:
export { ComponentStoryObj } from './types-6-3' - added:
export { Meta } from './types-6-0' - added:
export { StoryFn } from './types-6-0' - added:
export { StoryObj } from './types-6-0' - added:
type ComponentStory<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = ComponentStoryObj<T> - added:
type Story<TArgs = Args> = StoryObj<TArgs>
- added:
function composeStories<TModule extends CSFExports<ReactFramework>>(csfExports: TModule, projectAnnotations?: ProjectAnnotations<ReactFramework>): Pick<StoriesWithPartialProps<ReactFramework, TModule>, Exclude<keyof TModule, 'default' | '__esModule' | '__namedExportsOrder'>> - added:
function composeStory<TArgs = Args>(story: ComposedStory<ReactFramework, TArgs>, componentAnnotations: Meta<TArgs | any>, projectAnnotations?: ProjectAnnotations<ReactFramework>, exportsName?: string): { (extraArgs: Partial<TArgs>): import('../preview/types').StoryFnReactReturnType; storyName: string; args: Args; play: import('@storybook/store').ComposedStoryPlayFn; parameters: import('@storybook… - added:
function setGlobalConfig(projectAnnotations: ProjectAnnotations<ReactFramework> | ProjectAnnotations<ReactFramework>[]): void - added:
function setProjectAnnotations(projectAnnotations: ProjectAnnotations<ReactFramework> | ProjectAnnotations<ReactFramework>[]): void
- added:
const Button: FunctionComponent<Props> - added:
default Button
- added:
const default: FunctionComponent<WelcomeProps>
- added:
function getReactScriptsPath({ noCache }?: { noCache?: boolean }): string - added:
function isReactScriptsInstalled(requiredVersion?: string): boolean
- added:
function webpackFinal(config: Configuration, { presetsList }: Options): Configuration
- added:
function babel(config: TransformOptions, options: Options): Promise<TransformOptions> - added:
function babelDefault(config: TransformOptions): Promise<TransformOptions> - added:
function webpackFinal(config: Configuration, options: Options): Promise<Configuration>
- added:
const previewAnnotations: StorybookConfig['previewAnnotations'] - added:
function babel(config: TransformOptions, options: Options): Promise<TransformOptions> - added:
function webpackFinal(config: Configuration, options: Options): Promise<Configuration>
- added:
function webpackFinal(config: Configuration): Promise<{ plugins: import('webpack').Plugin[]; mode?: 'none' | 'production' | 'development'; name?: string; context?: string; entry?: string | string[] | import('webpack').Entry | import('webpack').EntryFunc; devtool?: string | boolean; output?: import('webpack').Output; module?: import('webpack').Module; resolve?: import('webpack').Resolve; resolveLo…
- added:
const _default: LoadOptions - added:
default _default
- added:
const addons: StorybookConfig['addons'] - added:
const previewAnnotations: StorybookConfig['previewAnnotations']
- removed:
export { DecoratorFn } from './preview' - removed:
export { addDecorator } from './preview' - removed:
export { addParameters } from './preview' - removed:
export { configure } from './preview' - removed:
export { forceReRender } from './preview' - removed:
export { getStorybook } from './preview' - removed:
export { raw } from './preview' - removed:
export { setAddon } from './preview' - removed:
export { storiesOf } from './preview'
- removed:
const addDecorator: ClientApi['addDecorator'] - removed:
const addParameters: ClientApi['addParameters'] - removed:
const clearDecorators: ClientApi['clearDecorators'] - removed:
const configure: ClientApi['configure'] - removed:
const forceReRender: ClientApi['forceReRender'] - removed:
const getStorybook: ClientApi['getStorybook'] - removed:
const raw: ClientApi['raw'] - removed:
const setAddon: ClientApi['setAddon'] - removed:
const storiesOf: ClientApi['storiesOf'] - removed:
type DecoratorFn = Parameters<typeof addDecorator>[0]
- removed:
default function renderMain({ storyFn: StoryFn, showMain, showException, forceRender }: RenderMainArgs): Promise<void>
- removed:
interface IStorybookSection - removed:
interface IStorybookStory - removed:
interface RenderMainArgs - removed:
interface ShowErrorArgs - removed:
property IStorybookSection.kind: string - removed:
property IStorybookSection.stories: IStorybookStory[] - removed:
property IStorybookStory.name: string - removed:
property IStorybookStory.render: () => any - removed:
property RenderMainArgs.forceRender: boolean - removed:
property RenderMainArgs.selectedKind: string - removed:
property RenderMainArgs.selectedStory: string - removed:
property RenderMainArgs.showError: (args: ShowErrorArgs) => void - removed:
property RenderMainArgs.showException: (err: Error) => void - removed:
property RenderMainArgs.showMain: () => void - removed:
property RenderMainArgs.storyFn: FunctionComponent<any> - removed:
property ShowErrorArgs.description: string - removed:
property ShowErrorArgs.title: string - removed:
type StoryFnReactReturnType = ReactElement<unknown>
- removed:
const Button: FunctionComponent<Props> - removed:
default Button
- removed:
const default: FunctionComponent<WelcomeProps>
- removed:
const _default: { devtool: string; resolve: { extensions: string[]; alias: { baseAlias: string }; modules: any[] }; module: { noParse: RegExp; rules: { test: RegExp; include:… - removed:
default _default
- removed:
const _default: ({ parser: { requireEnsure: boolean }; test?: undefined; enforce?: undefined; use?: undefined; include?: undefined; oneOf?: undefined } | { test: RegExp; enfor… - removed:
default _default
- removed:
const getRules: (extensions: string[]) => (rules: RuleSetRule[]) => RuleSetRule[] - removed:
const getTypeScriptRules: (webpackConfigRules: RuleSetRule[], configDir: string) => RuleSetRule[] - removed:
function applyCRAWebpackConfig(baseConfig: Configuration, configDir: string): Configuration - removed:
function getCraWebpackConfig(mode: 'development' | 'production' | 'none'): any - removed:
function getReactScriptsPath({ noCache }?: { noCache?: boolean }): string - removed:
function isReactScriptsInstalled(requiredVersion?: string): boolean
- removed:
function babelDefault(config: Configuration, { presetsList }: { presetsList: Preset[] }): Configuration | { presets: string[]; plugins: (string | { loaderMap: { svg: { ReactComponent: string } } })[][]; mode?: 'none' | 'development' | 'production'; name?: string; context?: string; entry?: string | string[] | import('webpack').Entry | import('webpack').EntryFunc; devtool?: import('webpack').Option… - removed:
function managerWebpack(config: Configuration, { presetsList }: { presetsList: Preset[] }): Configuration - removed:
function webpackFinal(config: Configuration, { presetsList, configDir }: { presetsList: Preset[]; configDir: string }): Configuration
- removed:
function babelDefault(config: TransformOptions): { presets: (string | object)[]; plugins: (string | object)[]; ast?: boolean; auxiliaryCommentAfter?: string; auxiliaryCommentBefore?: string; root?: string; rootMode?: 'root' | 'upward' | 'upward-optional'; configFile?: string | false; babelrc?: boolean; babelrcRoots?: string | true | string[]; envName?: string; code?: boolean; comments?: boolean;…
- removed:
function babel(config: TransformOptions): { plugins: any[]; ast?: boolean; auxiliaryCommentAfter?: string; auxiliaryCommentBefore?: string; root?: string; rootMode?: 'root' | 'upward' | 'upward-optional'; configFile?: string | false; babelrc?: boolean; babelrcRoots?: string | true | string[]; envName?: string; code?: boolean; comments?: boolean; compact?: boolean | 'auto'; cwd?: string; caller?:…
- removed:
const _default: { packageJson: any; framework: string; frameworkPresets: string[] } - removed:
default _default
- added:
export * from './dist/ts3.9/client/preview/types-6-0.d'
- added:
export * from './dist/ts3.9/client/preview/types-7-0.d'