Fix: Fixed to allow disabled controls to be enabled #29176
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
3 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings
| if (argType.control?.type && argType.control?.disable) { | ||
| delete argType.control.disable; | ||
| } |
There was a problem hiding this comment.
logic: This logic removes the 'disable' property, allowing disabled controls to be re-enabled. However, it might have unintended consequences if 'disable' is intentionally set to false.
| return Object.entries(combinedArgTypes).reduce((acc, [key, argType]) => { | ||
| if (argType.control?.type && argType.control?.disable) { | ||
| delete argType.control.disable; | ||
| } | ||
| acc[key] = argType; | ||
| return acc; | ||
| }, {} as StrictArgTypes); |
There was a problem hiding this comment.
style: Consider using Object.fromEntries() for a more concise implementation:
return Object.fromEntries(
Object.entries(combinedArgTypes).map(([key, argType]) => {
if (argType.control?.type && argType.control?.disable) {
delete argType.control.disable;
}
return [key, argType];
})
);
There was a problem hiding this comment.
Refactored with the following commits.
feb64d1
☁️ Nx Cloud ReportCI is running/has finished running commands for commit e6399df. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
hakshu25
changed the title
Closes #27091
What I did
Set in meta definition:
argTypes: { whatever: {control: false} };and then try to setargTypes: { whatever: {control: "string"} }inside a story. The control for that arg will remain disabled ("-").Fixed to enable control at this time.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
yarn task --task sandbox --start-from auto --template react-vite/default-tsargTypes: { labelColor: {control: false} };and then try to setargTypes: { labelColor: {control: "text"} }inside X storyDocumentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
This pull request addresses a bug where disabled controls in the meta definition couldn't be re-enabled in specific stories.
combineArgTypesfunction incode/core/src/preview-api/modules/store/combineArgTypes.tsto removedisableproperty whentypeis presentcode/core/src/preview-api/modules/store/combineArgTypes.test.tsto verify the new behaviorprepareStoryfunction incode/core/src/preview-api/modules/store/csf/prepareStory.tsto use the newcombineArgTypesfunction