Composition: Rename disabled parameter => disable

[g1eny0ung]

Issue:

https://storybook.js.org/docs/react/workflows/package-composition#configuring

After checking the source: https://github.com/storybookjs/storybook/blob/next/lib/core/src/server/manager/manager-config.js#L81, this should be a typo.

What I did

Change disable to disabled.

Deprecate the disabled parameter.

How to test

• Is this testable with Jest or Chromatic screenshots?
• Does this need a new example in the kitchen sink apps?
• Does this need an update to the documentation?

If your answer is yes to any of these, please make sure to include it in your PR.

[shilman]

@g1eny0ung thanks for putting this PR together! 🙏

@g1eny0ung @ndelangen I think this is a bug in the code, not in the documentation. We use disable everywhere else and should be consistent.

[ndelangen]

@shilman I agree. I doubt a lot of people will be affected if we change this in a minor/patch release. Do we risk it?

[g1eny0ung]

@shilman I also agree with u. But like @ndelangen says, changing the source code is likely to affect many people.

So I'm not sure, should I update the pr to change the source or still keep the current doc changes?

[shilman]

How about we support both but issue a deprecation warning if users use disabled?

Here's an example of how we do that for docs.storyDescription (old) and docs.description.story (new):

https://github.com/storybookjs/storybook/blob/next/addons/docs/src/blocks/DocsStory.tsx#L29-L35

[g1eny0ung]

How about we support both but issue a deprecation warning if users use disabled?

Here's an example of how we do that for docs.storyDescription (old) and docs.description.story (new):

https://github.com/storybookjs/storybook/blob/next/addons/docs/src/blocks/DocsStory.tsx#L29-L35

Good idea. I will update the changes later.

[g1eny0ung]

@shilman PTAL. Also, I tried to update the migration doc. If there is something wrong, please help me to point out. Very thx.~

[shilman]

Great work @g1eny0ung 💯