Svelte: Fix usage of deprecated <svelte:component>
#29405
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile
☁️ Nx Cloud ReportCI is running/has finished running commands for commit f028acb. 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. |
JReinhold
changed the title
<svelte:component><svelte:component>
| <div | ||
| style="margin: 3em;" | ||
| > | ||
| <decorator.component> |
There was a problem hiding this comment.
This exposes a bug in Testing Library Svelte and/or Svelte 4.
When you use <something.theComponent />, it will snapshot as that directly instead of what the component actually is, as we see in the diff here. I confirmed that it is unrelated to Storybook/Portable Stories and that it's only a problem in Svelte 4. I wrote this simple test setup:
// Wrapper.svelte
<div style="margin: 3em;">
<slot />
</div>// Inner.svelte
<script>
export let stuff;
</script>
<stuff.Component> hello </stuff.Component>// the.test.js
import { it, expect } from 'vitest';
import { render } from '@testing-library/svelte';
import Inner from './Inner.svelte';
import Wrapper from './Wrapper.svelte';
it('barebone', () => {
render(Inner, { stuff: { Component: Wrapper }});
expect(document.body).toMatchInlineSnapshot();
});Using <stuff.Component> hello </stuff.Component> it had this weird flaw in the snapshot, using <svelte:component this={stuff.Component}>hello</svelte:component> it didn't.
I think this is okay honestly, not much we can do about it other than not fixing the warning here. Thoughts @yannbf @kasperpeulen?
There was a problem hiding this comment.
It was discussed with @JReinhold that he will try to apply version-dependent logic so that the decorator.Component is only used in Svelte 5
|
@xeho91 I'm actually struggling to reproduce the original issue here. I have a project with:
And I can't get the warning to appear, even when adding decorators to stories. Am I doing something wrong, or was this perhaps only an issue in the addon? |
No, I don't think you're wrong. I'm also not being able to reproduce this warning now. I confirmed that |
|
Alright, then let's keep this unmerged for now. |
I can't transfer the issue to this repository.
Closes storybookjs/addon-svelte-csf#212
Warning
Needs manual verification if this doesn't break Svelte
v4What I did
I removed usage of deprecated
<svelte:component>- source of documented deprecationChecklist 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!
Documentation
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 PR removes deprecated
<svelte:component>usage in the SlotDecorator.svelte file, addressing compatibility with Svelte 5 while maintaining support for earlier versions.<svelte:component>with direct component usage incode/renderers/svelte/src/components/SlotDecorator.svelte