Skip to content

feat: enable snippets to fill slots #13427

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

Merged
merged 4 commits into from
Oct 3, 2024
Merged

feat: enable snippets to fill slots #13427

merged 4 commits into from
Oct 3, 2024

Conversation

dummdidumm
Copy link
Member

This allows people to use snippets to fill slots. It is implemented in the same way the default slot interop is already implemented, by passing a boolean to the hidden $$slots object, and using that at runtime to determine the correct outcome. The impact on bundle size is neglible.

By enabling this, we can enhance our migration script to always transform slot usages (including let:x etc) to snippets. This wasn't possible before because we couldn't be sure if the other side was transformed to using render tags at the same time. This will be part of #13419. This is important because currently the migration script is transforming <slot /> creations inside components, but since it's not touching its usage points the migration will make your app end up in a broken state which you have to finish by hand.

This is a reduced alternative to, and closes #11619, which was also enabling the other way around, but that is a) not as necessary and b) more likely to confuse people / break, because it only works if your render function has 0-1 arguments.

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

This allows people to use snippets to fill slots. It is implemented in the same way the default slot interop is already implemented, by passing a boolean to the hidden `$$slots` object, and using that at runtime to determine the correct outcome. The impact on bundle size is neglible.

By enabling this, we can enhance our migration script to always transform slot usages (including `let:x` etc) to snippets. This wasn't possible before because we couldn't be sure if the other side was transformed to using render tags at the same time. This will be part of #13419. This is important because currently the migration script is transforming `<slot />` creations inside components, but since it's not touching its usage points the migration will make your app end up in a broken state which you have to finish by hand.

This is a reduced alternative to, and closes #11619, which was also enabling the other way around, but that is a) not as necessary and b) more likely to confuse people / break, because it only works if your render function has 0-1 arguments.
Copy link

changeset-bot bot commented Sep 28, 2024

🦋 Changeset detected

Latest commit: c84a0d8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
svelte Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@dummdidumm
Copy link
Member Author

No that's what should happen IMO. If you're switching to the new syntax your users should, too. With the migration script this will be done for them, and if they don't want to yet they can stay on the old version of your component library

@adiguba
Copy link
Contributor

adiguba commented Sep 29, 2024

I don't think this is a good idea because it would add a big constraint : if a library is migrated to Svelte 5, all users of this library will be forced to migrate their own code...

This will force to use the migration that can be difficult on large apps.
This is not backward compatibility (my old code work on the new system), but forward compatibility (I can use the new code with the old system).

I think it might even push library authors not to migrate their codes :

  • Staying on the syntax of Svelte 4's slots, their components will be compatible with slots and snippets.
  • By migrating to Svelte 5's snippets, their components will only accept snippets, and slots will be ignored, so that a big breaking change.

@Rich-Harris
Copy link
Member

Svelte 5 itself is backward compatible, but I don't think it's reasonable or desirable to expect libraries to be as well. This is a good change

@Rich-Harris Rich-Harris merged commit e850852 into main Oct 3, 2024
9 checks passed
@Rich-Harris Rich-Harris deleted the snippet-slot-interop branch October 3, 2024 23:35
adiguba added a commit to adiguba/svelte4-bc that referenced this pull request Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants