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

Vue3: Fix support for onX and empty attributes in Show Code #25219

Conversation

Tap-Kim
Copy link
Contributor

@Tap-Kim Tap-Kim commented Dec 13, 2023

Closes #25143

What I did

We have added code supplementation and test code to correct the issues below.

Describe the bug
In the "Show code" section, any prop containing "on" is rendered as a callback. The test should be whether the name starts with "on" rather than whether it contains "on".

To Reproduce
https://stackblitz.com/edit/github-j6h4hd?file=src%2Fstories%2FButton.vue,src%2Fstories%2FButton.stories.js&preset=node

Go to Button / Docs in the storybook
Click "Show code"
Edit the "icon" prop
-> The generated prop in "Show code" is icon="()=>({})" whatever the value you set.

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!

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>

@JReinhold JReinhold self-assigned this Dec 18, 2023
@JReinhold
Copy link
Contributor

Thanks for the contribution!

Checking for "on" with startsWith instead of includes makes sense to me, but I don't fully understand the part about removing empty functions/objects.

If you're passing in a function as an arg, why shouldn't that be shown in the documentation, even if it's an empty function?

@Tap-Kim
Copy link
Contributor Author

Tap-Kim commented Dec 18, 2023

@JReinhold
Hello! I'll take the test code as an example.

I was mistaken!
Changed to handle undefined and blank values, not empty function/object removal!

Thank you for your review :)

@JReinhold JReinhold changed the title Vue3: fix - Create a supplementary prefix validation supplement code in the "showcode" property. Vue3: Fix support for onX and empty attributes in Show Code Jan 23, 2024
@JReinhold JReinhold merged commit 3eeb562 into storybookjs:next Jan 24, 2024
52 of 54 checks passed
@github-actions github-actions bot mentioned this pull request Jan 24, 2024
11 tasks
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]: props containing 'on' are improperly rendered in "Show code"
3 participants