Upgrading @storybook/addon-links 5 to 6
Breaking5.3.21 → 6.5.16Breaking1Security6Platform3Deprecated1New75Changed62Fixed278Other109
BreakingUpgrade verdict
1 breaking change and 3 platform requirement changes and 6 security fixes.
In plain terms
- Removes the story format parameter from the CLI.
- This package now declares React 18 as an allowed peer dependency version.
- Projects using Angular 13 can now install this version because the peer dependency ranges allow it.
- Projects using WebComponents with Storybook must use the stable Lit 2 release.
Must act Top 5 of 11 that need code or config changes
Adds @types/qs ^6.9.5, regenerator-runtime ^0.13.7.
Installs 65 packages in all (was 130).
What you must change
Breaking1
Removes the story format parameter from the CLI.
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 fix.
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-htmlPlatform3
Updates react and react-dom peerDeps for React 18.
reactreact-domUpdates peer dependencies to support Angular 13.
Updates the Lit peer dependency to the Lit 2 stable version for WebComponents.
Deprecations to plan for
Deprecated1
Deprecates isToolshown and renames it to showToolbar.
isToolshownshowToolbarAPI changes
Generated by DepDelta from published .d.ts files. Not mixed with prose notes.
- removed:
const ADDON_ID = 'storybook/links' - removed:
const _default: { NAVIGATE: string; REQUEST: string; RECEIVE: string } - removed:
default _default
- removed:
export { hrefTo } - removed:
export { linkTo } - removed:
export { withLinks } - removed:
function LinkTo(): null
- removed:
const register: () => void
- removed:
const hrefTo: (kind: string, name: string) => Promise<string> - removed:
const linkTo: (idOrKindInput: string, storyInput?: string | ((...args: any[]) => string)) => (...args: any[]) => void - removed:
const navigate: (params: ParamsId | ParamsCombo) => void - removed:
const withLinks: (storyFn: () => void) => void
- removed:
default class LinkTo extends PureComponent<Props, State> - removed:
method LinkTo.componentDidMount(): void - removed:
method LinkTo.componentDidUpdate(prevProps: Props): void - removed:
method LinkTo.render(): JSX.Element - removed:
property LinkTo.handleClick: () => void - removed:
property LinkTo.state: State - removed:
property LinkTo.updateHref: () => Promise<void> - removed:
static property LinkTo.defaultProps: Props
- removed:
default LinkTo
- added:
const ADDON_ID = 'storybook/links' - added:
const PARAM_KEY = 'links' - added:
const _default: { NAVIGATE: string; REQUEST: string; RECEIVE: string } - added:
default _default
- added:
export { hrefTo } from './utils' - added:
export { linkTo } from './utils' - added:
export { navigate } from './utils' - added:
export { withLinks } from './utils' - added:
function LinkTo(): null
- added:
const decorators: ((...args: any) => any)[]
- added:
const RoutedLink: React.FC<React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>> - added:
default RoutedLink
- added:
default class LinkTo extends PureComponent<Props, State> - added:
method LinkTo.componentDidMount(): void - added:
method LinkTo.componentDidUpdate(prevProps: Props): void - added:
method LinkTo.render(): JSX.Element - added:
property LinkTo.handleClick: () => void - added:
property LinkTo.state: State - added:
property LinkTo.updateHref: () => Promise<void> - added:
static property LinkTo.defaultProps: Props
- added:
default LinkTo
- added:
const hrefTo: (title: ComponentTitle, name: StoryName) => Promise<string> - added:
const linkTo: (idOrTitle: string, nameInput?: string | ((...args: any[]) => string)) => (...args: any[]) => void - added:
const navigate: (params: ParamsId | ParamsCombo) => void - added:
const withLinks: (...args: any) => any
- added:
const ADDON_ID = 'storybook/links' - added:
const PARAM_KEY = 'links' - added:
const _default: { NAVIGATE: string; REQUEST: string; RECEIVE: string } - added:
default _default
- added:
export { hrefTo } from './utils' - added:
export { linkTo } from './utils' - added:
export { navigate } from './utils' - added:
export { withLinks } from './utils' - added:
function LinkTo(): null
- added:
const decorators: ((...args: any) => any)[]
- added:
const RoutedLink: React.FC<React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>> - added:
default RoutedLink
- added:
default class LinkTo extends PureComponent<Props, State> - added:
method LinkTo.componentDidMount(): void - added:
method LinkTo.componentDidUpdate(prevProps: Props): void - added:
method LinkTo.render(): JSX.Element - added:
property LinkTo.handleClick: () => void - added:
property LinkTo.state: State - added:
property LinkTo.updateHref: () => Promise<void> - added:
static property LinkTo.defaultProps: Props
- added:
default LinkTo
- added:
const hrefTo: (title: ComponentTitle, name: StoryName) => Promise<string> - added:
const linkTo: (idOrTitle: string, nameInput?: string | ((...args: any[]) => string)) => (...args: any[]) => void - added:
const navigate: (params: ParamsId | ParamsCombo) => void - added:
const withLinks: (...args: any) => any
- added:
export * from './dist/ts3.9/react' - added:
export { default } from './dist/ts3.9/react'
- removed:
const ADDON_ID = 'storybook/links' - removed:
const _default: { NAVIGATE: string; REQUEST: string; RECEIVE: string } - removed:
default _default
- removed:
export { hrefTo } - removed:
export { linkTo } - removed:
export { withLinks } - removed:
function LinkTo(): null
- removed:
const register: () => void
- removed:
const hrefTo: (kind: string, name: string) => Promise<string> - removed:
const linkTo: (idOrKindInput: string, storyInput?: string | ((...args: any[]) => string)) => (...args: any[]) => void - removed:
const navigate: (params: ParamsId | ParamsCombo) => void - removed:
const withLinks: (storyFn: () => void) => void
- removed:
default class LinkTo extends PureComponent<Props, State> - removed:
method LinkTo.componentDidMount(): void - removed:
method LinkTo.componentDidUpdate(prevProps: Props): void - removed:
method LinkTo.render(): JSX.Element - removed:
property LinkTo.handleClick: () => void - removed:
property LinkTo.state: State - removed:
property LinkTo.updateHref: () => Promise<void> - removed:
static property LinkTo.defaultProps: Props
- removed:
default LinkTo