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

chore: more slot/snippet interop #11619

Closed
wants to merge 18 commits into from
Closed

chore: more slot/snippet interop #11619

wants to merge 18 commits into from

Conversation

dummdidumm
Copy link
Member

This builds on top of #10800 and explores what it takes to make slots and snippets interoperable. It allows you to use render tags already when your consumers still pass slots, or pass snippets already when the component you pass it to still uses slots. From my guess the latter is likely more common (you're depending on some third party library which hasn't updated yet).

Implementation-wise it passes { $$slots: { foo: true } } for a snippet prop named foo, and the render functions for snippets/slots were adjusted to check both locations for content, and react accordingly.

The drawback is that it's a bit more runtime code, and it's somewhat brittle, because it will only work for render tags with 0 or 1 argument (<slot {foo} {bar} /> === @render children({foo, bar})) which could be a bit confusing. It's very nice that it "just works" in the common case though.

Putting this up for completeness even if it's unlikely that we land this.

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

Copy link

changeset-bot bot commented May 14, 2024

⚠️ No Changeset found

Latest commit: be3b08c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@Rich-Harris
Copy link
Member

@dummdidumm what's the story with this PR, is it still something we want to pursue, or should we close it?

@dummdidumm
Copy link
Member Author

I'm still in favor of landing this because I think it could make it easier to migrate one side of the component but not the other, but IIRC you (maybe others as well?) were against it, which is why it has gone stale. I also would need to investigate what this means for language tools if we would agree to continue.

@dummdidumm
Copy link
Member Author

dummdidumm commented Sep 27, 2024

Given the discussion in #13406 and the fact that people may end up in temporary mismatches (slots on one side, snippets on the other) a lot during migration I'm in favor of landing this.

dummdidumm added a commit that referenced this pull request Sep 28, 2024
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.
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.

2 participants