Deprecate disabled parameters in favor of disable

This commit is contained in:
Michael Shilman 2020-08-21 02:09:13 +08:00
parent 4f6690ec24
commit 407482be68
2 changed files with 32 additions and 1 deletions

View File

@ -34,6 +34,7 @@
- [6.0 Addon API changes](#60-addon-api-changes)
- [Consistent local addon paths in main.js](#consistent-local-addon-paths-in-mainjs)
- [Deprecated setAddon](#deprecated-setaddon)
- [Deprecated disabled parameter](#deprecated-disabled-parameter)
- [Actions addon uses parameters](#actions-addon-uses-parameters)
- [Removed action decorator APIs](#removed-action-decorator-apis)
- [Removed withA11y decorator](#removed-witha11y-decorator)
@ -599,6 +600,22 @@ We've deprecated the `setAddon` method of the `storiesOf` API and plan to remove
Since early versions, Storybook shipped with a `setAddon` API, which allows you to extend `storiesOf` with arbitrary code. We've removed this from all core addons long ago and recommend writing stories in [Component Story Format](https://medium.com/storybookjs/component-story-format-66f4c32366df) rather than using the internal Storybook API.
#### Deprecated disabled parameter
Starting in 6.0.17, we've renamed the `disabled` parameter to `disable` to resolve an inconsistency where `disabled` had been used to hide the addon panel, whereas `disable` had been used to disable an addon's execution. Since `disable` was much more widespread in the code, we standardized on that.
So, for example:
```
Story.parameters = { actions: { disabled: true } }
```
Should be rewritten as:
```
Story.parameters = { actions: { disable: true } }
```
#### Actions addon uses parameters
Leveraging the new preset `@storybook/addon-actions` uses parameters to pass action options. If you previously had:

View File

@ -1,10 +1,21 @@
import { ReactElement } from 'react';
import { WindowLocation } from '@reach/router';
import deprecate from 'util-deprecate';
import dedent from 'ts-dedent';
import { ModuleFn } from '../index';
import { Options } from '../store';
import { isStory } from '../lib/stories';
const warnDisabledDeprecated = deprecate(
() => {},
dedent`
Use 'parameters.key.disable' instead of 'parameters.key.disabled'.
https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-disabled-parameter
`
);
export type ViewMode = 'story' | 'info' | 'settings' | 'page' | undefined | string;
export enum types {
@ -110,6 +121,9 @@ export const init: ModuleFn = ({ provider, store, fullAPI }) => {
parameters[paramKey] &&
(parameters[paramKey].disabled || parameters[paramKey].disable)
) {
if (parameters[paramKey].disabled) {
warnDisabledDeprecated();
}
return;
}
filteredPanels[id] = panel;