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

Vue: Disable controls for events and exposed by default #26675

Merged
merged 3 commits into from Mar 31, 2024

Conversation

larsrickert
Copy link
Contributor

@larsrickert larsrickert commented Mar 28, 2024

What I did

For events and exposes it does not really make sense to show controls since it is not used.
They will be disabled by default now.

The behaviour was already implemented but it didn't work due to a typo.

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

  1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template vue3-vite/default-ts
  2. Set framework option docgen to vue-component-meta in .storybook/main.ts file
  3. Open http://localhost:6006/?path=/docs/stories-renderers-vue3-vue3-vite-default-ts-component-meta-defineslots--docs

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>

Copy link

nx-cloud bot commented Mar 28, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit cbd8cb3. 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.

@kasperpeulen
Copy link
Contributor

What is the reason to disable slots? We have some tests that assert they can be used in a reactive way with controls.

@larsrickert
Copy link
Contributor Author

What is the reason to disable slots? We have some tests that assert they can be used in a reactive way with controls.

This is how the default controls for slot look like which are basically unusable.
But you are right, this is only the case if a function is used for the slot. If its a string, the controls are fine.
image

Is there a way to only disable the controls if a function is passed as arg type? Otherwise I will exclude the slots and only disable the controls for events and exposed

@larsrickert larsrickert changed the title Vue: Disable controls for events, slots and exposed by default Vue: Disable controls for events and exposed by default Mar 29, 2024
@kasperpeulen kasperpeulen merged commit e67517b into main Mar 31, 2024
49 of 59 checks passed
@kasperpeulen kasperpeulen deleted the fix/disable-controls branch March 31, 2024 14:39
@shilman shilman restored the fix/disable-controls branch April 5, 2024 11:06
Copy link
Contributor

@chakAs3 chakAs3 left a comment

Choose a reason for hiding this comment

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

done !👌

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.

None yet

3 participants