Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Fixed to allow disabled controls to be enabled #29176

Open
wants to merge 3 commits into
base: next
Choose a base branch
from

Conversation

hakshu25
Copy link
Contributor

@hakshu25 hakshu25 commented Sep 21, 2024

Closes #27091

What I did

Set in meta definition: argTypes: { whatever: {control: false} }; and then try to set argTypes: { 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:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
  2. Set in meta definition: argTypes: { labelColor: {control: false} }; and then try to set argTypes: { labelColor: {control: "text"} } inside X story
  3. Open Storybook in your browser
  4. Access X story

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make 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/core team 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.

  • Modified combineArgTypes function in code/core/src/preview-api/modules/store/combineArgTypes.ts to remove disable property when type is present
  • Added unit tests in code/core/src/preview-api/modules/store/combineArgTypes.test.ts to verify the new behavior
  • Updated prepareStory function in code/core/src/preview-api/modules/store/csf/prepareStory.ts to use the new combineArgTypes function
  • Allows story-level argTypes to override meta-level disabled controls, fixing issue [Bug]: Stories are not overwriting {control: false} from meta (argTypes) #27091

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings

Copy link

nx-cloud bot commented Sep 21, 2024

☁️ Nx Cloud Report

CI 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 target

Sent with 💌 from NxCloud.

@hakshu25 hakshu25 changed the title Fix: fixed to allow disabled controls to be enabled Fix: Fixed to allow disabled controls to be enabled Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Stories are not overwriting {control: false} from meta (argTypes)
3 participants